Skip to Content
SaaSFlow
DevelopersAPIReferencedata

ForecastCashFlowTimeSeries

e. actuals up to the cutover and planned transactions after it. Use cashFlowTimeSeries when the window ends in the past.

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/data/forecastCashFlowTimeSeries

Authorization

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

Path Parameters

companyId*string
Formatuuid

Request Body

application/json
  1. body
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 actual and planned cash flow (YYYY-MM-DD). Dates on or before asOfDate come from actual transactions (inflow/outflow); dates after it come from planned (forecast) occurrences (plannedInflow/plannedOutflow). Defaults to today.

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

Response Body

forecastCashFlowTimeSeries result

application/json
  1. response

Daily cash inflows and outflows, split into actual (inflow/outflow, dates on or before asOfDate) and planned (plannedInflow/plannedOutflow, dates after asOfDate). Inflows are positive; outflows are negative (money leaving the accounts). Transfers between own accounts are excluded from the actual series. Sum the values per calendar month to reproduce the "Cash inflows and outflows" chart.

inflow*array<>
outflow*array<>
plannedInflow*array<>
plannedOutflow*array<>
Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/forecastCashFlowTimeSeries' \  -H 'Content-Type: application/json' \  -d '{  "endDate": "string"}'
Example Response
{  "inflow": [    {      "date": "string",      "value": 0    }  ],  "outflow": [    {      "date": "string",      "value": 0    }  ],  "plannedInflow": [    {      "date": "string",      "value": 0    }  ],  "plannedOutflow": [    {      "date": "string",      "value": 0    }  ]}