Skip to main content
Preview a purchase order's references

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
owner_user_id
string | null
required

The owner; null for the caller, as on create.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
agreement_id
string<uuid> | null
required
dimension_value_ids
string<uuid>[]
required

Where the order's cost is booked: dimension values of its company (listDimensionValues), at most one per dimension; the buyer gives the company. Each line takes them, except where it holds its own value for that dimension, and invoices billing the order take them as coding suggestions. Not a term: changing it records no revision. Replaced whole; [] removes them.

Maximum array length: 50

Response

The references.

buyer_reference
string | null
required

The owner's name.

contract_reference
string | null
required

The agreement's number.

project_reference
string | null
required

The code of the dimension value of a project dimension.