Skip to main content
Edit 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.

If-Match
string

Optional ETag from your last read or edit. If the resource changed since, the request fails with 412 and nothing changes.

Required string length: 1 - 4096

Path Parameters

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

Body

application/json
price
object
description
string | null
Maximum string length: 20000
product_code
string | null
Maximum string length: 20000
product_group
string | null
Maximum string length: 20000
unit
string | null
Maximum string length: 20000
currency_code
string | null
Pattern: ^[A-Z]{3}$
discount_rate
string | null
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
surcharge_rate
string | null
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
vat_rate
string | null
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
applicability
string | null
Maximum string length: 20000
calculation_rules
string | null
Maximum string length: 20000
valid_from
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
valid_until
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
position
integer
Required range: 1 <= x <= 2147483647

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