Skip to main content

CreateOrderFinancialInput

Autogenerated input type of CreateOrderFinancial

input CreateOrderFinancialInput {
  clientMutationId: String
  discount: Decimal
  discountPercent: Decimal
  discountType: OrderFinancialDiscountTypeEnum
  documentDate: ISO8601Date
  documentType: OrderFinancialDocumentTypeEnum
  lines: [OrderFinancialLineInput!]!
  orderFulfillmentId: ID
  orderId: ID!
  orderShipmentId: ID
  salesTax: Decimal
  shippingCost: Decimal
  sourceType: OrderFinancialSourceTypeEnum!
}

Fields​

CreateOrderFinancialInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

CreateOrderFinancialInput.discount ● Decimal scalar common​

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

CreateOrderFinancialInput.discountPercent ● Decimal scalar common​

The discount percentage 0-100 (used when discountType is PERCENT). Applied to the line subtotal, ignoring shipping and tax.

CreateOrderFinancialInput.discountType ● OrderFinancialDiscountTypeEnum enum orders​

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

CreateOrderFinancialInput.documentDate ● ISO8601Date scalar common​

Defaults per source: order.created_at, fulfillment.updated_at, or shipment.shipped_date.

CreateOrderFinancialInput.documentType ● OrderFinancialDocumentTypeEnum enum orders​

Defaults from the sales channel's invoicing_type setting.

CreateOrderFinancialInput.lines ● [OrderFinancialLineInput!]! non-null input orders​

Line items on the document.

CreateOrderFinancialInput.orderFulfillmentId ● ID scalar common​

Required when source_type is FULFILLMENT.

CreateOrderFinancialInput.orderId ● ID! non-null scalar common​

The order the document belongs to.

CreateOrderFinancialInput.orderShipmentId ● ID scalar common​

Required when source_type is SHIPMENT.

CreateOrderFinancialInput.salesTax ● Decimal scalar common​

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

CreateOrderFinancialInput.shippingCost ● Decimal scalar common​

The shipping cost on the document. Must be non-negative.

CreateOrderFinancialInput.sourceType ● OrderFinancialSourceTypeEnum! non-null enum orders​

Which entity the document is being created for.

Member Of​

createOrderFinancial mutation