DevelopersAPIReferencedata
CashFlowByCategory
Use this when the user asks which categories drive cash inflows or outflows in a period. Requires permissions: transactions:read.
Authentication
You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow
sf_… API key in the bearerAuth field below.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
Length
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/companies/string/data/cashFlowByCategory" \ -H "Content-Type: application/json" \ -d '{ "startDate": "string", "endDate": "string" }'{ "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 }}