Skip to Content
SaaSFlow
DevelopersAPIReferencedata

BalanceByCashType

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

Authentication

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

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
Match^\d{4}-\d{2}-\d{2}
endDate*string
Match^\d{4}-\d{2}-\d{2}
accountIds?array<string>

Response Body

balanceByCashType result

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