Skip to main content

UpdateOrderFinancialInput

Autogenerated input type of UpdateOrderFinancial

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

Fields​

UpdateOrderFinancialInput.accountingTermId ● ID scalar common​

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

UpdateOrderFinancialInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

UpdateOrderFinancialInput.depositAccountExternalId ● String scalar common​

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

UpdateOrderFinancialInput.discount ● Decimal scalar common​

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

UpdateOrderFinancialInput.discountPercent ● Decimal scalar common​

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

UpdateOrderFinancialInput.discountType ● OrderFinancialDiscountTypeEnum enum orders​

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

UpdateOrderFinancialInput.documentDate ● ISO8601Date scalar common​

The document date.

UpdateOrderFinancialInput.documentType ● OrderFinancialDocumentTypeEnum enum orders​

The document type (invoice / sales receipt).

UpdateOrderFinancialInput.lines ● [OrderFinancialLineInput!] list input orders​

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

UpdateOrderFinancialInput.orderFinancialId ● ID! non-null scalar common​

The ID of the order financial document to update.

UpdateOrderFinancialInput.otherCost ● Decimal scalar common​

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

UpdateOrderFinancialInput.salesTax ● Decimal scalar common​

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

UpdateOrderFinancialInput.shippingCost ● Decimal scalar common​

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

UpdateOrderFinancialInput.shippingPrice ● Decimal scalar common​

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

Member Of​

updateOrderFinancial mutation