Skip to main content
Get an agreement price

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.

Path Parameters

id
string<uuid>
required
item_id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as source.price_import_id. id is always returned. Fields: id, agreement_id, position, description, product_code, product_group, unit, currency_code, price, discount_rate, surcharge_rate, vat_rate, applicability, calculation_rules, valid_from, valid_until, source, created_at, updated_at.

Response

The resource.

id
string<uuid>
required
agreement_id
string<uuid>
required
position
integer
required
description
string | null
required
product_code
string | null
required
product_group
string | null
required
unit
string | null
required
currency_code
string | null
required
price
object
required
discount_rate
string | null
required
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
surcharge_rate
string | null
required
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
vat_rate
string | null
required
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
applicability
string | null
required
calculation_rules
string | null
required
valid_from
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
valid_until
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
source
object | null
required

The price import and document this price came from. Null for prices added by hand.

created_at
string<date-time>
required
updated_at
string<date-time>
required