Get reconciliation summary report

Use this endpoint to retrieve an aggregated reconciliation summary for a specific context and date range, including matched and unmatched counts and amounts.

GET /v1/reports/contexts/{contextId}/summary

Get reconciliation summary report

cURL

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

200

Example

{
  "matchedAmount": "1180000.00",
  "matchedCount": 11800,
  "totalAmount": "1250000.00",
  "unmatchedAmount": "70000.00",
  "unmatchedCount": 700
}

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

Respuesta

200

application/json

Aggregated reconciliation summary

matchedAmount · string · requerido

Total monetary value of matched transactions, as a decimal string.

Ejemplo:

"1180000.00"

matchedCount · integer<int64> · requerido

Number of matched transactions in the window.

Ejemplo:

11800

totalAmount · string · requerido

Total monetary value of all transactions, as a decimal string.

Ejemplo:

"1250000.00"

unmatchedAmount · string · requerido

Total monetary value of unmatched transactions, as a decimal string.

Ejemplo:

"70000.00"

unmatchedCount · integer<int64> · requerido

Number of unmatched transactions in the window.

Ejemplo:

700