Skip to main content
Preview a purchase order

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
agreement_id
string<uuid> | null
required

The agreement to check against; null to get suggested agreements instead.

supplier_id
string<uuid> | null
required
buyer_id
string<uuid> | null
required

The recipient that placed the order (Peppol buyer). Send company_id instead unless the order names another of the company's recipients.

currency_code
string | null
required
Pattern: ^[A-Z]{3}$
issued_date
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
valid_from
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
valid_until
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
contract_reference
string | null
required
Maximum string length: 200
line_items
object[]
required

Keyed by position in the check.

Maximum array length: 1000
company_id
string<uuid> | null

The company placing the order; its own recipient is the buyer when buyer_id is null. Left out or null, the buyer's company.

Response

The preview.

agreement_check
object
required