AccPayInvoiceHandler

api
package simPROAPI
subpackage Accounts
author Michael West, Daniel Sanders
version 2012-03-22
todo revise permissions- suitable for contractors, supplier receipts & credits

 Methods

AccPayInvoiceFlag

Flag(int $CompanyID, mixed $AccPayInvoiceID) : bool
Static

This function flags a particular accounts payable invoice as exported

ID must be prefixed with one of the following (eg SUPINVOICE10 for receipt #10): 'SUPINVOICE' for a Supplier Invoice 'SUPCREDIT' for a Supplier Credit 'CONINVOICE' for a Contractor Invoice

Parameters

$CompanyID

int

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

$AccPayInvoiceID

mixed

The accounts payable invoice to flag as exported

Returns

bool

AccPayInvoiceFlagList

FlagList(int $CompanyID, array $AccPayInvoiceIDs) : bool
Static

This function flags a particular accounts payable invoice as exported

ID must be prefixed with one of the following (eg SUPINVOICE10 for receipt #10): 'SUPINVOICE' for a Supplier Invoice 'SUPCREDIT' for a Supplier Credit 'CONINVOICE' for a Contractor Invoice

Parameters

$CompanyID

int

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

$AccPayInvoiceIDs

array

The accounts payable invoice list to flag as exported

Returns

bool

AccPayInvoiceRetrieve

Retrieve(int $CompanyID, mixed $AccPayInvoiceID) : array
Static

This function retrieves an accounts payable invoice with a specific ID (simPRO Receipt ID)

ID must be prefixed with one of the following (eg SUPINVOICE10 for receipt #10): 'SUPINVOICE' for a Supplier Invoice 'SUPCREDIT' for a Supplier Credit 'CONINVOICE' for a Contractor Invoice

uses \SupplierInvoiceHandler::Retrieve()
uses \SupplierCreditHandler::Retrieve()
uses \ContractorInvoiceHandler::Retrieve()

Parameters

$CompanyID

int

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

$AccPayInvoiceID

mixed

the accounts payable invoice id

Returns

array

AccPayInvoiceRetrieveExport

RetrieveExport(int $CompanyID) : array
Static

This function retrieves a list of accounts payable invoices that are flagged for export

uses \SupplierInvoiceHandler::RetrieveList()
uses \SupplierCreditHandler::RetrieveList()
uses \ContractorInvoiceHandler::RetrieveList()

Parameters

$CompanyID

int

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

Returns

array

AccPayInvoiceRetrieveList

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

This function retrieves details on the provided list of accounts payable invoice ids (Receipt ID)

ID must be prefixed with one of the following (eg SUPINVOICE10 for receipt #10): 'SUPINVOICE' for a Supplier Invoice 'SUPCREDIT' for a Supplier Credit 'CONINVOICE' for a Contractor Invoice

uses \SupplierInvoiceHandler::RetrieveList()
uses \SupplierCreditHandler::RetrieveList()
uses \ContractorInvoiceHandler::RetrieveList()

Parameters

$CompanyID

int

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

$AccPayInvoiceIDs

array

list of AccPayInvoice ID's to retrieve.

Returns

array

AccPayInvoiceSearchInvoice

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

This function retrieve's a list of accounts payable invoices where either the accounts payment invoice number matches the search term.

uses \ContractorInvoiceHandler::SearchInvoice()
uses \SupplierInvoiceHandler::SearchInvoice()
uses \SupplierCreditHandler::SearchInvoice()

Parameters

$CompanyID

int

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

$InvoiceNo

string

The Contractor Invoice Number

Returns

array

AccPayInvoiceUnFlag

UnFlag(int $CompanyID, mixed $AccPayInvoiceID) : bool
Static

This function Unflags a particular accounts payable invoice as exported

ID must be prefixed with one of the following (eg SUPINVOICE10 for receipt #10): 'SUPINVOICE' for a Supplier Invoice 'SUPCREDIT' for a Supplier Credit 'CONINVOICE' for a Contractor Invoice

Parameters

$CompanyID

int

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

$AccPayInvoiceID

mixed

The accounts payable invoice to Unflag as exported

Returns

bool

AccPayInvoiceUnFlagList

UnFlagList(int $CompanyID, array $AccPayInvoiceIDs) : bool
Static

This function Unflags a particular accounts payable invoice as exported

ID must be prefixed with one of the following (eg SUPINVOICE10 for receipt #10): 'SUPINVOICE' for a Supplier Invoice 'SUPCREDIT' for a Supplier Credit 'CONINVOICE' for a Contractor Invoice

Parameters

$CompanyID

int

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

$AccPayInvoiceIDs

array

The accounts payable invoice list to Unflag as exported

Returns

bool