Skip to main content
Get an invoice's 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.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string[]

Return only these fields; use dots for nested fields, such as alerts.status. Fields: alerts, checks, check_progress.

Response

The invoice's alerts, checks and check progress.

alerts
object
required
checks
object[]
required

One entry per check type, limited to the same scope as alerts.

check_progress
enum<string>
required

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