Charge
A charge to the customer.
Fields
Unique identifier of the account the transaction belongs to.
Gross amount including tax (when payable). Refer to the amounts field for a breakdown of this information.
The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned.
The customer's resulting balance after this transaction has been applied, in the smallest unit of currency.
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.
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).
The date time when the transaction is created.
Supporting information about this charge (if any is available).
Returns True if the transaction is linked with a statement.
Unique identifier for the transaction.
Deprecated.
This information is provided by the __typename introspection query.
- Marked as deprecated on 2020-06-19.
- Scheduled for removal on or after 2022-11-15.
Deprecated.
This information is provided by the __typename introspection query.
- Marked as deprecated on 2020-06-19.
- Scheduled for removal on or after 2022-11-15.
Deprecated.
This information is provided by the __typename introspection query.
- Marked as deprecated on 2020-06-19.
- Scheduled for removal on or after 2022-11-15.
Whether the charge is for export electricity.
Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction.
Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents.
Returns the note field value for the transaction, which contains additional info.
Date when the transaction was posted to the account.
Returns the reason.
Returns None if a statement is not linked with the transaction.
Use `billingDocumentIdentifier` instead.
- Marked as deprecated on 2023-11-30.
- Scheduled for removal on or after 2024-06-01.
Human-readable title describing the transaction.
Example
{
"accountNumber": "A-1C5ED790",
"amount": 80,
"amounts": TransactionAmountType,
"balanceCarriedForward": 24,
"billingDocumentIdentifier": "56227654",
"consumption": Consumption,
"createdAt": "1986-06-05T03:21:14.812589+00:00",
"detail": SupplyOrServiceCharge,
"hasStatement": true,
"id": "32477484",
"isExport": true,
"isHeld": true,
"isIssued": true,
"isReversed": true,
"note": "city-month-collection-evening-represent",
"postedDate": "1995-09-24",
"reasonCode": "focus-listen-age-hit-inside",
"title": "could-board-tonight-member-decide"
}