Skip to main content

Fields

Billing document that annuls this statement.

documentDebtPosition : BillingDocumentPositionType

Position of the billing document in the delinquent debt tracking system.

dueDate : Date

The final date before missing payment is considered overdue.

earliestChargeAt : DateTime

The earliest charge date of the statement.

endAt : DateTime! required

The end of the statement's period.

firstIssuedAt : DateTime

The date and time the statement was sent to the customer.

id : Int

ID for the statement billing document.

identifier : String

The unique reference of the statement that can be used for identifying the statement externally.

isFinal : Boolean

Whether this statement is marked as final.

latestChargeAt : DateTime

The latest charge date of the statement.

paymentDueDate : Date

The date due for payment for the statement.

Deprecation
The 'paymentDueDate' field is deprecated.

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.
pdfUrl : String

URL to the PDF of the statement.

scheduledPaymentDate : Date

The scheduled date for payment (may be before the due_date).

startAt : DateTime! required

The start of the statement's period.

totalCharges : StatementTotalType

The total amounts for all charges on the statement.

totalCredits : StatementTotalType

The total amounts for all credits on the statement.

Transactions on the statement

Arguments
after : String
before : String
first : Int
last : Int
orderBy : TransactionsOrderBy default: POSTED_DATE_DESC

The order in which to return the transactions.

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

{ "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 }