← All types
Sales & CRMOb Object

InvoiceState

An invoice document for billing a customer

Fields

id

InvoiceID!Non-null

Unique identifier

Invoice number

Type of invoice document

Possible values (3)
INVOICE

Standard invoice

CREDIT_NOTE

Credit note against an existing invoice

PROFORMA

Proforma invoice

Associated order ID

Customer ID

Contact person ID

Billing address ID

Invoice status

Possible values (7)
DRAFT

Invoice is in draft state

SENT

Invoice has been sent to the customer

PARTIALLY_PAID

Invoice has been partially paid

PAID

Invoice has been fully paid

OVERDUE

Invoice is past due date

VOID

Invoice has been voided

CREDITED

Invoice has been credited

Issue date (ISO8601)

Due date (ISO8601)

Payment date (ISO8601)

Subtotal amount before tax

Tax amount

Total amount including tax

Amount paid so far

Currency code (e.g. EUR, USD)

taxRate

FloatNullable

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

notes

StringNullable

Notes visible to the customer

Internal notes not visible to the customer

ID of the user who created this invoice

Creation timestamp (ISO8601)

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.

Referenced by (10)
Exact type 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!]!
}