Skip to main content
Edit an alert

Authorizations

Authorization
string
header
required

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

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

If-Match
string

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 - 4096

Path Parameters

id
string<uuid>
required

Body

application/json
citations
object
title
string
Required string length: 1 - 500
explanation
string | null
Maximum string length: 20000
questions
string[]
Maximum array length: 50
Maximum string length: 2000
impact_amount
string | null

The amount the invoice is wrong by, in the invoice currency: positive when it charges more than agreed. A change to expected pricing recalculates it unless you send it too.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
confidence
object
expected
object

Response

The alert.

id
string<uuid>
required
title
string | null
required
explanation
string | null
required
verdict
enum<string>
required

The decision on the finding, independent of claim membership and credit.

Available options:
pending,
accepted,
dismissed
credit
object | null
required

Supplier credit, independent of the verdict and claim.

correction_type
enum<string>
required
Available options:
modify_item,
modify_invoice,
add_item
confidence
object
required
questions
string[]
required

What Watchdog needs answered to decide the alert, mostly on uncertain alerts. Empty when nothing is open.

impact_amount
string | null
required
Pattern: ^-?\d+(?:\.\d+)?$
currency_code
string
required
organization_currency
object
required

The impact converted with the rate stored on the alert.

changed_since_check
object | null
required

Whether the agreement or the invoice changed after the check that found this alert. A change does not make the alert wrong; check again to assess it against the new inputs. Null for older alerts that do not record what they assessed.

invalidation
object | null
required

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.

invoice
object | null
required
invoice_item
object | null
required
read-only

The current invoice line. Null when no line is linked.

agreement
object | null
required
supplier
object | null
required
recipient
object | null
required
topic
object | null
required
claim
object | null
required

The claim this alert is currently attached to, if any.

dismissal
object | null
required

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.

provenance
object
required
correction_relationships
object[]
required

Links between an added-item alert and the line alerts it replaces.

Maximum array length: 100
correction_relationships_truncated
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
price_item_ids
string<uuid>[]
required

Agreement prices the alert relies on. Read them with GET /v1/agreements/{id}/price-items?ids=.

expected
object
required

The pricing the agreement gives for this line, as the check applied it. base_price is the agreed unit price before discount and surcharge; price_explanation says where it comes from.

invoiced
object
required
read-only

Invoiced pricing when the alert was created.

evidence
object
required