SaaSFlow
DevelopersAPIReferencedata

CashFlowTimeSeries

Use this when the user asks for cash inflows and outflows over time. Requires permissions: transactions:read, balances:read.

Authentication

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

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
Length1 <= length

Request Body

application/json
  1. body
startDate?string
Match^\d{4}-\d{2}-\d{2}
endDate*string
Match^\d{4}-\d{2}-\d{2}
accountIds?array<string>

Response Body

cashFlowTimeSeries result

application/json
  1. response
inflow*array<>
outflow*array<>
curl -X POST "https://example.com/companies/string/data/cashFlowTimeSeries" \  -H "Content-Type: application/json" \  -d '{    "endDate": "string"  }'
{  "inflow": [    {      "date": "string",      "value": 0    }  ],  "outflow": [    {      "date": "string",      "value": 0    }  ]}

BalanceByCashType

Use this when the user asks how balances are split across cash types (operating, reserve, savings, etc.). Requires permissions: balances:read.

ForecastCashFlowTimeSeries

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