Fields

attachments : BillingAttachmentConnectionTypeConnection
Arguments
after : String
before : String
first : Int
last : Int
billType : BillTypeEnum

The type of the bill.
closingBalance : Int! required

The closing balance of an issued billing document.
Arguments
ledgerNumber : String

When provided, the closing balance for this ledger on this statement. Required if multiple ledgers are affected by this statement.
documentDebtPosition : BillingDocumentPositionType

Position of the billing document in the delinquent debt tracking system.
fromDate : Date

The date of the constituent bill covered from.
id : ID

The ID of the constituent bill.
identifier : ID

The unique identifier for the billing document. Note: a pending billing document will not have an identifier yet; and not all finalized billing documents will have an identifier assigned to them, in which case this will be null.
isAnnulled : Boolean! required

Whether the billing document has been annulled.
isHeld : Boolean! required

Whether the billing document is currently held.
issuedDate : Date

The date the bill was sent to the customer.
openingBalance : Int

This field returns the opening balance of a statement.
Arguments
ledgerNumber : String

When provided, the opening balance for this ledger on this statement. Required if multiple ledgers are affected by this statement.
printedCopyRequests : [Date]

List of dates when a printed copy of this bill was requested.
representations : BillRepresentationConnectionTypeConnection
Arguments
after : String
before : String
code : String

The code of a representation. Used to identify different types of representations.
first : Int
last : Int
reversalsAfterClose : StatementReversalsAfterClose! required

How many charges have been reversed after the close date.
temporaryUrl : String

Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead.
Deprecation
The 'temporaryUrl' field is deprecated.

This field is deprecated. Use the 'attachments' field instead.

- Marked as deprecated on 2024-09-16.
- Scheduled for removal on or after 2025-09-01.
toDate : Date

The date of the constituent bill covered to.
totalCharges : StatementTotalType

The total amounts for all charges on the billing document.
totalCredits : StatementTotalType

The total amounts for all credits on the statement.
transactions : BillTransactionConnectionTypeConnection

Transactions on the given billing document.
Arguments
after : String
before : String
first : Int
last : Int
ledgerNumber : String

When provided, only entries that are linked to that ledger are returned.
orderBy : TransactionsOrderBy default: POSTED_DATE_DESC

The order in which to return the transactions.
transactionTypes : [TransactionTypeFilter]

Include only these specific transaction types in the result.
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

{ "attachments": BillingAttachmentConnectionTypeConnection, "billType": "STATEMENT", "closingBalance": 52, "documentDebtPosition": BillingDocumentPositionType, "fromDate": "2020-11-27", "id": "12428399", "identifier": "31067525", "isAnnulled": true, "isHeld": true, "issuedDate": "1981-05-13", "openingBalance": 42, "printedCopyRequests": "2015-11-24", "representations": BillRepresentationConnectionTypeConnection, "reversalsAfterClose": "ALL", "toDate": "2001-11-16", "totalCharges": StatementTotalType, "totalCredits": StatementTotalType, "transactions": BillTransactionConnectionTypeConnection }