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 {
  accountingCustomerId: ID
  accountingCustomerInherited: Boolean!
  accountingCustomerName: String
  accountingIntegrationId: ID
  accountingItemsLinked: Boolean
  accountingTermId: ID
  accountingTermName: String
  depositAccountExternalId: String
  depositAccountName: String
  discountMonetary: MonetaryValue
  discountPercent: Decimal
  discountType: OrderFinancialDiscountTypeEnum!
  documentDate: ISO8601Date!
  documentType: OrderFinancialDocumentTypeEnum!
  documentTypeLocked: Boolean!
  externalDocumentCount: Int!
  externalId: String
  externalUrl: String
  id: ID
  integrationName: String
  lines: [OrderFinancialLine!]!
  otherCostMonetary: MonetaryValue
  salesTaxMonetary: MonetaryValue
  sentToExternal: Boolean!
  shippingCostMonetary: MonetaryValue
  shippingPriceMonetary: MonetaryValue
  sourceId: ID
  sourceLabel: String!
  sourceType: OrderFinancialSourceTypeEnum!
}

Fields​

OrderFinancialDocument.accountingCustomerId ● ID scalar common​

The accounting customer this document bills to. Null when an unsent document inherits from its sales channel.

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

True when the document has no override and follows its sales channel. Always false once sent.

OrderFinancialDocument.accountingCustomerName ● String scalar common​

Display name of the effective accounting customer. Null when none resolves, including a sent document whose customer was never recorded.

OrderFinancialDocument.accountingIntegrationId ● ID scalar common​

The accounting integration this document resolves its customer against — the one it was sent to, or the one its sales channel is mapped to. Null when the channel has no accounting route.

OrderFinancialDocument.accountingItemsLinked ● Boolean scalar common​

True when every line's product is linked to an accounting item on the document's accounting integration, so all lines will resolve ItemRefs at push. False when any line's product is unlinked (or has no product). Null when the document has no accounting integration route.

OrderFinancialDocument.accountingTermId ● ID scalar common​

Payment terms for this document (invoices only). Null when the document follows the integration's default terms.

OrderFinancialDocument.accountingTermName ● String scalar common​

Display name of the document's effective payment terms, e.g. "Net 30" — the document's own terms, or the integration's default terms when accountingTermId is null. Null when neither is set.

OrderFinancialDocument.depositAccountExternalId ● String scalar common​

External id of the accounting account receiving this document's funds (sales receipts only). Null when the document follows the integration's default deposit account.

OrderFinancialDocument.depositAccountName ● String scalar common​

Display name of the effective deposit account — the document's own account, or the integration's default when depositAccountExternalId is null. Null when neither is set.

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.externalDocumentCount ● Int! non-null scalar common​

How many financial documents share this document's external record — greater than 1 for consolidated sales receipts, where an edit rebuilds the external document from every member.

OrderFinancialDocument.externalId ● String scalar common​

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

OrderFinancialDocument.externalUrl ● String scalar common​

Deep link to this document in the external accounting system. Null until sent.

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.otherCostMonetary ● MonetaryValue object common​

Other costs the brand pays on this document. Internal; never sent to the accounting provider.

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 the brand pays. Internal; never sent to the accounting provider.

OrderFinancialDocument.shippingPriceMonetary ● MonetaryValue object common​

The shipping price charged to the customer. Appears on the accounting document.

OrderFinancialDocument.sourceId ● ID scalar common​

The id of the order, fulfillment, or shipment this document represents.

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​

changeOrderFinancialDocumentType mutation ● createOrderFinancial mutation ● setOrderFinancialAccountingCustomer mutation ● updateOrderFinancial mutation

Member Of​

V2Order object