Back to top  

ContractorInvoiceHandler

This class contains the functions to perform the following:

  • Retrieve: Contractor Invoice(s)
  • Update: Contractor Invoice Flag

api
package simPROAPI
subpackage Invoice
author Nathan Muir, Michael West
version 2011-07-28

 Methods

ContractorInvoiceRetrieve

Retrieve(int $CompanyID, int $InvoiceNo) : array
Static

This function retrieves a invoice with a specific Contractor Invoice ID

uses \ContractorInvoiceHandler::RetrieveList()
used_by \AccPayInvoiceHandler::Retrieve()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InvoiceNo

int

The Invoice Number to retrieve

Returns

array

ContractorInvoiceRetrieveList

RetrieveList(int $CompanyID, array $InvoiceNos) : array
Static

This function retrieves details on the provided list of contractor invoice ids

used_by \AccPayInvoiceHandler::RetrieveExport()
used_by \AccPayInvoiceHandler::RetrieveList()
used_by \ContractorInvoiceHandler::Search()
used_by \ContractorInvoiceHandler::SearchInvoice()
used_by \ContractorInvoiceHandler::SearchContractorJob()
used_by \ContractorInvoiceHandler::Retrieve()
used_by \ContractorJobHandler::Retrieve()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InvoiceNos

array

list of Contractor Invoice ID's to retrieve.

Returns

array

ContractorInvoiceSearch

Search(int $CompanyID, string $Search = '', string $StartDate = null, string $EndDate = null) : array
Static

This function searches for the list of invoices for a specific time period

uses \ContractorInvoiceHandler::RetrieveList()
used_by \AccPayInvoiceHandler::Search()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$Search = ''

string

The search text for the accounts payable invoice. Can use % for wildcards.

$StartDate = null

string

Date start (inclusive) to search for the specified contractor. Null/Empty will ignore this parameter. {@link http://php.net/manual/en/function.strtotime.php}

$EndDate = null

string

Date end (inclusive) to search for the specified contractor. Null/Empty will ignore this parameter. {@link http://php.net/manual/en/function.strtotime.php}

Returns

array

ContractorInvoiceSearchContractorJob

SearchContractorJob(int $CompanyID, int $ContractorJobNo) : array
Static

This function searches for contractor invoices with a specific contractor job number

uses \ContractorInvoiceHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$ContractorJobNo

int

The Contractor Job Number

Returns

array

ContractorInvoiceSearchInvoice

SearchInvoice(int $CompanyID, string $InvoiceNo) : array
Static

This function searches for contractor invoices with a specific contractor invoice number

uses \ContractorInvoiceHandler::RetrieveList()
used_by \AccPayInvoiceHandler::SearchInvoice()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InvoiceNo

string

The Contractor Invoice Number

Returns

array