v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Reporting

List variance report

Use this endpoint to retrieve a paginated variance analysis report for a specific context and date range. The response uses cursor-based pagination.

get/v1/reports/contexts/{contextId}/variance

Path parameters

contextIdstring uuid required

The unique identifier of the reconciliation context.

Query parameters

date_fromstring date required

Start date (YYYY-MM-DD)

date_tostring date required

End date (YYYY-MM-DD)

source_idstring

Source ID filter

cursorstring

The cursor value for retrieving the next page of results.

limitinteger

The maximum number of items to include in the response.

sort_order'asc' | 'desc'

Sort order by date

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Paginated variance analysis report

Example response

{
  "items": [
    {
      "feeScheduleId": "550e8400-e29b-41d4-a716-446655440001",
      "feeScheduleName": "INTERCHANGE"
    }
  ],
  "pagination": {
    "next": "eyJpZCI6IjEyMyIsImRpcmVjdGlvbiI6Im5leHQifQ==",
    "prev": "eyJpZCI6IjEyMiIsImRpcmVjdGlvbiI6InByZXYifQ=="
  }
}