Sign in

v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Reports

Get cash forecasting report

Retrieves a paginated cash forecasting report showing due and paid amounts per period for each customer

get/v3/reports/cash-forecasting

Query parameters

pagenumber

Page Number

limitnumber

Max items per page. Defaults to 50. Values above 500 will be rejected.

filterstring
        Supported items for filter: startMonth, endMonth, currency.

        Months should be in YYYY-MM format. Set startMonth and endMonth to the same value to request a single month.

        By default the forecast is capped to 120 months ahead of the current month; pass endMonth to extend or shorten that horizon.

        Currency should be an ISO 4217 currency code (e.g., USD, INR, EUR).

Response

Successfully retrieved cash forecasting report

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "customerId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}