AccPayContactHandler

api
package simPROAPI
subpackage Accounts
author Michael West, Daniel Sanders
version 2012-02-06

 Methods

AccPayContactFlag

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

This function flags a particular accounts payable contact as exported

Parameters

$CompanyID

int

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

$AccPayContactID

mixed

The accounts payable contact to flag as exported

Returns

bool

AccPayContactFlagList

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

This function flags a list of accounts payable contact as exported

contribution Michael West 2012-07-02, Daniel Sanders 13/02/2013

Parameters

$CompanyID

int

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

$AccPayContactIDs

array

The accounts payable contact list to flag as exported

Returns

bool

AccPayContactRetrieve

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

This function retrieves an accounts payable contact (Supplier or Contractor) with a specific ID ID must be prefixed with either SUP (for Supplier) or CON (for Contractor)

uses \SupplierHandler::RetrieveList()
uses \ContractorHandler::RetrieveList()
contribution Michael West 2012-02-07

Parameters

$CompanyID

int

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

$AccPayContactID

mixed

the accounts payable contact id

Returns

array

AccPayContactRetrieveAll

RetrieveAll(int $CompanyID) : array
Static

This function retrieves a list of accounts payable contacts that have not being archived

uses \SupplierHandler::RetrieveList()
uses \ContractorHandler::RetrieveList()
contribution Daniel Sanders 2012-07-20

Parameters

$CompanyID

int

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

Returns

array

AccPayContactRetrieveExport

RetrieveExport(int $CompanyID) : array
Static

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

uses \SupplierHandler::RetrieveList()
uses \ContractorHandler::RetrieveList()
contribution Michael West 2012-02-07

Parameters

$CompanyID

int

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

Returns

array

AccPayContactRetrieveList

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

This function retrieves details on the provided list of accounts payable contact ids

contribution Michael West 2012-02-07

Parameters

$CompanyID

int

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

$AccPayContactIDs

array

List of AccPayContact ID's to retrieve.

Returns

array

TotalCount

TotalCount(int $CompanyID) : array
Static

This function returns the total number of Suppliers and Contractors that are not archived

uses \SupplierHandler::TotalCount()
uses \ContractorHandler::TotalCount()

Parameters

$CompanyID

int

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

Returns

array

AccPayContactUnFlag

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

This function Unflags a particular accounts payable contact as exported

Parameters

$CompanyID

int

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

$AccPayContactID

mixed

The accounts payable contact to Unflag as exported

Returns

bool

AccPayContactUnFlagList

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

This function Unflags a list of accounts payable contact as exported

contribution Daniel Sanders 2014-01-29

Parameters

$CompanyID

int

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

$AccPayContactIDs

array

The accounts payable contact list to Unflag as exported

Returns

bool