← API reference
CANONICAL TYPE REFERENCE

InvoiceState

An invoice document for billing a customer

Unique identifier

Invoice number

Type of invoice document

Associated order ID

Customer ID

Contact person ID

Billing address ID

Invoice status

Issue date (ISO8601)

Due date (ISO8601)

Payment date (ISO8601)

Subtotal amount before tax

taxAmountFloat!

Tax amount

Total amount including tax

Amount paid so far

Currency code (e.g. EUR, USD)

taxRateFloat

Tax rate percentage

ID of the invoice this credit note applies to

Payment terms (e.g. Net 30)

Payment method used

Payment reference or transaction ID

notesString

Notes visible to the customer

Internal notes not visible to the customer

ID of the user who created this invoice

createdAtString!

Creation timestamp (ISO8601)

updatedAtString!

Last update timestamp (ISO8601)

Customer for this invoice. Requires customer:read permission.

Source order. Requires order:read permission.

Line items for this invoice. Requires invoice:read permission.

User who created this invoice. Requires user:read permission.

Document attachments. Requires file:list permission.

View exact SDL
"""An invoice document for billing a customer"""
type InvoiceState {
  """Unique identifier"""
  id: InvoiceID!
  """Invoice number"""
  invoiceNumber: String!
  """Type of invoice document"""
  kind: InvoiceKind!
  """Associated order ID"""
  orderId: OrderID
  """Customer ID"""
  customerId: CustomerID!
  """Contact person ID"""
  contactId: ContactID
  """Billing address ID"""
  billingAddressId: AddressID
  """Invoice status"""
  status: InvoiceStatus!
  """Issue date (ISO8601)"""
  issueDate: ISO8601!
  """Due date (ISO8601)"""
  dueDate: ISO8601
  """Payment date (ISO8601)"""
  paidAt: ISO8601
  """Subtotal amount before tax"""
  subtotalAmount: Float!
  """Tax amount"""
  taxAmount: Float!
  """Total amount including tax"""
  totalAmount: Float!
  """Amount paid so far"""
  paidAmount: Float!
  """Currency code (e.g. EUR, USD)"""
  currency: CurrencyISO!
  """Tax rate percentage"""
  taxRate: Float
  """ID of the invoice this credit note applies to"""
  creditedInvoiceId: InvoiceID
  """Payment terms (e.g. Net 30)"""
  paymentTerms: String
  """Payment method used"""
  paymentMethod: String
  """Payment reference or transaction ID"""
  paymentReference: String
  """Notes visible to the customer"""
  notes: String
  """Internal notes not visible to the customer"""
  internalNotes: String
  """ID of the user who created this invoice"""
  createdByUserId: UserID
  """Creation timestamp (ISO8601)"""
  createdAt: String!
  """Last update timestamp (ISO8601)"""
  updatedAt: String!
  """Customer for this invoice. Requires customer:read permission."""
  customer: CustomerState
  """Source order. Requires order:read permission."""
  order: OrderState
  """Line items for this invoice. Requires invoice:read permission."""
  invoiceLines: [InvoiceLineState!]!
  """User who created this invoice. Requires user:read permission."""
  createdByUser: UserState
  """Document attachments. Requires file:list permission."""
  attachments: [InvoiceFileAttachment!]!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.