ForecastBalanceTimeSeries

Run the forecastBalanceTimeSeries aggregation. Requires permissions: transactions:read, balances:read.

Authentication

Checking whether you're signed in…

Authorization

Authorization<token>

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

companyId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

startDate*string

Start of the window (YYYY-MM-DD). Defaults to the batch context start date.

Match^\d{4}-\d{2}-\d{2}

endDate*string

End of the window (YYYY-MM-DD). Typically a future date so the forecast extends past today.

Match^\d{4}-\d{2}-\d{2}

accountIds?array<string>

Restrict to these account ids. Omit to include all accounts.

asOfDate?string

Cutover between the actual and the projected balance (YYYY-MM-DD). Dates on or before asOfDate come from actual balances; the projection starts there and runs to endDate. Defaults to today.

Match^\d{4}-\d{2}-\d{2}

Response Body

`application/json`

curl -X POST "https://example.com/companies/string/data/forecastBalanceTimeSeries" \  -H "Content-Type: application/json" \  -d '{    "startDate": "string",    "endDate": "string"  }'

{  "actual": [    {      "date": "string",      "value": 0    }  ],  "forecast": [    {      "date": "string",      "value": 0    }  ]}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

`application/json`

`application/json`

`application/json`