Skip to main content

OrderFinancialLine

A line item on an order's accounting document (OrderFinancial). When the document has not been persisted yet, id is null and the line is derived from the order item.

type OrderFinancialLine {
accountingItemLinked: Boolean
id: ID
itemId: ID
itemSourceType: OrderFinancialSourceTypeEnum
lineTotalMonetary: MonetaryValue
orderId: ID
product: Product
productId: ID
quantity: Decimal!
sku: String
unitCostMonetary: MonetaryValue
unitPriceMonetary: MonetaryValue
}

Fields​

OrderFinancialLine.accountingItemLinked ● Boolean scalar common​

True when this line's product is linked to an accounting item on the document's accounting integration, so the line will resolve an ItemRef at push. False when the product is unlinked or the line has no product. Null when the document has no accounting integration route.

OrderFinancialLine.id ● ID scalar common​

The line id. Null when the line is derived and not yet persisted.

OrderFinancialLine.itemId ● ID scalar common​

The source item this line came from — an order item, fulfillment item, or shipment item id.

OrderFinancialLine.itemSourceType ● OrderFinancialSourceTypeEnum enum orders​

Which kind of item itemId references.

OrderFinancialLine.lineTotalMonetary ● MonetaryValue object common​

The line total (unit price × quantity).

OrderFinancialLine.orderId ● ID scalar common​

The order this line's revenue belongs to.

OrderFinancialLine.product ● Product object products​

The product for this line. User must have the read_product permission.

OrderFinancialLine.productId ● ID scalar common​

OrderFinancialLine.quantity ● Decimal! non-null scalar common​

OrderFinancialLine.sku ● String scalar common​

OrderFinancialLine.unitCostMonetary ● MonetaryValue object common​

The unit cost the brand pays for the line item. Internal; never sent to the accounting provider.

OrderFinancialLine.unitPriceMonetary ● MonetaryValue object common​

The unit price of the line item.

Member Of​

OrderFinancialDocument object