Skip to main content
Vindicia Knowledge Center

AutoBill.fetchAllCreditHistory

AutoBill.fetchAllCreditHistory

AutoBill.fetchAllCreditHistory

The fetchAllCreditHistory method returns credit history for all AutoBills.

For more information, see the Account object’s Account.fetchAllCreditHistory method.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

timestamp: the starting time stamp (lower limit) for the range of credit event logs you wish to retrieve.

endTimestamp: the ending time stamp (upper limit) for the range of credit event logs you wish to retrieve.

page: the page number, starting at 0, for which to return the results. For example, if the total number of results is 85 and pageSize is 10:

  • Specifying 0 for page gets the results from 1 through 10.
  • Specifying 2 for page gets the results from 21 through 30.

pageSize: the number of records to display per page per call. This value must be greater than 0.

Output

return: an object of type Return that indicates the success or failure of the call.

creditEventLogs: an array of CreditEventLog objects. Each of these objects describes a specific credit-related event or action associated with the input AutoBill. (See CreditEventLog Object Data Members for details.)

Returns

This method returns the codes listed in Standard Return Codes.

Example

$rc = $autobill_factory->fetchAllCreditHistory("2012-12-25",

"2013-01-01", 0, 100);

// from Christmas to New Year's, first page, limit 100 to the page
// check response in $rc

$event_log_array = $rc->{creditEventLogs};
foreach ($event_log_array as $event_log)
{

print $event_log->timeStamp,

"\t",

$event_log->type,

"\t",

$event_log->credit->currencyAmounts->amount,

"\n";

}

Note This example assumes that the credits are in currency amounts, and therefore specifies a minimal number of parameters.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top