Invoice

Invoice data available to a scoped Management API integration.

type Invoice {
  billingAddressId: ID
  billingAddressSnapshot: AddressSnapshot
  body: String
  buyerReference: String
  checkoutSupersededAt: DateTime
  contactId: ID
  correctedInvoiceId: ID
  createdAt: DateTime!
  currency: String!
  discardedAt: DateTime
  dueDate: DateTime
  exportStatus: String
  externalRef: String
  id: ID!
  name: String
  number: String
  orderId: ID
  paymentState: String
  publishedAt: DateTime
  receiptId: ID
  salesChannelId: ID
  tombstone: Boolean!
  totalGrossValueCents: BigInt!
  updatedAt: DateTime!
}

Fields

Invoice.billingAddressId · ID scalar

Billing address id.

Invoice.billingAddressSnapshot · AddressSnapshot object

Historical billing address; additionally requires contacts:read.

Invoice.body · String scalar

Body.

Invoice.buyerReference · String scalar

Buyer reference.

Invoice.checkoutSupersededAt · DateTime scalar

Checkout superseded at.

Invoice.contactId · ID scalar

Contact id.

Invoice.correctedInvoiceId · ID scalar

Corrected invoice id.

Invoice.createdAt · DateTime! non-null scalar

Record creation timestamp.

Invoice.currency · String! non-null scalar

Currency of the gross total.

Invoice.discardedAt · DateTime scalar

When the record was discarded; null for an active record.

Invoice.dueDate · DateTime scalar

Due date.

Invoice.exportStatus · String scalar

Export status.

Invoice.externalRef · String scalar

External ref.

Invoice.id · ID! non-null scalar

Stable record identifier.

Invoice.name · String scalar

Display name when the resource provides one.

Invoice.number · String scalar

External-facing record number when the resource provides one.

Invoice.orderId · ID scalar

Order id.

Invoice.paymentState · String scalar

Payment state.

Invoice.publishedAt · DateTime scalar

Published at.

Invoice.receiptId · ID scalar

Receipt id.

Invoice.salesChannelId · ID scalar

Sales channel id.

Invoice.tombstone · Boolean! non-null scalar

True when the discarded record represents a removal to propagate locally.

Invoice.totalGrossValueCents · BigInt! non-null scalar

Gross total including discounts and taxes, in minor currency units.

Invoice.updatedAt · DateTime! non-null scalar

Timestamp used for incremental synchronization and cursor ordering.

Returned By

invoice query

Member Of

InvoiceCollection object