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!
  actualDeliveryDate: DateTime
  amountNet: Float
  amountTotal: Float
  currencyFactor: Float!
  currencyFactorCapturedAt: DateTime
  currencyId: ID!
  customFields: JSON
  dueDate: DateTime
  expectedDeliveryDate: DateTime
  internalComment: String
  number: String!
  orderDateTime: DateTime!
  paymentState: String!
  positionPrice: Float
  salesChannelId: ID
  state: String!
  supplierId: ID
  supplierOrderNumber: String
  taxStatus: String
  taxationType: SupplierTaxationType!
  warehouseId: ID
  currency: Currency
  goodsReceiptLineItems(
    first: Int = 10
    after: String
    filter: GoodsReceiptLineItemFilterInput
  ): GoodsReceiptLineItemConnection
  goodsReceipts(
    first: Int = 10
    after: String
    filter: GoodsReceiptFilterInput
  ): GoodsReceiptConnection
  lineItems(
    first: Int = 10
    after: String
    filter: SupplierOrderLineItemFilterInput
  ): SupplierOrderLineItemConnection
  salesChannel: SalesChannel
  supplier: Supplier
  tags(
    first: Int = 10
    after: String
    filter: TagFilterInput
  ): TagConnection
  warehouse: Warehouse
}

Fields

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

Global identifier for this entity.

`SupplierOrder.actualDeliveryDate` ● `DateTime` scalar

Date the supplier actually delivered.

`SupplierOrder.amountNet` ● `Float` scalar

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

`SupplierOrder.amountTotal` ● `Float` scalar

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

`SupplierOrder.currencyFactor` ● `Float!` non-null scalar

Exchange rate of the order's currency at the time the order was raised or its currency was last changed, as units of that currency per one unit of the system default currency. Used to show the order total in the system default currency; stock is valued with the exchange rate of the goods receipt (GoodsReceipt.currencyFactor), not with this one.

`SupplierOrder.currencyFactorCapturedAt` ● `DateTime` scalar

Timestamp currencyFactor was taken. Null for orders raised before exchange rates were recorded.

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

ID of the currency the order is denominated in. Taken from the supplier when the order is raised, unless createSupplierOrder names another one. Can be changed in the Administration until the order is completed or cancelled, one of its goods receipts is completed, or one of its goods receipts also belongs to another supplier order.

`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.

`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.internalComment` ● `String` scalar

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

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

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

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

Timestamp the supplier order was raised.

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

Technical name of the order's payment state: open, partially_paid or paid.

`SupplierOrder.positionPrice` ● `Float` scalar

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

`SupplierOrder.salesChannelId` ● `ID` scalar

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

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

Technical name of the order's state: open, confirmed, sent, partially_delivered, delivered, completed or cancelled.

`SupplierOrder.supplierId` ● `ID` scalar

ID of the supplier.

`SupplierOrder.supplierOrderNumber` ● `String` scalar

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

`SupplierOrder.taxStatus` ● `String` scalar

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

`SupplierOrder.taxationType` ● `SupplierTaxationType!` non-null enum

Taxation type the order was raised with, taken from the supplier's override or derived from the countries of the supplier and of the company. Decides the tax rate of the line items.