Get cash forecasting report

GET

https://integrators.prod.api.tabsplatform.com/v3/reports/cash-forecasting

GET

/v3/reports/cash-forecasting

$ curl https://integrators.prod.api.tabsplatform.com/v3/reports/cash-forecasting \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "payload": {
3     "data": [
4       {
5         "customerId": "a3f1c9d2-4b7e-4f8a-9d3e-2b5f7c8a9e12",
6         "customerName": "Acme Corporation",
7         "cashForecastingPerPeriod": [
8           {
9             "period": "2024-06",
10             "dueTotal": 12500.75,
11             "paidTotal": 8000.5,
12             "total": 20501.25
13           },
14           {
15             "period": "2024-07",
16             "dueTotal": 15000,
17             "paidTotal": 5000,
18             "total": 20000
19           }
20         ]
21       }
22     ],
23     "limit": 50,
24     "totalItems": 120,
25     "currentPage": 1
26   },
27   "success": true,
28   "message": "Cash forecasting report retrieved successfully",
29   "error": {
30     "code": 0,
31     "message": "",
32     "details": {}
33   }
34 }

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

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleOptionalDefaults to 1

Page Number

limitdoubleOptionalDefaults to 50

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

filterstringOptional

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).

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

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings

Errors

401

Unauthorized Error