Skip to main content
POST
Creates a new purchase order with item positions.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

Request model for CreatePurchaseOrder command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

supplierId
string<uuid>
required

ID of the supplier the order is placed with. Must reference an existing procurement supplier.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

requestedDeliveryDate
string<date-time>
required

The delivery date requested from the supplier.

items
object[]
required

Item positions of the order. At least one is required (enforced server-side; the list schema here has no declarative minimum-length constraint).

deliveryAddress
object

Delivery address of the order. When omitted, it is defaulted from the effective warehouse's address (see WarehouseId). A country name that cannot be resolved to an ISO code yields an empty CountryIso rather than failing the create.

billingAddress
object

Billing address of the order. When omitted, it is defaulted from the effective company's address.

externalOrderNumber
string

The buyer's own external reference for this order (free text). Never generated by the server — contrast the order's own number, which the server assigns and which is not settable through this API.

referenceOrderNumber
string

A reference order number for this order — the "Zugehörige Auftragsnummer" field, free text, editable in the desktop UI.

internalComment
string

Internal comment on the order, not communicated to the supplier.

warehouseId
string<uuid>

Target warehouse of the incoming goods. When omitted, the supplier's own default warehouse is used. When supplied (or defaulted from the supplier), it must reference an existing warehouse.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

disableAutomaticWorkflows
boolean

Indicates whether automatic workflows should be disabled for this purchase order.

Response

The purchase order has been created successfully.

Creates a new purchase order with item positions. - Response

purchaseOrderId
string<uuid>
required

Unique ID of the newly created purchase order.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"