← All types
Sales & CRMIn Input object

UpsertInvoiceInput

Input for creating or updating an invoice

Fields

id

InvoiceIDOptional

ID for update; omit for create

Invoice number (required)

Type of invoice document (required)

Possible values (3)
INVOICE

Standard invoice

CREDIT_NOTE

Credit note against an existing invoice

PROFORMA

Proforma invoice

Associated order ID

Customer ID (required)

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 (required)

taxRate

FloatOptional

Tax rate percentage

ID of the invoice this credit note applies to

Payment terms

Payment method

Payment reference

notes

StringOptional

Notes visible to the customer

Internal notes

Document attachments. When provided, replaces existing attachments on the invoice.

Referenced by (1)
Exact type SDL
"""Input for creating or updating an invoice"""
input UpsertInvoiceInput {
  """ID for update; omit for create"""
  id: InvoiceID
  """Invoice number (required)"""
  invoiceNumber: String!
  """Type of invoice document (required)"""
  kind: InvoiceKind!
  """Associated order ID"""
  orderId: OrderID
  """Customer ID (required)"""
  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 (required)"""
  currency: CurrencyISO!
  """Tax rate percentage"""
  taxRate: Float
  """ID of the invoice this credit note applies to"""
  creditedInvoiceId: InvoiceID
  """Payment terms"""
  paymentTerms: String
  """Payment method"""
  paymentMethod: String
  """Payment reference"""
  paymentReference: String
  """Notes visible to the customer"""
  notes: String
  """Internal notes"""
  internalNotes: String
  """
  Document attachments. When provided, replaces existing attachments on the invoice.
  """
  attachments: [InvoiceFileAttachmentInput!]
}