Skip to Content
SaaSFlow
DevelopersAPIReferencedata

CashFlowByCategory

Use this when the user asks which categories drive cash inflows or outflows in a period. Requires permissions: transactions:read.

Authentication

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

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}

Response Body

cashFlowByCategory result

application/json
  1. response
categories*array<>
unassignedInflow*
unassignedOutflow*
currencyChangeEffect*
Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/cashFlowByCategory' \  -H 'Content-Type: application/json' \  -d '{  "startDate": "string",  "endDate": "string"}'
Example Response
{  "categories": [    {      "id": "string",      "name": "string",      "inflow": {        "property1": 0,        "property2": 0      },      "outflow": {        "property1": 0,        "property2": 0      }    }  ],  "unassignedInflow": {    "property1": 0,    "property2": 0  },  "unassignedOutflow": {    "property1": 0,    "property2": 0  },  "currencyChangeEffect": {    "property1": 0,    "property2": 0  }}