v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

Select exception ids by filter

Resolves the ids of every exception matching the SAME filter as GET /v1/exceptions (status, severity, contextId, reason, assigned_to, external_system, search, date_from, date_to, min_age_days), up to a cap of 10000, for the bulk "select all matching" path. The response carries the filtered total and a truncated flag; the client chunks the returned ids into the capped bulk-action calls. No pagination/sort: it returns the whole filtered set (capped).

get/v1/exceptions/ids

Query parameters

contextIdstring uuid

Filter by reconciliation context ID (UUID, verified against the tenant; 404 when unknown)

Example:550e8400-e29b-41d4-a716-446655440000

Filter by reconciliation context ID (UUID, verified against the tenant; 404 when unknown)

status'OPEN' | 'ASSIGNED' | 'RESOLVED'

Filter by status

Filter by status

severity'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'

Filter by severity

Filter by severity

reason'UNMATCHED' | 'FX_RATE_UNAVAILABLE' | 'MISSING_BASE_AMOUNT' | 'MISSING_BASE_CURRENCY' | 'SPLIT_INCOMPLETE' | 'VALIDATION_FAILED' | 'SOURCE_MISMATCH' | 'DUPLICATE_TRANSACTION' | 'FEE_VARIANCE' | 'FEE_DATA_MISSING' | 'FEE_CURRENCY_MISMATCH' | 'FX_RATE_VARIANCE' | 'AGED_BREAK' | 'OVER_SETTLED'

Filter by exception reason

Filter by exception reason

assigned_tostring

Filter by assigned user

Example:user@example.com

Filter by assigned user

external_systemstring

Filter by external system

Example:JIRA

Filter by external system

searchstring

Free-text search across transaction id, reason, and external issue id (case-insensitive substring match)

Free-text search across transaction id, reason, and external issue id (case-insensitive substring match)

date_fromstring

Filter from date, inclusive lower bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date is taken at 00:00:00 UTC

Example:2025-01-01T00:00:00Z

Filter from date, inclusive lower bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date is taken at 00:00:00 UTC

date_tostring

Filter to date, inclusive upper bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date covers the whole day through 23:59:59.999999999 UTC

Example:2025-01-31T23:59:59Z

Filter to date, inclusive upper bound. Accepts an RFC 3339 timestamp or a bare date (YYYY-MM-DD); a bare date covers the whole day through 23:59:59.999999999 UTC

min_age_daysinteger

Filter to exceptions at least this many days old (by created_at). 0 (default) disables the filter.

Example:30

Filter to exceptions at least this many days old (by created_at). 0 (default) disables the filter.

Response

OK

idsstring[] nullable required

Exception ids matching the filter, deterministically ordered (created_at DESC, id DESC), capped at 10000

totalinteger required

Total exceptions matching the filter (full set; may exceed the returned ids)

truncatedboolean required

True when the filtered set exceeds the returned ids (the cap was reached); a single bulk pass will not cover every match

Example response

{
  "total": 530
}