Create an alert
curl --request POST \
--url https://api-canary.watchdog.no/v1/alerts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invoice_id": "6f1d2c1e-8b6a-4a51-9d7e-2f0c7b1f4a10",
"agreement_id": "b3f4c2d1-0a9e-4c6b-8f7d-5e4a3b2c1d0e",
"title": "Order size discount not applied"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_id: '6f1d2c1e-8b6a-4a51-9d7e-2f0c7b1f4a10',
agreement_id: 'b3f4c2d1-0a9e-4c6b-8f7d-5e4a3b2c1d0e',
title: 'Order size discount not applied'
})
};
fetch('https://api-canary.watchdog.no/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-canary.watchdog.no/v1/alerts"
payload = {
"invoice_id": "6f1d2c1e-8b6a-4a51-9d7e-2f0c7b1f4a10",
"agreement_id": "b3f4c2d1-0a9e-4c6b-8f7d-5e4a3b2c1d0e",
"title": "Order size discount not applied"
}
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",
"title": "<string>",
"explanation": "<string>",
"verdict": "pending",
"credit": {
"at": "2023-11-07T05:31:56Z",
"source": "credit_note",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"correction_type": "modify_item",
"confidence": {
"level": "high",
"reason": "<string>"
},
"impact_amount": "<string>",
"currency_code": "<string>",
"organization_currency": {
"currency_code": "<string>",
"impact_amount": "<string>"
},
"freshness": "current",
"invalidation": {
"at": "2023-11-07T05:31:56Z",
"reason": "unmatched"
},
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"due_date": "2023-12-25",
"currency_code": "<string>",
"total_amount_including_vat": "<string>"
},
"invoice_item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_number": 123,
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "draft",
"version": 123
},
"supplier": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"recipient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"topic": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"is_locked": true
},
"claim": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "pending"
},
"dismissal": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "wrong_alert",
"note": "<string>",
"dismissed_at": "2023-11-07T05:31:56Z",
"dismissed_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
},
"provenance": {
"origin": "check",
"created_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"agreement_version": 123,
"invoice_fingerprint": "<string>",
"retained_check": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"correction_relationships": [
{
"replacement_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replaced_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"correction_relationships_truncated": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"questions": [
"<string>"
],
"price_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"expected": {
"base_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"adjustment_uplift": "<string>",
"net_price": "<string>",
"total": "<string>",
"price_explanation": "<string>",
"adjustment_explanation": "<string>",
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"invoiced": {
"base_price": "<string>",
"net_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"total": "<string>"
},
"evidence": {
"citations": [
{
"source_ref": 123,
"citation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"quote": "<string>",
"text": "<string>",
"verification": "verified",
"verification_score": 123,
"available": true,
"source_type": "document",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"page": "<string>",
"section_title": "<string>",
"context_before": "<string>",
"context_after": "<string>",
"original_quote": "<string>"
}
],
"truncated": true
}
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"explanation": "<string>",
"verdict": "pending",
"credit": {
"at": "2023-11-07T05:31:56Z",
"source": "credit_note",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"correction_type": "modify_item",
"confidence": {
"level": "high",
"reason": "<string>"
},
"impact_amount": "<string>",
"currency_code": "<string>",
"organization_currency": {
"currency_code": "<string>",
"impact_amount": "<string>"
},
"freshness": "current",
"invalidation": {
"at": "2023-11-07T05:31:56Z",
"reason": "unmatched"
},
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"due_date": "2023-12-25",
"currency_code": "<string>",
"total_amount_including_vat": "<string>"
},
"invoice_item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_number": 123,
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "draft",
"version": 123
},
"supplier": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"recipient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"topic": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"is_locked": true
},
"claim": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "pending"
},
"dismissal": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "wrong_alert",
"note": "<string>",
"dismissed_at": "2023-11-07T05:31:56Z",
"dismissed_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
},
"provenance": {
"origin": "check",
"created_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"agreement_version": 123,
"invoice_fingerprint": "<string>",
"retained_check": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"correction_relationships": [
{
"replacement_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replaced_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"correction_relationships_truncated": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"questions": [
"<string>"
],
"price_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"expected": {
"base_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"adjustment_uplift": "<string>",
"net_price": "<string>",
"total": "<string>",
"price_explanation": "<string>",
"adjustment_explanation": "<string>",
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"invoiced": {
"base_price": "<string>",
"net_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"total": "<string>"
},
"evidence": {
"citations": [
{
"source_ref": 123,
"citation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"quote": "<string>",
"text": "<string>",
"verification": "verified",
"verification_score": 123,
"available": true,
"source_type": "document",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"page": "<string>",
"section_title": "<string>",
"context_before": "<string>",
"context_after": "<string>",
"original_quote": "<string>"
}
],
"truncated": true
}
}{
"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": "The invoice is not matched to the agreement or lacks a supplier or currency, the topic belongs to another agreement, or the Idempotency-Key was used with different input.",
"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"
}
}Alerts
Create an alert
Records a finding on an invoice, against an agreement the invoice is matched to. The alert counts, groups and can be claimed like any other; re-checks and check resets keep it. Without topic_id, the agreement’s topics are reconciled so it gets grouped. Repeating the request with the same Idempotency-Key returns the original alert with 200.
Create an alert
curl --request POST \
--url https://api-canary.watchdog.no/v1/alerts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invoice_id": "6f1d2c1e-8b6a-4a51-9d7e-2f0c7b1f4a10",
"agreement_id": "b3f4c2d1-0a9e-4c6b-8f7d-5e4a3b2c1d0e",
"title": "Order size discount not applied"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invoice_id: '6f1d2c1e-8b6a-4a51-9d7e-2f0c7b1f4a10',
agreement_id: 'b3f4c2d1-0a9e-4c6b-8f7d-5e4a3b2c1d0e',
title: 'Order size discount not applied'
})
};
fetch('https://api-canary.watchdog.no/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-canary.watchdog.no/v1/alerts"
payload = {
"invoice_id": "6f1d2c1e-8b6a-4a51-9d7e-2f0c7b1f4a10",
"agreement_id": "b3f4c2d1-0a9e-4c6b-8f7d-5e4a3b2c1d0e",
"title": "Order size discount not applied"
}
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",
"title": "<string>",
"explanation": "<string>",
"verdict": "pending",
"credit": {
"at": "2023-11-07T05:31:56Z",
"source": "credit_note",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"correction_type": "modify_item",
"confidence": {
"level": "high",
"reason": "<string>"
},
"impact_amount": "<string>",
"currency_code": "<string>",
"organization_currency": {
"currency_code": "<string>",
"impact_amount": "<string>"
},
"freshness": "current",
"invalidation": {
"at": "2023-11-07T05:31:56Z",
"reason": "unmatched"
},
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"due_date": "2023-12-25",
"currency_code": "<string>",
"total_amount_including_vat": "<string>"
},
"invoice_item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_number": 123,
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "draft",
"version": 123
},
"supplier": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"recipient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"topic": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"is_locked": true
},
"claim": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "pending"
},
"dismissal": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "wrong_alert",
"note": "<string>",
"dismissed_at": "2023-11-07T05:31:56Z",
"dismissed_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
},
"provenance": {
"origin": "check",
"created_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"agreement_version": 123,
"invoice_fingerprint": "<string>",
"retained_check": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"correction_relationships": [
{
"replacement_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replaced_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"correction_relationships_truncated": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"questions": [
"<string>"
],
"price_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"expected": {
"base_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"adjustment_uplift": "<string>",
"net_price": "<string>",
"total": "<string>",
"price_explanation": "<string>",
"adjustment_explanation": "<string>",
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"invoiced": {
"base_price": "<string>",
"net_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"total": "<string>"
},
"evidence": {
"citations": [
{
"source_ref": 123,
"citation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"quote": "<string>",
"text": "<string>",
"verification": "verified",
"verification_score": 123,
"available": true,
"source_type": "document",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"page": "<string>",
"section_title": "<string>",
"context_before": "<string>",
"context_after": "<string>",
"original_quote": "<string>"
}
],
"truncated": true
}
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"explanation": "<string>",
"verdict": "pending",
"credit": {
"at": "2023-11-07T05:31:56Z",
"source": "credit_note",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"correction_type": "modify_item",
"confidence": {
"level": "high",
"reason": "<string>"
},
"impact_amount": "<string>",
"currency_code": "<string>",
"organization_currency": {
"currency_code": "<string>",
"impact_amount": "<string>"
},
"freshness": "current",
"invalidation": {
"at": "2023-11-07T05:31:56Z",
"reason": "unmatched"
},
"invoice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"due_date": "2023-12-25",
"currency_code": "<string>",
"total_amount_including_vat": "<string>"
},
"invoice_item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_number": 123,
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "draft",
"version": 123
},
"supplier": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"recipient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"topic": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"is_locked": true
},
"claim": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "pending"
},
"dismissal": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "wrong_alert",
"note": "<string>",
"dismissed_at": "2023-11-07T05:31:56Z",
"dismissed_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
},
"provenance": {
"origin": "check",
"created_by": {
"user": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"agreement_version": 123,
"invoice_fingerprint": "<string>",
"retained_check": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"correction_relationships": [
{
"replacement_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replaced_alert_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"correction_relationships_truncated": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"questions": [
"<string>"
],
"price_item_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"expected": {
"base_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"adjustment_uplift": "<string>",
"net_price": "<string>",
"total": "<string>",
"price_explanation": "<string>",
"adjustment_explanation": "<string>",
"product_code": "<string>",
"description": "<string>",
"unit": "<string>"
},
"invoiced": {
"base_price": "<string>",
"net_price": "<string>",
"quantity": "<string>",
"discount": "<string>",
"surcharge": "<string>",
"total": "<string>"
},
"evidence": {
"citations": [
{
"source_ref": 123,
"citation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"quote": "<string>",
"text": "<string>",
"verification": "verified",
"verification_score": 123,
"available": true,
"source_type": "document",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"page": "<string>",
"section_title": "<string>",
"context_before": "<string>",
"context_after": "<string>",
"original_quote": "<string>"
}
],
"truncated": true
}
}{
"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": "The invoice is not matched to the agreement or lacks a supplier or currency, the topic belongs to another agreement, or the Idempotency-Key was used with different input.",
"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 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.
Required string length:
1 - 200Pattern:
^[\x21-\x7e]+$Body
application/json
The agreement the finding is about. The invoice must be matched to it.
Required string length:
1 - 500The invoice line the finding is about. Required for modify_item, and only then.
modify_item: a billed line is wrong. add_item: a line is missing. modify_invoice: the finding concerns the whole invoice. Defaults to modify_item with an invoice_item_id and modify_invoice without.
Available options:
modify_item, modify_invoice, add_item Maximum string length:
20000The amount the invoice is wrong by, in the invoice currency: positive when it charges more than agreed. Omit it on a line or missing-line alert to calculate it from expected pricing; an invoice-level alert has no line to compare with, so send it there.
Maximum string length:
100Pattern:
^-?\d+(?:\.\d+)?$Show child attributes
Show child attributes
Maximum array length:
50Maximum string length:
2000Show child attributes
Show child attributes
Sources for the finding, numbered by source_ref. Inline markers such as [1] in the text refer to them. Each citation is a new source or an existing citation id.
Maximum array length:
100Show child attributes
Show child attributes
A topic of the same agreement to put the alert in. Without one, the agreement's topics are reconciled so the alert gets grouped.
Response
The alert.
The decision on the finding, independent of claim membership and credit.
Available options:
pending, accepted, dismissed Supplier credit, independent of the verdict and claim.
Show child attributes
Show child attributes
Available options:
modify_item, modify_invoice, add_item Show child attributes
Show child attributes
Pattern:
^-?\d+(?:\.\d+)?$The impact converted with the rate stored on the alert.
Show child attributes
Show child attributes
Available options:
current, outdated, unknown Set when the alert no longer counts, for example because its invoice no longer matches the agreement. It keeps its verdict, credit and claim, and counts again if the invoice matches again.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The current invoice line. Null when no line is linked.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The claim this alert is currently attached to, if any.
Show child attributes
Show child attributes
Why the alert was dismissed, while its verdict is dismissed, credited or not. Dismiss it again with a different category or note to change the reason. Reopening or accepting clears it; the alert activity keeps the history.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Links between an added-item alert and the line alerts it replaces.
Maximum array length:
100Show child attributes
Show child attributes
Agreement prices the alert relies on. Read them with GET /v1/agreements/{id}/price-items?ids=.
Show child attributes
Show child attributes
Invoiced pricing when the alert was created.
Show child attributes
Show child attributes
Show child attributes
Show child attributes