Skip to main content

Fields

The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned.

consumption : Consumption

If this charge is for consumption of a good or service, this field will contain details of how much was consumed. Omitted in cases where the charge is not for consumption, or where consumption information is not available (e.g. for some older records).

createdAt : DateTime

The date time when the transaction is created.

detail : ChargeDetail

Supporting information about this charge (if any is available).

id : ID

The unique identifier for the transaction.

latestBillingDocumentIdentifier : ID

The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document.

note : String

Returns the note field value for the transaction, which contains additional info.

postedDate : Date

The date the transaction was posted.

reasonCode : String

Returns the reason.

title : String

A user readable string that indicates what this transaction relates to.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "amounts": TransactionAmountType, "consumption": Consumption, "createdAt": "2002-05-16T20:35:42.181965+00:00", "detail": SupplyOrServiceCharge, "id": "33659350", "latestBillingDocumentIdentifier": "30908333", "note": "economy-design-now-serious-appear", "postedDate": "2008-08-18", "reasonCode": "response-girl-middle-close-role", "title": "American-wonder-space-pick-environment" }