SaaSFlow
DevelopersAPIReferencedata

AccountBalanceKpis

Use this when the user asks for cash/bank account balance KPIs (current, start, end, change). Requires permissions: balances:read.

Authentication

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

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}
accountIds?array<string>

Response Body

accountBalanceKpis result

application/json
  1. response
total*number
totalPreviousPeriod*number
totalChange*number
curl -X POST "https://example.com/companies/string/data/accountBalanceKpis" \  -H "Content-Type: application/json" \  -d '{    "startDate": "string",    "endDate": "string"  }'
{  "total": 0,  "totalPreviousPeriod": 0,  "totalChange": 0}

TopExpenseVendors

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

AccountBalanceByAccount

Use this when the user asks for current balances broken down per bank or cash account. Requires permissions: balances:read.