Skip to main content
Total alert amounts, overall or per supplier, agreement, topic or month

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.

Query Parameters

fields
string[]

Return only these fields; use dots for nested fields, such as counts.pending. Fields: total_count, invoice_count, counts, currencies, organization_currency, groups, next_cursor.

view_ids
string[]
claim_ids
string[]
has_claim
boolean

Attached to a claim now.

claim_statuses
enum<string>[]

Of the current claim.

Available options:
pending,
in_progress,
completed,
cancelled
invoice_ids
string<uuid>[]
company_ids
string<uuid>[]

Alerts on invoices of these workspace companies: a company scope, applied to every alert whatever join_operator says.

agreement_ids
string<uuid>[]
purchase_order_ids
string<uuid>[]

Alerts of purchase-order checks against these orders.

agreement_statuses
enum<string>[]
Available options:
draft,
active,
archived
supplier_ids
string<uuid>[]
recipient_ids
string<uuid>[]
tag_ids
string<uuid>[]

Tags of the agreement.

topic_ids
string[]
has_topic
boolean
check_types
enum<string>[]
Available options:
agreement,
purchase_order,
duplicate
verdicts
enum<string>[]

Whatever the credit. pending: to review; accepted: confirmed; dismissed: false alarm; skipped: unsure. Reviewed: all but pending.

Available options:
pending,
accepted,
dismissed,
skipped
credited
boolean

Whatever the verdict.

confidence_levels
enum<string>[]
Available options:
certain,
uncertain,
null
currency_codes
string[]
Pattern: ^[A-Z]{3}$
correction_types
enum<string>[]
Available options:
modify_item,
modify_invoice,
add_item
agreement_version_status
enum<string>

The alert assessed the current agreement version or an older one; an unknown version or no agreement matches neither.

Available options:
current,
older
validity
enum<string>

live (default): alerts that count; invalidated: those that stopped (invalidation.reason says why). Alerts in claims named by claim_ids are included either way.

Available options:
live,
invalidated,
all
impact_min
string

Impact in the organization currency, inclusive. Alerts without one never match.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
impact_max
string
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
issued_from
string

Invoice issue date.

Pattern: ^\d{4}-\d{2}-\d{2}$
issued_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$
created_from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
created_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$

Alert, invoice, supplier, agreement and topic text. A UUID matches the alert, invoice, supplier or agreement ID.

Required string length: 1 - 200
join_operator
enum<string>

or combines only the invoice, agreement, supplier, recipient and topic IDs.

Available options:
and,
or
not
enum<string>[]

List filters to invert.

Available options:
claim_ids,
claim_statuses,
invoice_ids,
agreement_ids,
purchase_order_ids,
agreement_statuses,
supplier_ids,
recipient_ids,
tag_ids,
topic_ids,
check_types,
verdicts,
confidence_levels,
currency_codes,
correction_types
include_invoice_count
boolean
default:false

Also count distinct invoices. Slower on large selections.

group_by
enum<string>

Also return the totals per agreement, supplier, topic, claim, verdict or invoice issue month in groups, one page at a time.

Available options:
agreement,
supplier,
topic,
claim,
verdict,
month
limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
sort
enum<string>
default:impact_amount

Group order, with group_by. impact_amount sorts by organization-currency impact. pending_accepted_impact_amount sorts by the organization-currency impact of the alerts to review or confirmed, credited or not (by_verdict pending plus accepted), so false alarms and unsure alerts add nothing. key sorts by the group key, so months in calendar order.

Available options:
impact_amount,
pending_accepted_impact_amount,
total_count,
title,
key
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

Alert counts and amounts per currency and in the organization currency, for the same filters as the alert list, and with group_by a page of groups.

total_count
integer
required
invoice_count
integer | null
required

Distinct invoices among the matching alerts. Null unless include_invoice_count is true.

counts
object
required

Alerts by verdict, each split into credited and uncredited alerts.

currencies
object[]
required
organization_currency
object
required

Impact in the organization currency: the sum of the alerts’ converted impacts.

groups
object[]

With group_by: a page of groups, each with the same totals for its alerts.

next_cursor
string | null

With group_by: the cursor for the next page of groups; null at the end.