StatementBillingDocumentType
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
Billing document that annuls this statement.
Position of the billing document in the delinquent debt tracking system.
The final date before missing payment is considered overdue.
The earliest charge date of the statement.
The end of the statement's period.
The date and time the statement was sent to the customer.
ID for the statement billing document.
The unique reference of the statement that can be used for identifying the statement externally.
Whether this statement is marked as final.
The latest charge date of the statement.
The date due for payment for the statement.
This field name is ambiguous and inconsistently populated. Use `paymentDate` for the date on which payment will be collected. Use `dueDate` for the last date any payment can be made before the bill is considered overdue.
- Marked as deprecated on 2026-06-15.
- Scheduled for removal on or after 2027-08-15.
URL to the PDF of the statement.
The scheduled date for payment (may be before the due_date).
The start of the statement's period.
The total amounts for all charges on the statement.
The total amounts for all credits on the statement.
Transactions on the statement
Arguments
The order in which to return the transactions.
Example
{
"annulledBy": AnnulmentBillingDocumentType,
"documentDebtPosition": BillingDocumentPositionType,
"dueDate": "2024-11-03",
"earliestChargeAt": "2004-11-27T04:10:14.208150+00:00",
"endAt": "2024-09-14T07:49:16.519161+00:00",
"firstIssuedAt": "2008-11-07T04:08:30.085821+00:00",
"id": 21006965,
"identifier": "69734771",
"isFinal": true,
"latestChargeAt": "2018-02-24T12:25:42.330298+00:00",
"pdfUrl": "drop-surface-vote-tough-however",
"scheduledPaymentDate": "2021-06-30",
"startAt": "1994-10-16T13:26:33.291399+00:00",
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"transactions": BillTransactionConnectionTypeConnection
}