Skip to main content
Edit an agreement price

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

if-match
string

Optional strong ETag from the individual resource GET. A stale validator returns 412.

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

Current 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 that created this price and the Document it read. Null for prices created otherwise.

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