Skip to main content

Fields

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

The type of the bill.

closingBalance : Int

This field returns the closing balance of an issued statement.

consumptionEndDate : Date

The last day of consumption that this statement includes.

consumptionStartDate : Date

The first day of consumption that this statement includes.

fromDate : Date

The date of the constituent bill covered from.

heldStatus : HeldStatus

Retrieve the held status of a account statement.

id : ID

The ID of the constituent bill.

isExternalBill : Boolean

Whether the bill originated in Kraken or externally.

isFinal : Boolean

Whether this statement is marked as final.

issuedDate : Date

The date the bill was sent to the customer.

openingBalance : Int

This field returns the opening balance of a statement.

paymentDueDate : Date

The date the bill is due to be paid.

reversalsAfterClose : StatementReversalsAfterClose! required

How many charges have been reversed after the close date.

Current status of the associated statement.

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

Email recipient address.

toDate : Date

The date of the constituent bill covered to.

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 bill.

Arguments
after : String
before : String
first : Int
last : Int
userId : Int

Email recipient user ID.

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": 94, "consumptionEndDate": "1974-04-02", "consumptionStartDate": "2005-12-14", "fromDate": "1986-06-16", "heldStatus": HeldStatus, "id": "58209850", "isExternalBill": true, "isFinal": true, "issuedDate": "1997-11-28", "openingBalance": 20, "paymentDueDate": "1975-09-17", "reversalsAfterClose": "ALL", "status": "OPEN", "toAddress": "sing-foreign-meeting-professor-conference", "toDate": "1978-06-18", "totalCharges": StatementTotalType, "totalCredits": StatementTotalType, "transactions": TransactionConnectionTypeConnection, "userId": 28996932 }