AccRecPaymentHandler

api
package simPROAPI
subpackage Accounts
author Michael West
version 2012-03-21
todo Ensure that permissions are suitable for use

 Methods

AccRecPaymentFlag

Flag(int $CompanyID, int $AccRecPaymentID) : bool
Static

This function flags a particular accounts receivable payment as exported

Parameters

$CompanyID

int

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

$AccRecPaymentID

int

The accounts receivable payment to flag as exported

Returns

bool

AccRecPaymentFlagList

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

This function flags a particular accounts receivable payment as exported

Parameters

$CompanyID

int

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

$AccRecPaymentIDs

array

The accounts receivable payment list to flag as exported

Returns

bool

AccRecPaymentRetrieve

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

This function retrieves an accounts receivable payment with a specific ID

Parameters

$CompanyID

int

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

$AccRecPaymentID

mixed

the accounts receivable payment id

Returns

array

AccRecPaymentRetrieveExport

RetrieveExport(int $CompanyID) : array
Static

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

uses \AccRecPaymentHandler::RetrieveList()

Parameters

$CompanyID

int

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

Returns

array

AccRecPaymentRetrieveList

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

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

used_by \AccRecPaymentHandler::Search()
used_by \AccRecPaymentHandler::RetrieveExport()

Parameters

$CompanyID

int

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

$AccRecPaymentIDs

array

list of AccRecPayment ID's to retrieve.

Returns

array

AccRecPaymentUnFlag

UnFlag(int $CompanyID, int $AccRecPaymentID) : bool
Static

This function Unflags a particular accounts receivable payment as exported

Parameters

$CompanyID

int

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

$AccRecPaymentID

int

The accounts receivable payment to Unflag as exported

Returns

bool

AccRecPaymentUnFlagList

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

Parameters

$CompanyID

int

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

$AccRecPaymentIDs

array

The accounts receivable payment list to Unflag as exported

Returns

bool