Skip to Content
SaaSFlow
DevelopersAPIReferencedata

TopExpenseVendors

Use this when the user asks for the top expense vendors over a period. Requires permissions: financials:read, vendors:read, transactions:read.

Authentication

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

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

Common filter shared by P&L slices.

limit?integer
Range1 <= value

Response Body

topExpenseVendors result

application/json
  1. response
[index: integer]?
Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/topExpenseVendors' \  -H 'Content-Type: application/json' \  -d '{  "startDate": "string",  "endDate": "string"}'
Example Response
[  {    "vendorId": "string",    "vendorName": "string",    "amount": 0  }]