Fields

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

The type of the bill.
fromDate : Date

The date of the bill is covered from.
grossAmount : Int

This field returns the total gross amount of the bill in pence.
id : ID

The ID of the bill.
identifier : String

The unique identifier of a bill. It will usually be present on the billing document itself.

Note: a bill that hasn't been issued yet will not have an identifier; and not all issued bills 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

Whether the billing document is currently held.
issuedDate : Date

The date the bill was sent to the customer.
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 bill is covered to.
totalCharges : InvoiceTotalType

The total amounts for all charges on the invoice.
totalCredits : InvoiceTotalType

The total amounts for all credits on the invoice.
totalPayments : Int

The sum of all previous payments made that are included towards this invoice.
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", "fromDate": "2011-05-16", "grossAmount": 74, "id": "76075271", "identifier": "25179403", "isAnnulled": true, "isHeld": true, "issuedDate": "2006-08-25", "representations": BillRepresentationConnectionTypeConnection, "reversalsAfterClose": "ALL", "toDate": "1991-05-13", "totalCharges": InvoiceTotalType, "totalCredits": InvoiceTotalType, "totalPayments": 27, "transactions": BillTransactionConnectionTypeConnection }