GetAccountingReceiptsJournal

Description

This class is an instantion of the Command class, that executes a command pertaining to fetching receipts journal information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetAccountingReceiptsJournal command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Michael Fountain

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<receiptJournalID><!-- int --></receiptJournalID>
			<clientID><!-- int --></clientID>
			<currencyID><!-- int --></currencyID>
			<invoiceID><!-- int --></invoiceID>
			<transactionID><!-- int --></transactionID>
			<receiptDateCreatedLessThan><!-- int --></receiptDateCreatedLessThan>
			<receiptDateCreated><!-- int --></receiptDateCreated>
			<receiptDateCreatedGreaterThan><!-- int --></receiptDateCreatedGreaterThan>
			<sortDir><!-- None --></sortDir>
			<sortColumn><!-- None --></sortColumn>
			<recordOffset><!-- None --></recordOffset>
			<numRecords><!-- None --></numRecords>
		</params>
	</mbapi>

		

Example Response

None
		

Request Elements

mbapi
Type
None
Description
None
Children
command
Type
None
Description
None
showXMLHeader
Type
None
Description
None
params
Type
None
Description
None
Children
receiptJournalID
Type
int
Description

The ID of the receipt journal to fetch. This will always select at most 1 record.

clientID
Type
int
Description

The client ID of the record to fetch. This will always select all records for this client.

currencyID
Type
int
Description

The ID of the currency for this record in the ledger.

invoiceID
Type
int
Description

The invoice ID of the record to fetch. This will always select all records for this invoice.

transactionID
Type
int
Description

The transaction ID of the record to fetch. This will always select all records for this transaction.

receiptDateCreatedLessThan
Type
int
Description

The maximum UNIX timestamp for which a record in the result set was created.

receiptDateCreated
Type
int
Description

The exact UNIX timestamp for which a record in the result set was created.

receiptDateCreatedGreaterThan
Type
int
Description

The minimum UNIX timestamp for which a record in the result set was created

sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None