Skip to Content
SaaSFlow
DevelopersAPIReferenceaccounts

Balances

Get the balance of each account at two points in time and the change between them. Keyed by account id, value is the balance on endDate and…

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/accounts/balances

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

Query Parameters

startDate*string

Start date (YYYY-MM-DD). Balance at this date is the "previous period" value.

Match^\d{4}-\d{2}-\d{2}$
endDate*string

End date (YYYY-MM-DD). Balance at this date is the current value.

Match^\d{4}-\d{2}-\d{2}$
accountIds?string

Comma-separated account IDs to filter by.

Response Body

Balance per account at the given dates.

application/json
  1. response
[key: string]?
Example Request
curl -X GET 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/accounts/balances?startDate=string&endDate=string'
Example Response200
{  "property1": {    "value": 0,    "valuePreviousPeriod": 0,    "valueChange": 0,    "valuePreviousPeriodWithTransfersAndBalancesAdded": 0,    "defaultCurrency": "string"  },  "property2": {    "value": 0,    "valuePreviousPeriod": 0,    "valueChange": 0,    "valuePreviousPeriodWithTransfersAndBalancesAdded": 0,    "defaultCurrency": "string"  }}