Skip to main content
Get claim and recovery totals

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, counts, recovery_summary, summary.

view_ids
string[]
supplier_ids
string<uuid>[]
agreement_ids
string<uuid>[]
company_ids
string<uuid>[]

A company scope: claims holding alerts or credit notes of these companies, and claims still without either. A claim may span the companies its agreement covers: totals then count only these companies’ part, and a claim that also holds other companies reads as is_partial, without recovery_summary.

statuses
enum<string>[]
Available options:
pending,
in_progress,
completed,
cancelled
creator_user_ids
string[]
Required string length: 1 - 200

Claim title or supplier name.

Required string length: 1 - 200
created_from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
created_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$
recovered_from
string

Date a recovery was recorded. Keeps only claims with such a recovery, and recovery_summary counts only those recoveries.

Pattern: ^\d{4}-\d{2}-\d{2}$
recovered_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$
not
enum<string>[]

List filters to invert.

Available options:
supplier_ids,
agreement_ids,
statuses,
creator_user_ids

Response

Claim counts and amounts per currency.

total_count
integer
required
counts
object
required
recovery_summary
object
required

Recoveries recorded on the claims: the money recovered, per recovery currency. When a list or totals read sets recovered_from or recovered_through, only recoveries recorded in that window.

summary
object
required