Edit an agreement price
curl --request PATCH \
--url https://api.watchdog.no/v1/agreements/{id}/price-items/{item_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.watchdog.no/v1/agreements/{id}/price-items/{item_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/agreements/{id}/price-items/{item_id}"
payload = {}
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>",
"mime_type": "<string>",
"worksheet": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"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": "Agreement work is in progress, an active agreement is missing a required field, the source document is unavailable, or the Idempotency-Key was reused with a different request.",
"request_id": "req_example"
}
}{
"error": {
"code": "precondition_failed",
"message": "The resource changed since the ETag in If-Match was read. Nothing changed; read it again and retry.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"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": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Prices
Edit an agreement price
Send only the fields to change. A supplied price replaces the whole amount or rate. Checks that used the old price become outdated.
Edit an agreement price
curl --request PATCH \
--url https://api.watchdog.no/v1/agreements/{id}/price-items/{item_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.watchdog.no/v1/agreements/{id}/price-items/{item_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/agreements/{id}/price-items/{item_id}"
payload = {}
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>",
"mime_type": "<string>",
"worksheet": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"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": "Agreement work is in progress, an active agreement is missing a required field, the source document is unavailable, or the Idempotency-Key was reused with a different request.",
"request_id": "req_example"
}
}{
"error": {
"code": "precondition_failed",
"message": "The resource changed since the ETag in If-Match was read. Nothing changed; read it again and retry.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"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": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Authorizations
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
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
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 - 4096Body
application/json
- Option 1
- Option 2
Show child attributes
Show child attributes
Maximum string length:
20000Maximum string length:
20000Maximum string length:
20000Maximum string length:
20000Pattern:
^[A-Z]{3}$Maximum string length:
100Pattern:
^-?\d+(?:\.\d+)?$Maximum string length:
100Pattern:
^-?\d+(?:\.\d+)?$Maximum string length:
100Pattern:
^-?\d+(?:\.\d+)?$Maximum string length:
20000Maximum string length:
20000Pattern:
^\d{4}-\d{2}-\d{2}$Pattern:
^\d{4}-\d{2}-\d{2}$Required range:
1 <= x <= 2147483647Response
The resource.
- Option 1
- Option 2
Show child attributes
Show child attributes
Maximum string length:
100Pattern:
^-?\d+(?:\.\d+)?$Maximum string length:
100Pattern:
^-?\d+(?:\.\d+)?$Maximum string length:
100Pattern:
^-?\d+(?:\.\d+)?$Pattern:
^\d{4}-\d{2}-\d{2}$Pattern:
^\d{4}-\d{2}-\d{2}$The price import and document this price came from. Null for prices added by hand.
Show child attributes
Show child attributes