SupplierOrder

A purchase order raised against a supplier. Carries header data (supplier, currency, warehouse, dates), per-line procurement details, and the totals and tax status used by accounting. Goods are booked in against the supplier order via GoodsReceipt.

type SupplierOrder implements Node {
  id: ID!
  supplierId: ID
  warehouseId: ID
  salesChannelId: ID
  currencyId: ID!
  number: String!
  supplierOrderNumber: String
  orderDateTime: DateTime!
  dueDate: DateTime
  expectedDeliveryDate: DateTime
  actualDeliveryDate: DateTime
  amountTotal: Float
  amountNet: Float
  positionPrice: Float
  taxStatus: String
  internalComment: String
  state: String!
  paymentState: String!
  customFields: JSON
  supplier: Supplier
  warehouse: Warehouse
  salesChannel: SalesChannel
  currency: Currency
  lineItems(
    first: Int = 10
    after: String
    filter: SupplierOrderLineItemFilterInput
  ): SupplierOrderLineItemConnection
  goodsReceipts(
    first: Int = 10
    after: String
    filter: GoodsReceiptFilterInput
  ): GoodsReceiptConnection
  goodsReceiptLineItems(
    first: Int = 10
    after: String
    filter: GoodsReceiptLineItemFilterInput
  ): GoodsReceiptLineItemConnection
  tags(
    first: Int = 10
    after: String
    filter: TagFilterInput
  ): TagConnection
}

Fields

`SupplierOrder.id` ● `ID!` non-null scalar

Global identifier for this entity.

`SupplierOrder.supplierId` ● `ID` scalar

ID of the supplier.

`SupplierOrder.warehouseId` ● `ID` scalar

ID of the warehouse the goods are destined for.

`SupplierOrder.salesChannelId` ● `ID` scalar

ID of the sales channel the supplier order is attributed to. Drives the default tax / currency setup.

`SupplierOrder.currencyId` ● `ID!` non-null scalar

ID of the currency the order is denominated in.

`SupplierOrder.number` ● `String!` non-null scalar

Internal supplier order number. Used in the admin UI and on documents.

`SupplierOrder.supplierOrderNumber` ● `String` scalar

Order number assigned by the supplier (i.e. how the supplier references this order).

`SupplierOrder.orderDateTime` ● `DateTime!` non-null scalar

Timestamp the supplier order was raised.

`SupplierOrder.dueDate` ● `DateTime` scalar

Due date for paying the supplier.

`SupplierOrder.expectedDeliveryDate` ● `DateTime` scalar

Date the supplier promised delivery. Defaulted from the line items' expected dates; can be tightened via updateSupplierOrderExpectedDeliveryDate.

`SupplierOrder.actualDeliveryDate` ● `DateTime` scalar

Date the supplier actually delivered.

`SupplierOrder.amountTotal` ● `Float` scalar

Grand total in the order's currency, including tax.

`SupplierOrder.amountNet` ● `Float` scalar

Net total in the order's currency, excluding tax.

`SupplierOrder.positionPrice` ● `Float` scalar

Sum of all line item prices before order-level discounts/charges, in the order's currency.

`SupplierOrder.taxStatus` ● `String` scalar

Tax status of the order (gross, net, tax-free).

`SupplierOrder.internalComment` ● `String` scalar

Free-form internal note. Not printed on the document sent to the supplier.

`SupplierOrder.state` ● `String!` non-null scalar

Technical name of the order's state machine state (e.g. open, confirmed, ordered, completed, cancelled).

`SupplierOrder.paymentState` ● `String!` non-null scalar

Technical name of the order's payment state (e.g. unpaid, partially_paid, paid).

`SupplierOrder.customFields` ● `JSON` scalar

Custom fields configured for supplier orders, as a JSON object keyed by custom field technical name. Null when no custom fields are set. Write via setSupplierOrderCustomFields.