Skip to main content

OrdersFinancialsUpdateInput

Autogenerated input type of OrdersFinancialsUpdate

input OrdersFinancialsUpdateInput {
  accountingTermId: ID
  clientMutationId: String
  customerMemo: String
  depositAccountExternalId: String
  discount: Decimal
  discountPercent: Decimal
  discountType: OrderFinancialDiscountTypeEnum
  documentDate: ISO8601Date
  documentType: OrderFinancialDocumentTypeEnum
  lines: [OrderFinancialLineInput!]
  orderFinancialId: ID!
  otherCost: Decimal
  salesTax: Decimal
  shipDate: ISO8601Date
  shippingCarrier: String
  shippingCost: Decimal
  shippingPrice: Decimal
  trackingNumber: String
}

Fields

`OrdersFinancialsUpdateInput.accountingTermId` ● `ID` scalar common

Payment terms for the document (invoices). Omit to leave unchanged.

`OrdersFinancialsUpdateInput.clientMutationId` ● `String` scalar common

A unique identifier for the client performing the mutation.

`OrdersFinancialsUpdateInput.customerMemo` ● `String` scalar common

Customer-facing memo printed on the invoice. Omit to leave unchanged; null clears it.

`OrdersFinancialsUpdateInput.depositAccountExternalId` ● `String` scalar common

External id of the account receiving the document's funds (sales receipts). Omit to leave unchanged.

`OrdersFinancialsUpdateInput.discount` ● `Decimal` scalar common

The discount amount (used when discountType is AMOUNT). Must be non-negative.

`OrdersFinancialsUpdateInput.discountPercent` ● `Decimal` scalar common

The discount percentage 0-100 (used when discountType is PERCENT).

`OrdersFinancialsUpdateInput.discountType` ● `OrderFinancialDiscountTypeEnum` enum orders

Whether the discount is a fixed AMOUNT or a PERCENT of the line subtotal.

`OrdersFinancialsUpdateInput.documentDate` ● `ISO8601Date` scalar common

The document date.

`OrdersFinancialsUpdateInput.documentType` ● `OrderFinancialDocumentTypeEnum` enum orders

The document type (invoice / sales receipt).

`OrdersFinancialsUpdateInput.lines` ● `[OrderFinancialLineInput!]` list input orders

The final desired set of document lines. Omit to leave lines unchanged.

`OrdersFinancialsUpdateInput.orderFinancialId` ● `ID!` non-null scalar common

The ID of the order financial document to update.

`OrdersFinancialsUpdateInput.otherCost` ● `Decimal` scalar common

Other costs the brand pays on this document. Internal. Must be non-negative.

`OrdersFinancialsUpdateInput.salesTax` ● `Decimal` scalar common

The sales tax on the document. Must be non-negative.

`OrdersFinancialsUpdateInput.shipDate` ● `ISO8601Date` scalar common

Ship date shown on the invoice. Omit to leave unchanged; null falls back to the shipment.

`OrdersFinancialsUpdateInput.shippingCarrier` ● `String` scalar common

Carrier shown on the invoice. Omit to leave unchanged; null falls back to the shipment.

`OrdersFinancialsUpdateInput.shippingCost` ● `Decimal` scalar common

The shipping cost the brand pays. Internal; not sent to the accounting provider. Must be non-negative.

`OrdersFinancialsUpdateInput.shippingPrice` ● `Decimal` scalar common

The shipping price charged to the customer; appears on the accounting document. Must be non-negative.

`OrdersFinancialsUpdateInput.trackingNumber` ● `String` scalar common

Tracking number shown on the invoice. Omit to leave unchanged; null falls back to the shipment.

Member Of

ordersFinancialsUpdate mutation

Fields
Member Of