curl --request POST \
--url http://localhost:3500/v1/agreements/{id}/price-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"description": "Support hour",
"unit": "hour",
"currency_code": "NOK",
"price": {
"type": "amount",
"amount": "125.50"
},
"vat_rate": "0.25"
},
{
"description": "Service fee",
"price": {
"type": "rate",
"fraction": "0.075",
"basis": "invoice subtotal"
}
}
]
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
description: 'Support hour',
unit: 'hour',
currency_code: 'NOK',
price: {type: 'amount', amount: '125.50'},
vat_rate: '0.25'
},
{
description: 'Service fee',
price: {type: 'rate', fraction: '0.075', basis: 'invoice subtotal'}
}
])
};
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 = [
{
"description": "Support hour",
"unit": "hour",
"currency_code": "NOK",
"price": {
"type": "amount",
"amount": "125.50"
},
"vat_rate": "0.25"
},
{
"description": "Service fee",
"price": {
"type": "rate",
"fraction": "0.075",
"basis": "invoice subtotal"
}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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"
}
][
{
"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"
}
}Add agreement prices
Create 1–100 prices atomically from a JSON array, including an array of one for a single price. Amounts and rates use exact decimal strings. Positions start at one and default to appending in request order. Returns the created items in request order. Idempotency-Key replays the complete request; no workflows start.
curl --request POST \
--url http://localhost:3500/v1/agreements/{id}/price-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"description": "Support hour",
"unit": "hour",
"currency_code": "NOK",
"price": {
"type": "amount",
"amount": "125.50"
},
"vat_rate": "0.25"
},
{
"description": "Service fee",
"price": {
"type": "rate",
"fraction": "0.075",
"basis": "invoice subtotal"
}
}
]
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
description: 'Support hour',
unit: 'hour',
currency_code: 'NOK',
price: {type: 'amount', amount: '125.50'},
vat_rate: '0.25'
},
{
description: 'Service fee',
price: {type: 'rate', fraction: '0.075', basis: 'invoice subtotal'}
}
])
};
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 = [
{
"description": "Support hour",
"unit": "hour",
"currency_code": "NOK",
"price": {
"type": "amount",
"amount": "125.50"
},
"vat_rate": "0.25"
},
{
"description": "Service fee",
"price": {
"type": "rate",
"fraction": "0.075",
"basis": "invoice subtotal"
}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(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"
}
][
{
"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 protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.
1 - 200^[\x21-\x7e]+$Path 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. Read an individual item to obtain its ETag.
- 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