Get an invoice's checks
curl --request GET \
--url https://api.watchdog.no/v1/invoices/{id}/checks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/invoices/{id}/checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/invoices/{id}/checks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"alerts": {
"status": "credited",
"check_status": "not_checkable",
"open_alert_count": 1,
"counts": {
"pending": {
"credited": 1,
"uncredited": 1
},
"accepted": {
"credited": 1,
"uncredited": 1
},
"dismissed": {
"credited": 1,
"uncredited": 1
},
"skipped": {
"credited": 1,
"uncredited": 1
}
},
"replaceable_alert_count": 1,
"agreements": {
"total": 1,
"checked": 1
},
"scope": {
"type": "invoice",
"agreement_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"has_hidden_alerts": true
},
"checks": [
{
"check_type": "agreement",
"status": "not_started",
"reason": "matching",
"open_alert_count": 1,
"review_alert_count": 1,
"complete": true
}
],
"check_progress": "running"
}{
"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": "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"
}
}Invoices
Get an invoice's checks
The invoice’s alerts by verdict, one entry per check type and whether its checks have settled: what getInvoice returns of them, without the rest of the invoice.
Get an invoice's checks
curl --request GET \
--url https://api.watchdog.no/v1/invoices/{id}/checks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/invoices/{id}/checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/invoices/{id}/checks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"alerts": {
"status": "credited",
"check_status": "not_checkable",
"open_alert_count": 1,
"counts": {
"pending": {
"credited": 1,
"uncredited": 1
},
"accepted": {
"credited": 1,
"uncredited": 1
},
"dismissed": {
"credited": 1,
"uncredited": 1
},
"skipped": {
"credited": 1,
"uncredited": 1
}
},
"replaceable_alert_count": 1,
"agreements": {
"total": 1,
"checked": 1
},
"scope": {
"type": "invoice",
"agreement_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"has_hidden_alerts": true
},
"checks": [
{
"check_type": "agreement",
"status": "not_started",
"reason": "matching",
"open_alert_count": 1,
"review_alert_count": 1,
"complete": true
}
],
"check_progress": "running"
}{
"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": "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
Headers
Query Parameters
Response
The invoice's alerts, checks and check progress.
Whether the invoice's checks have settled. running: a background run (also one waiting for its sync or batch) or a check is in progress; failed: a background run or a check failed and waits for its automatic retry or a person; settled: neither. Poll it after a change, then read alerts and checks. Approving one invoice is allowed either way and its activity records this; bulk approval skips unsettled invoices.
Available options:
running, failed, settled