GetPaymentQueue

Description

This class is an instantion of the Command class, that executes a command pertaining to fetching payment 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 GetPaymentQueue command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Mark Garrett

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<paymentID><!-- None --></paymentID>
			<lineItemID><!-- None --></lineItemID>
			<invoiceID><!-- None --></invoiceID>
			<paymentDescription><!-- None --></paymentDescription>
			<paymentAmount><!-- None --></paymentAmount>
			<paymentDateCharged><!-- None --></paymentDateCharged>
			<billingAccountShareID><!-- None --></billingAccountShareID>
			<getAccountShareData><!-- None --></getAccountShareData>
			<getInvoiceData><!-- None --></getInvoiceData>
			<getPaymentGroupData><!-- None --></getPaymentGroupData>
			<getPaymentGroupRelData><!-- None --></getPaymentGroupRelData>
			<getPackageData><!-- None --></getPackageData>
			<getClientData><!-- None --></getClientData>
			<paymentDateChargedGreaterThan><!-- None --></paymentDateChargedGreaterThan>
			<paymentDateChargedLessThan><!-- None --></paymentDateChargedLessThan>
			<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
paymentID
Type
None
Description
None
lineItemID
Type
None
Description
None
invoiceID
Type
None
Description
None
paymentDescription
Type
None
Description
None
paymentAmount
Type
None
Description
None
paymentDateCharged
Type
None
Description
None
billingAccountShareID
Type
None
Description
None
getAccountShareData
Type
None
Description
None
getInvoiceData
Type
None
Description
None
getPaymentGroupData
Type
None
Description
None
getPaymentGroupRelData
Type
None
Description
None
getPackageData
Type
None
Description
None
getClientData
Type
None
Description
None
paymentDateChargedGreaterThan
Type
None
Description
None
paymentDateChargedLessThan
Type
None
Description
None
sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None