AccRecContactHandler

api
package simPROAPI
subpackage Accounts
author Michael West, Daniel Sanders
version 2012-03-21

 Methods

AccRecContactFlag

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

This function flags a particular accounts receivable contact as exported

Parameters

$CompanyID

int

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

$AccRecContactID

mixed

The accounts receivable contact to flag as exported

Returns

bool

AccRecContactFlagList

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

Parameters

$CompanyID

int

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

$AccRecContactIDs

array

The accounts receivable contact list to flag as exported

Returns

bool

AccRecContactRetrieve

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

This function retrieves an accounts receivable contact with a specific ID (Receipt ID)

Parameters

$CompanyID

int

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

$AccRecContactID

mixed

the accounts receivable contact id

Returns

array

AccRecContactRetrieveAll

RetrieveAll(int $CompanyID) : array
Static

This function retrieves a list of accounts receivable contacts

uses \CustomerHandler::RetrieveList()

Parameters

$CompanyID

int

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

Returns

array

AccRecContactRetrieveExport

RetrieveExport(int $CompanyID) : array
Static

This function retrieves a list of accounts receivable contacts that are ready for export

uses \CustomerHandler::RetrieveList()

Parameters

$CompanyID

int

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

Returns

array

AccRecContactRetrieveList

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

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

uses \CustomerHandler::RetrieveList()

Parameters

$CompanyID

int

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

$AccRecContactIDs

array

list of AccRecContact ID's to retrieve.

Returns

array

TotalCount

TotalCount(int $CompanyID) : int
Static

This function returns the total number of Customers that are not archived

uses \CustomerHandler::TotalCount()

Parameters

$CompanyID

int

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

Returns

int

AccRecContactUnFlag

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

This function unflags a particular accounts receivable contact as exported

Parameters

$CompanyID

int

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

$AccRecContactID

mixed

The accounts receivable contact to unflag as exported

Returns

bool

AccRecContactUnFlagList

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

Parameters

$CompanyID

int

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

$AccRecContactIDs

array

The accounts receivable contact list to unflag as exported

Returns

bool