v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Reporting

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

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

Query parameters

date_fromstring required

Start date (YYYY-MM-DD)

date_tostring required

End date (YYYY-MM-DD)

source_idstring

Source ID filter

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Cash impact summary with currency and age breakdowns

totalUnmatchedAmountstring

Total unmatched amount across all currencies (decimal string)

Example response

{
  "byCurrency": [
    {
      "currency": "USD"
    }
  ],
  "byAge": [
    {
      "bucket": "0-24h"
    }
  ]
}