Skip to main content

OrderFinancialDocument

An order's accounting document (invoice / sales receipt). If no document has been persisted yet, a draft is derived from the order and id is null.

type OrderFinancialDocument {
  discountMonetary: MonetaryValue
  discountPercent: Decimal
  discountType: OrderFinancialDiscountTypeEnum!
  documentDate: ISO8601Date!
  documentType: OrderFinancialDocumentTypeEnum!
  documentTypeLocked: Boolean!
  externalId: String
  id: ID
  integrationName: String
  lines: [OrderFinancialLine!]!
  salesTaxMonetary: MonetaryValue
  sentToExternal: Boolean!
  shippingCostMonetary: MonetaryValue
  sourceLabel: String!
  sourceType: OrderFinancialSourceTypeEnum!
}

Fields​

OrderFinancialDocument.discountMonetary ● MonetaryValue object common​

The effective discount amount on the document (computed from the line subtotal when percent-based).

OrderFinancialDocument.discountPercent ● Decimal scalar common​

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

OrderFinancialDocument.discountType ● OrderFinancialDiscountTypeEnum! non-null enum orders​

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

OrderFinancialDocument.documentDate ● ISO8601Date! non-null scalar common​

OrderFinancialDocument.documentType ● OrderFinancialDocumentTypeEnum! non-null enum orders​

OrderFinancialDocument.documentTypeLocked ● Boolean! non-null scalar common​

When true the transaction type cannot be chosen even during creation — the sales channel consolidates sales receipts, so only invoices can be created manually.

OrderFinancialDocument.externalId ● String scalar common​

The id of this document in the external accounting system, if synced.

OrderFinancialDocument.id ● ID scalar common​

The document id. Null when the document is a derived draft that has not been saved.

OrderFinancialDocument.integrationName ● String scalar common​

The name of the external accounting integration this document was sent to. Null until the document has been sent.

OrderFinancialDocument.lines ● [OrderFinancialLine!]! non-null object orders​

The line items on the document.

OrderFinancialDocument.salesTaxMonetary ● MonetaryValue object common​

The sales tax on the document.

OrderFinancialDocument.sentToExternal ● Boolean! non-null scalar common​

Whether the document has been synced to an external accounting system.

OrderFinancialDocument.shippingCostMonetary ● MonetaryValue object common​

The shipping cost on the document.

OrderFinancialDocument.sourceLabel ● String! non-null scalar common​

Human label identifying which entity this document is for, e.g. "Order", "Fulfillment FO-1234", or "Shipment 1Z...". Used to title each document card.

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

Returned By​

createOrderFinancial mutation ● updateOrderFinancial mutation

Member Of​

V2Order object