GetTransactions

Description

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

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<transactionIDs>
				<transactionID><!-- int --></transactionID>
			</transactionIDs>
			<billingAccountIDs>
				<billingAccountID><!-- int --></billingAccountID>
			</billingAccountIDs>
			<transactionPaymentMethod><!-- int --></transactionPaymentMethod>
			<authReturn><!-- int --></authReturn>
			<transactionCode><!-- string --></transactionCode>
			<transactionNotes><!-- string --></transactionNotes>
			<transactionDateCreated><!-- timestamp --></transactionDateCreated>
			<transactionDateCreatedGreaterThan><!-- None --></transactionDateCreatedGreaterThan>
			<transactionDateCreatedLessThan><!-- None --></transactionDateCreatedLessThan>
			<authCode><!-- int --></authCode>
			<avsCode><!-- int --></avsCode>
			<transactionAmount><!-- decimal --></transactionAmount>
			<transactionAmountGreaterThan><!-- None --></transactionAmountGreaterThan>
			<transactionAmountLessThan><!-- None --></transactionAmountLessThan>
			<currencyID><!-- string --></currencyID>
			<configGroupID><!-- int --></configGroupID>
			<invoiceIDs>
				<invoiceID><!-- int --></invoiceID>
			</invoiceIDs>
			<getInvoiceIDs><!-- None --></getInvoiceIDs>
			<getGatewayNames><!-- None --></getGatewayNames>
			<getClientNames><!-- None --></getClientNames>
			<getLineItemPayments><!-- None --></getLineItemPayments>
			<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
transactionIDs
Type
None
Description
None
Children
transactionID
Type
int
Description

The ID(s) of the transaction to get.

billingAccountIDs
Type
None
Description
None
Children
billingAccountID
Type
int
Description

The ID(s) of the transaction to get.

transactionPaymentMethod
Type
int
Description

transaction_payment_method - the payment method with which this transaction too place

authReturn
Type
int
Description

auth_return

transactionCode
Type
string
Description

The transaction code.

transactionNotes
Type
string
Description

The transaction notes.

transactionDateCreated
Type
timestamp
Description

(int 10) The date this transaction was created.

transactionDateCreatedGreaterThan
Type
None
Description
None
transactionDateCreatedLessThan
Type
None
Description
None
authCode
Type
int
Description

The auth code?

avsCode
Type
int
Description

The avs code.

transactionAmount
Type
decimal
Description

The amount of this transaction.

transactionAmountGreaterThan
Type
None
Description
None
transactionAmountLessThan
Type
None
Description
None
currencyID
Type
string
Description

3 character code for currency

configGroupID
Type
int
Description

id of the config group for the gateway the charge was charged on

invoiceIDs
Type
None
Description
None
Children
invoiceID
Type
int
Description

The ID(s) of the invoices in the invoice_transaction_rel table to get transactions for.

getInvoiceIDs
Type
None
Description
None
getGatewayNames
Type
None
Description
None
getClientNames
Type
None
Description
None
getLineItemPayments
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