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

List variance report

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/variance \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "items": [
    {
      "adjustmentsApplied": "200.00",
      "currency": "USD",
      "feeScheduleId": "550e8400-e29b-41d4-a716-446655440001",
      "feeScheduleName": "INTERCHANGE",
      "netVariance": "-200.00",
      "outstandingVariance": "0.00",
      "sourceId": "550e8400-e29b-41d4-a716-446655440000",
      "totalActual": "4800.00",
      "totalExpected": "5000.00",
      "variancePct": "-4.00"
    }
  ],
  "pagination": {
    "next": "<string>",
    "prev": "<string>"
  },
  "unattributedAdjustments": [
    {
      "currency": "USD",
      "total": "3.50"
    }
  ]
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

Parámetros de consulta

date_from · string<date>

Start date (YYYY-MM-DD) Start date (YYYY-MM-DD), inclusive. Optional: defaults to 30 days before date_to. Window may not exceed 90 days.

date_to · string<date>

End date (YYYY-MM-DD) End date (YYYY-MM-DD), inclusive. Optional: defaults to tomorrow (UTC). Window may not exceed 90 days.

source_id · string<uuid>

Source ID filter

cursor · string

The cursor value for retrieving the next page of results. Cursor for pagination (opaque)

limit · integer<int64> · predeterminado: 20

The maximum number of items to include in the response. Maximum number of records to return

Rango requerido: 1 <= x <= 200

sort_order · enum<string> · predeterminado: desc

Sort order by date Sort order for created_at (asc or desc; defaults to desc)

Opciones disponibles: asc, desc

Respuesta

200

application/json

Paginated variance analysis report

items · object[] | null · requerido

Variance report rows in the current page.

Show child attributes

pagination · object · requerido

Show child attributes

unattributedAdjustments · object[] · requerido

Per-currency totals of the window's recorded adjustments that no row includes, sorted by currency. They sit outside items and must not be added to any row; the list is identical on every page of one query, and empty when there are none.

Show child attributes