Skip to main content

UpdateInvoiceInput

Changes to an invoice.

input UpdateInvoiceInput {
  billingAddress: JSON
  currency: String
  discountAmount: Float
  dueDate: String
  exchangeRate: Float
  expectedVersion: Int
  internalNotes: String
  invoiceDate: String
  items: [UpdateInvoiceItemInput!]
  notes: String
  partnerId: ID
  paymentTerms: String
  shippingAddress: JSON
  shippingAmount: Float
  status: InvoiceStatus
  surchargeAmount: Float
  taxAmount: Float
  taxCalculationMethod: String
  terms: String
}

Fields

`UpdateInvoiceInput.billingAddress` ● `JSON` scalar

Billing address, as JSON.

`UpdateInvoiceInput.currency` ● `String` scalar

ISO 4217 currency code of the invoice.

`UpdateInvoiceInput.discountAmount` ● `Float` scalar

Additional invoice-level discount as an amount. Must not be negative.

`UpdateInvoiceInput.dueDate` ● `String` scalar

Payment due date, as an ISO 8601 date.

`UpdateInvoiceInput.exchangeRate` ● `Float` scalar

Exchange rate to the organization's base currency: 1 unit of the invoice currency equals this many base units. Must be greater than zero.

`UpdateInvoiceInput.expectedVersion` ● `Int` scalar

Optimistic-concurrency check: the version this client read. Stale → typed VERSION_CONFLICT under COMMAND_CAS=enforce.

`UpdateInvoiceInput.internalNotes` ● `String` scalar

Notes for your team only, not shown to the customer.

`UpdateInvoiceInput.invoiceDate` ● `String` scalar

The invoice date, as an ISO 8601 date.

`UpdateInvoiceInput.items` ● `[UpdateInvoiceItemInput!]` list input

The invoice lines.

`UpdateInvoiceInput.notes` ● `String` scalar

Notes shown to the customer on the invoice.

`UpdateInvoiceInput.partnerId` ● `ID` scalar

The ID of the customer or supplier.

`UpdateInvoiceInput.paymentTerms` ● `String` scalar

Payment terms code. It is checked against your organization's configured terms.

`UpdateInvoiceInput.shippingAddress` ● `JSON` scalar

Shipping address, as JSON.

`UpdateInvoiceInput.shippingAmount` ● `Float` scalar

Shipping charge. Must not be negative.

`UpdateInvoiceInput.status` ● `InvoiceStatus` enum

Move the invoice to this status.

`UpdateInvoiceInput.surchargeAmount` ● `Float` scalar

Surcharge. Must not be negative.

`UpdateInvoiceInput.taxAmount` ● `Float` scalar

Total tax on the invoice. Must not be negative.

`UpdateInvoiceInput.taxCalculationMethod` ● `String` scalar

Whether prices include or exclude tax: INCLUSIVE or EXCLUSIVE.

`UpdateInvoiceInput.terms` ● `String` scalar

Terms and conditions text printed on the invoice. Put the payment term code in paymentTerms, not here.

Member Of

updateInvoice mutation

Fields
Member Of