Invoice

View normalized Markdown

Invoice

graphql

type Invoice {
  accessToken: ID!
  invoiceItems: [InvoiceItem!]!
  number: String!
  paymentIntentCreateError: PaymentIntentCreateErrorEnum
  paymentLink: String!
  paymentState: InvoicePaymentStateEnum!
  payments: [Payment!]!
  request: Request
  salesTaxPayments: [SalesTaxPayment!]!
  totalGrossValue: Money!
}

Fields

`Invoice.accessToken` · `ID!` non-null scalar

Use this token to request a resource without authentication. Token lifetime depends on the resource.

`Invoice.invoiceItems` · `[InvoiceItem!]!` non-null object

`Invoice.number` · `String!` non-null scalar

Invoice number shown to the customer.

`Invoice.paymentIntentCreateError` · `PaymentIntentCreateErrorEnum` enum

Why a new payment cannot be started for this invoice. Null when a payment can be started.

`Invoice.paymentLink` · `String!` non-null scalar

Hosted payment page for this invoice in the language of the Accept-Language header.

`Invoice.paymentState` · `InvoicePaymentStateEnum!` non-null enum

`Invoice.payments` · `[Payment!]!` non-null object

Payment attempts for this invoice, including failed and in-progress attempts.

`Invoice.request` · `Request` object

the request the invoice was created for. only present if not collective invoice

`Invoice.salesTaxPayments` · `[SalesTaxPayment!]!` non-null object

`Invoice.totalGrossValue` · `Money!` non-null scalar

total value including external taxes, discounts and account transactions

Returned By

invoice query

Member Of

Request object · RequestPaymentInitiatePayload object