Check an agreement's unchecked invoices
curl --request POST \
--url https://api.watchdog.no/v1/agreements/{id}/check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_checked": false,
"invoice_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
topic_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
include_checked: false,
invoice_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.watchdog.no/v1/agreements/{id}/check', 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}/check"
payload = {
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_checked": False,
"invoice_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_count": 1,
"skipped_count": 1
}{
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_count": 1,
"skipped_count": 1
}{
"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": "agreement_not_checkable",
"message": "agreement_not_checkable: the agreement is not active or not ready. conflict: the check ended before it started; try again.",
"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": "The check could not be confirmed as started. Read workflow_run_id, if returned, before retrying.",
"request_id": "req_example"
}
}Compliance checks
Check an agreement's unchecked invoices
Checks the agreement against all its matched invoices that were never checked, whose last check failed, or whose only check was cancelled. Invoices with a completed check are skipped unless include_checked is true; send topic_id with include_checked to recheck every invoice behind a topic’s alerts. Follow or cancel the returned workflow run.
Check an agreement's unchecked invoices
curl --request POST \
--url https://api.watchdog.no/v1/agreements/{id}/check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_checked": false,
"invoice_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
topic_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
include_checked: false,
invoice_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.watchdog.no/v1/agreements/{id}/check', 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}/check"
payload = {
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_checked": False,
"invoice_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_count": 1,
"skipped_count": 1
}{
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_count": 1,
"skipped_count": 1
}{
"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": "agreement_not_checkable",
"message": "agreement_not_checkable: the agreement is not active or not ready. conflict: the check ended before it started; try again.",
"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": "The check could not be confirmed as started. Read workflow_run_id, if returned, before retrying.",
"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.
Path Parameters
Body
application/json