Fields

annulledBy : AnnulmentBillingDocumentType

Billing document that annuls this invoice.
documentDebtPosition : BillingDocumentPositionType

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

The final date before missing payment is considered overdue.
firstIssued : DateTime

First time the invoice was issued.
id : Int

Unique identifier for the invoice billing document.
invoicedAmount : Int

The invoiced amount of the billing document.
isHeld : Boolean

Whether the billing document is currently held.
number : String

The unique billing document's reference that can be used for identifying it externally.
paymentDueDate : Date

The date due for payment for the invoice.
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 Invoice.
scheduledPaymentDate : Date

The planned date for payment (may be before the due_date).
totalCharges : InvoiceTotalType

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

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

Transactions on the invoice
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": "2025-01-07", "firstIssued": "1982-06-02T15:27:22.521597+00:00", "id": 19603464, "invoicedAmount": 98, "isHeld": true, "number": "memory-theory-city-she-third", "pdfUrl": "find-realize-support-he-red", "scheduledPaymentDate": "2011-09-02", "totalCharges": InvoiceTotalType, "totalCredits": InvoiceTotalType, "transactions": BillTransactionConnectionTypeConnection }