CustomerInvoiceHandler
This class contains the functions to perform the following:
Retrieve:
| api | |
|---|---|
| package | simPROAPI |
| subpackage | Invoice |
| author | Nathan Muir, Michael West |
| version | 2011-07-18 |
Insert(int $CompanyID, array $InvoiceDetails) : int
This function allows creation of Invoices and Progress Claims
<?php
$InvoiceDetails = array(
"CustomerID" => 0,
"JobNos" => array(0,1),
"Description" => "",
"IssuedDate" => "Y-m-d",
"PaymentTerm" => 0,
"PaymentTermType" => "invoice"|"month",
"CustomFields" => array(Name => Value),
"LatePayment" => 0,
"Approved" => true|false,
"ProgressClaim" => true|false,
"ClaimDetails" => array(array(SectionCostCentreID => 0, Claim => 0)), // claim in percentage
"Deposit" => true|false,
"StatusID" => 0,
);
?>
intthe company id
arrayan associative array of invoice information.
intInsertCredit(int $CompanyID, int $InvoiceNo, array $CreditDetails) : int
<?php
$CreditDetails =
array(
"CreditNoteNo"=>"",
"Description"=>"",
"Notes"=>"",
"DateIssued"=>"Y-m-d",
"Approved"=>1,
"CostCentres"=>array(
"CostCentreID"=>0,
"CreditAmount"=>0.00
)
);
?>
intthe company id
intthe invoice number to be credited
arrayan associative array of credit information.
intLogSearch(int $CompanyID, int $InvoiceNo = null, string $StartDate = null, string $EndDate = null, int $StaffID = null, string $Search = '%', int $Limit = 1000, int $Offset = 0) : array
This function retrieves logs from Invoices whether a specific number is supplied or not.
intThe Company ID. In single company builds, this is 0.
intThe Invoice Number to retrieve (Optional). Null/Empty will ignore this parameter.
stringDate start (inclusive) to search. Null/Empty will ignore this parameter.
stringDate end (inclusive) to search. Null/Empty will ignore this parameter.
intThe employee ID. Null/Empty will ignore this parameter.
stringThe search text for the log message. Can use % for wildcards.
intthe total number of logs to return (0 - 1000)
inthow many results to skip, before returning {@link $Limit}
arrayRetrieve(int $CompanyID, int $InvoiceNo) : array
This function retrieves a invoice with a specific ID
| uses | \CustomerInvoiceHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
intThe Invoice Number to retrieve
arrayRetrieveAll(int $CompanyID) : array
This function retrieves a list of all customer invoices
| uses | \CustomerInvoiceHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
arrayRetrieveCredit(int $CompanyID, int $CreditID) : array
This function retrieves details of a particular credit
| uses | \CustomerInvoiceHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
intthe Credit ID
arrayRetrieveList(int $CompanyID, array $InvoiceNos) : array
This function retrieves details on the provided list of invoice ids
| used_by | \CustomerPaymentHandler::Search() |
|---|---|
| used_by | \CustomerPaymentHandler::SearchInvoice() |
| used_by | \CustomerPaymentHandler::Retrieve() |
| used_by | \CustomerInvoiceHandler::Search() |
| used_by | \CustomerInvoiceHandler::SearchJob() |
| used_by | \CustomerInvoiceHandler::Retrieve() |
| used_by | \CustomerInvoiceHandler::RetrieveAll() |
| used_by | \CustomerInvoiceHandler::RetrieveOutstanding() |
| used_by | \CustomerInvoiceHandler::RetrievePaid() |
| used_by | \CustomerInvoiceHandler::RetrieveCredit() |
intthe Company ID. In single company builds, this is 0.
arraylist of Invoice ID's to retrieve.
arrayRetrieveOutstanding(int $CompanyID) : array
This function retrieves a list of all outstanding customer invoices
| uses | \CustomerInvoiceHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
arrayRetrievePaid(int $CompanyID) : array
This function retrieves a list of all outstanding customer invoices
| uses | \CustomerInvoiceHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
arraySearch(int $CompanyID, string $Search = '', string $StartDate = null, string $EndDate = null, string $Stage = 'approved', string $Status = null) : array
This function searches for the list of invoices for a customerID
| uses | \CustomerInvoiceHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
string
stringDate start (inclusive) to search for the specified customer invoice. Null/Empty will ignore this parameter. {@link http://php.net/manual/en/function.strtotime.php}
stringDate end (inclusive) to search for the specified customer invoice. Null/Empty will ignore this parameter. {@link http://php.net/manual/en/function.strtotime.php}
stringRetrieve "approved" (normal invoice) or "unapproved" (request for claim). Default is "approved".
stringRetrieve based on Invoice Status
arraySearchJob(int $CompanyID, int $JobNo) : array
This function searches for the list of invoices for a customerID
| uses | \CustomerInvoiceHandler::RetrieveList() |
|---|
intthe Company ID. In single company builds, this is 0.
intThe Job Number
arrayUpdate(int $CompanyID, int $InvoiceNo, array $InvoiceDetails) : boolean
This function allows updating of custom fields on any invoice and the updating of other fields on un-approved Progress Claims
<?php
$InvoiceDetails = array(
"Description" => "",
"IssuedDate" => "Y-m-d",
"PaymentTerm" => 0,
"PaymentTermType" => "invoice"|"month",
"CustomFields" => array(Name => Value),
"StatusID" => 0,
"LatePayment" => 0,
);
?>
intthe Company ID. In single company builds, this is 0.
intthe invoice number
arrayan associative array of invoice information.
booleanUpdateCredit(int $CompanyID, int $CreditID, array $CreditDetails) : int
<?php
$CreditDetails =
array(
"Description"=>"",
"Notes"=>"",
"DateIssued"=>"Y-m-d",
"Approved"=>1,
"CostCentres"=>array(
"CostCentreID"=>0,
"CreditAmount"=>0.00
)
);
?>
intthe company id
intthe credit id to be updated
arrayan associative array of credit information.
int