Skip to main content
Reset compliance checks

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.

Body

application/json
scope
object
required

agreements: agreement_ids, or every agreement filter matches (the whole collection, not a page), minus excluded_agreement_ids; at most 1,000. topics: the invoices behind some topics of one agreement, include_uncategorized adding its alerts without a topic; a pair is handled as a whole, so its alerts in other topics change too (other_topic_alert_count).

invoices
object

Which of the scope’s invoices to take: all (minus exclusions), a sample of ten, or a hand-picked set.

issued_from
string<date>

Only invoices issued on or after this date.

issued_through
string<date>

Only invoices issued on or before this date.

company_ids
string<uuid>[]

Only these workspace companies: their invoices under agreements covering them, as for a member with access to just those companies. Omit for every company the caller can access. An unknown or inaccessible company is 404.

Required array length: 1 - 1000 elements
preview
boolean
default:false

true: return what the command would do and its fingerprint, changing nothing.

fingerprint
string

The fingerprint of a preview. When sent, the command runs only if the selection still resolves to exactly what was previewed; omit it to act on the current state.

Required string length: 64

Response

With preview: true, what a reset would change (CheckResetPreview). Otherwise what the reset changed (CheckReset).

fingerprint
string
required
invoice_count
integer
required

Invoices with a pair in scope.

pair_count
integer
required

Invoice–agreement pairs in scope.

deletable_alert_count
integer
required

Alerts the reset would delete.

kept_alert_count
integer
required

Alerts the reset would keep because a claim holds their pair.

cancelled_check_count
integer
required

Unfinished checks the reset would cancel.

other_topic_alert_count
integer
required

Deleted alerts that belong to topics outside a topic scope.

exceeds_limit
boolean
required
maximum_pairs
integer
required