SaaSFlow
DevelopersAPIReferencedata

RevenueExpensesByCategory

Use this when the user asks which categories drive revenue or expenses over a period. Requires permissions: financials:read.

Authentication

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

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}
filter?

Common filter shared by P&L slices.

Response Body

revenueExpensesByCategory result

application/json
  1. response
[index: integer]?
curl -X POST "https://example.com/companies/string/data/revenueExpensesByCategory" \  -H "Content-Type: application/json" \  -d '{    "startDate": "string",    "endDate": "string"  }'
[  {    "plType": "string",    "categories": [      {        "id": "string",        "name": "string",        "value": 0      }    ]  }]