curl --request PATCH \
--url http://localhost:3500/v1/agreements/{id}/price-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"id": "11111111-1111-4111-8111-111111111111",
"price": {
"type": "amount",
"amount": "130.00"
}
}
]
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
id: '11111111-1111-4111-8111-111111111111',
price: {type: 'amount', amount: '130.00'}
}
])
};
fetch('http://localhost:3500/v1/agreements/{id}/price-items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/agreements/{id}/price-items"
payload = [
{
"id": "11111111-1111-4111-8111-111111111111",
"price": {
"type": "amount",
"amount": "130.00"
}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"description": "<string>",
"product_code": "<string>",
"product_group": "<string>",
"unit": "<string>",
"currency_code": "<string>",
"price": {
"type": "amount",
"amount": "<string>"
},
"discount_rate": "<string>",
"surcharge_rate": "<string>",
"vat_rate": "<string>",
"applicability": "<string>",
"calculation_rules": "<string>",
"valid_from": "<string>",
"valid_until": "<string>",
"source": {
"price_import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Work is in progress, active-agreement requirements are unmet, the source is unavailable, or an idempotency key conflicts.",
"request_id": "req_example"
}
}{
"error": {
"code": "precondition_failed",
"message": "The resource changed since the supplied ETag was read.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Edit agreement prices
Atomically edit 1–100 prices using an array of objects containing id and changed fields. IDs must be unique and belong to this agreement. Omitted fields are preserved; null clears nullable fields; price replaces the entire amount/rate variant. Returns items in request order. Retains prior evidence and advances agreement freshness once per semantic batch.
curl --request PATCH \
--url http://localhost:3500/v1/agreements/{id}/price-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"id": "11111111-1111-4111-8111-111111111111",
"price": {
"type": "amount",
"amount": "130.00"
}
}
]
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
id: '11111111-1111-4111-8111-111111111111',
price: {type: 'amount', amount: '130.00'}
}
])
};
fetch('http://localhost:3500/v1/agreements/{id}/price-items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/agreements/{id}/price-items"
payload = [
{
"id": "11111111-1111-4111-8111-111111111111",
"price": {
"type": "amount",
"amount": "130.00"
}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"description": "<string>",
"product_code": "<string>",
"product_group": "<string>",
"unit": "<string>",
"currency_code": "<string>",
"price": {
"type": "amount",
"amount": "<string>"
},
"discount_rate": "<string>",
"surcharge_rate": "<string>",
"vat_rate": "<string>",
"applicability": "<string>",
"calculation_rules": "<string>",
"valid_from": "<string>",
"valid_until": "<string>",
"source": {
"price_import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Work is in progress, active-agreement requirements are unmet, the source is unavailable, or an idempotency key conflicts.",
"request_id": "req_example"
}
}{
"error": {
"code": "precondition_failed",
"message": "The resource changed since the supplied ETag was read.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
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.
Optional ETag from any unfiltered page of this price collection, or the preceding collection PATCH. Covers all prices, including later pages. A stale, filtered-page, or individual-item validator returns 412.
1 - 4096Path Parameters
Body
1 - 100 elements- Option 1
- Option 2
Show child attributes
Show child attributes
20000200002000020000^[A-Z]{3}$100^-?\d+(?:\.\d+)?$100^-?\d+(?:\.\d+)?$100^-?\d+(?:\.\d+)?$2000020000^\d{4}-\d{2}-\d{2}$^\d{4}-\d{2}-\d{2}$1 <= x <= 2147483647Response
Price items in request order. ETag is the updated full collection validator for the next bulk edit.
- Option 1
- Option 2
Show child attributes
Show child attributes
100^-?\d+(?:\.\d+)?$100^-?\d+(?:\.\d+)?$100^-?\d+(?:\.\d+)?$^\d{4}-\d{2}-\d{2}$^\d{4}-\d{2}-\d{2}$The price import that created this price and the Document it read. Null for prices created otherwise.
Show child attributes
Show child attributes