Skip to main content

UpdateSalesOrderInput

Input to edit a sales order. Fields left out are unchanged; which fields can change depends on the order's status.

input UpdateSalesOrderInput {
  billingAddress: CreateSalesOrderAddressInput
  convertMissingCurrencyPrices: Boolean
  currency: String
  customerEmail: String
  customerMobile: String
  customerPoNumber: String
  deliveryInstructions: String
  discountAmount: Float
  exchangeRate: Float
  expectedVersion: Int
  internalNotes: String
  items: [CreateSalesOrderItemInput!]
  notes: String
  orderDate: String
  paymentTerms: String
  promisedDate: DateTime
  reference: String
  shippingAddress: CreateSalesOrderAddressInput
  shippingAmount: Float
  shippingMethod: String
  taxCalculationMethod: String
  warehouseId: String
}

Fields

`UpdateSalesOrderInput.billingAddress` ● `CreateSalesOrderAddressInput` input

Billing address for the order.

`UpdateSalesOrderInput.convertMissingCurrencyPrices` ● `Boolean` scalar

Opt in to pricing a foreign-currency line with no price in the order currency by converting its base price. See CreateSalesOrderInput.

`UpdateSalesOrderInput.currency` ● `String` scalar

ISO 4217 currency code of the order. It is fixed once the order leaves DRAFT.

`UpdateSalesOrderInput.customerEmail` ● `String` scalar

Customer email shown on the order.

`UpdateSalesOrderInput.customerMobile` ● `String` scalar

Customer mobile number shown on the order.

`UpdateSalesOrderInput.customerPoNumber` ● `String` scalar

Buyer-supplied PO number. Non-financial: still editable after DRAFT.

`UpdateSalesOrderInput.deliveryInstructions` ● `String` scalar

Delivery instructions for the order.

`UpdateSalesOrderInput.discountAmount` ● `Float` scalar

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

`UpdateSalesOrderInput.exchangeRate` ● `Float` scalar

Exchange rate between the order currency and the organization's base currency. Must be greater than zero.

`UpdateSalesOrderInput.expectedVersion` ● `Int` scalar

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

`UpdateSalesOrderInput.internalNotes` ● `String` scalar

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

`UpdateSalesOrderInput.items` ● `[CreateSalesOrderItemInput!]` list input

The order lines. Lines can only be changed while the order is unpaid and not shipped or invoiced.

`UpdateSalesOrderInput.notes` ● `String` scalar

Notes for the customer.

`UpdateSalesOrderInput.orderDate` ● `String` scalar

Re-date the order, as an ISO 8601 date. Needs the backdate permission, like create.

`UpdateSalesOrderInput.paymentTerms` ● `String` scalar

Payment terms code for the order.

`UpdateSalesOrderInput.promisedDate` ● `DateTime` scalar

Date the order is promised for delivery.

`UpdateSalesOrderInput.reference` ● `String` scalar

Reference shown on the order.

`UpdateSalesOrderInput.shippingAddress` ● `CreateSalesOrderAddressInput` input

Shipping address for the order.

`UpdateSalesOrderInput.shippingAmount` ● `Float` scalar

Shipping charge for the order.

`UpdateSalesOrderInput.shippingMethod` ● `String` scalar

Shipping method for the order.

`UpdateSalesOrderInput.taxCalculationMethod` ● `String` scalar

Whether prices include or exclude tax: INCLUSIVE or EXCLUSIVE. It is fixed once the order leaves DRAFT.

`UpdateSalesOrderInput.warehouseId` ● `String` scalar

The ID of the default warehouse for the order.

Member Of

updateSalesOrder mutation

Fields
Member Of