ForecastCashFlowTimeSeries
e. actuals up to the cutover and planned transactions after it. Use cashFlowTimeSeries when the window ends in the past.
Authentication
A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/companies/string/data/forecastCashFlowTimeSeries" \ -H "Content-Type: application/json" \ -d '{ "endDate": "string" }'{ "inflow": [ { "date": "string", "value": 0 } ], "outflow": [ { "date": "string", "value": 0 } ], "plannedInflow": [ { "date": "string", "value": 0 } ], "plannedOutflow": [ { "date": "string", "value": 0 } ]}CashFlowTimeSeries
Use this when the user asks for cash inflows and outflows over time. Requires permissions: transactions:read, balances:read.
ForecastBalanceTimeSeries
Use this when the user asks where the bank balance is heading: the actual balance up to the cutover, then a projection built from planned transactions.