Skip to main content
List an agreement's prices as purchase order lines

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.

Query Parameters

fields
string[]

Return only these fields of each row. Fields: agreement_price_item_id, name, product_code, unit, currency_code, unit_price, applicability, has_calculation_rules.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
agreement_id
string<uuid>
required

The agreement whose prices to list.

currency_code
string
required

The order’s currency. Prices in another currency are left out.

Pattern: ^[A-Z]{3}$
valid_on
string
required

The order’s date. Prices outside their own validity or the agreement’s term on this day are left out.

Pattern: ^\d{4}-\d{2}-\d{2}$
Required string length: 1 - 200

Response

Prices in the agreement’s order, narrowed by search.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required