Skip to main content

OrdersFinancialsCreateInput

Autogenerated input type of OrdersFinancialsCreate

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

Fields​

OrdersFinancialsCreateInput.accountingCustomerId ● ID scalar common​

The accounting customer this document bills to. Defaults to the sales channel's customer.

OrdersFinancialsCreateInput.accountingTermId ● ID scalar common​

Payment terms for the document (invoices). Defaults to the integration's default terms.

OrdersFinancialsCreateInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

OrdersFinancialsCreateInput.customerMemo ● String scalar common​

Customer-facing memo printed on the invoice.

OrdersFinancialsCreateInput.depositAccountExternalId ● String scalar common​

External id of the account receiving the document's funds (sales receipts). Defaults to the integration's default deposit account.

OrdersFinancialsCreateInput.discount ● Decimal scalar common​

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

OrdersFinancialsCreateInput.discountPercent ● Decimal scalar common​

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

OrdersFinancialsCreateInput.discountType ● OrderFinancialDiscountTypeEnum enum orders​

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

OrdersFinancialsCreateInput.documentDate ● ISO8601Date scalar common​

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

OrdersFinancialsCreateInput.documentType ● OrderFinancialDocumentTypeEnum enum orders​

Defaults from the sales channel's invoicing_type setting.

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

Line items on the document.

OrdersFinancialsCreateInput.orderFinancialId ● ID scalar common​

Optional UUID for the new document. Reuse it when retrying the same creation request.

OrdersFinancialsCreateInput.orderFulfillmentId ● ID scalar common​

Required when source_type is FULFILLMENT.

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

The order the document belongs to.

OrdersFinancialsCreateInput.orderShipmentId ● ID scalar common​

Required when source_type is SHIPMENT.

OrdersFinancialsCreateInput.otherCost ● Decimal scalar common​

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

OrdersFinancialsCreateInput.salesTax ● Decimal scalar common​

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

OrdersFinancialsCreateInput.shipDate ● ISO8601Date scalar common​

Ship date shown on the invoice. Defaults to the shipment's shipped date.

OrdersFinancialsCreateInput.shippingCarrier ● String scalar common​

Carrier shown on the invoice. Defaults to the shipment's carrier.

OrdersFinancialsCreateInput.shippingCost ● Decimal scalar common​

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

OrdersFinancialsCreateInput.shippingPrice ● Decimal scalar common​

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

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

Which entity the document is being created for.

OrdersFinancialsCreateInput.trackingNumber ● String scalar common​

Tracking number shown on the invoice. Defaults to the shipment's tracking number.

Member Of​

ordersFinancialsCreate mutation