Get cash impact summary

Use this endpoint to retrieve a cash impact summary showing the total unmatched financial exposure. Includes breakdowns by currency and by age bucket to help prioritize resolution efforts.

GET /v1/reports/contexts/{contextId}/dashboard/cash-impact

Get cash impact summary

cURL

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

200

Example

{
  "byAge": [
    {
      "amount": "10000.00",
      "bucket": "0-24h",
      "transactionCount": 120
    }
  ],
  "byCurrency": [
    {
      "amount": "25000.00",
      "currency": "USD",
      "transactionCount": 250
    }
  ],
  "totalUnmatchedAmount": "70000.00"
}

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

Cash impact summary with currency and age breakdowns

byAge · object[] | null · requerido

Unreconciled exposure broken down by age bucket.

Show child attributes

byCurrency · object[] | null · requerido

Unreconciled exposure broken down by currency.

Show child attributes

totalUnmatchedAmount · string · requerido

Total unreconciled monetary exposure across all currencies, as a decimal string.

Ejemplo:

"70000.00"