Skip to main content

Fields

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 : BigInt

The gross amount of the historical bill.

id : ID

The ID of the bill.

identifier : String

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

issuedDate : Date

The date the bill was sent to the customer.

params : JSONString

The params associated with the historical bill.

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.

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": "1973-07-11", "grossAmount": 1, "id": "57639702", "identifier": "87855754", "issuedDate": "1977-10-28", "params": {"key": "value"}, "reversalsAfterClose": "ALL", "toDate": "1977-01-29" }