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 `valuePreviousPeriod` the balance on `startDate`. Amounts are in each account's own currency, named in `defaultCurrency`, so do not sum across accounts without converting first. Narrow to specific accounts with a comma-separated `accountIds`. For a converted series over time rather than two snapshots, use `daily_balance`.

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.
GET
/companies/{companyId}/accounts/balances

Authorization

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
Length1 <= length

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

application/json

curl -X GET "https://example.com/companies/string/accounts/balances?startDate=string&endDate=string"
{  "property1": {    "value": 0,    "valuePreviousPeriod": 0,    "valueChange": 0,    "valuePreviousPeriodWithTransfersAndBalancesAdded": 0,    "defaultCurrency": "string"  },  "property2": {    "value": 0,    "valuePreviousPeriod": 0,    "valueChange": 0,    "valuePreviousPeriodWithTransfersAndBalancesAdded": 0,    "defaultCurrency": "string"  }}

Create account

Create an account. Use `importType: "manual"` for one you will fill by hand or by CSV; accounts fed by a bank connection are created by the integration itself. `includeInCashBalance` decides whether it counts towards the cash position, which is usually false for loans. Pass `initialBalance` to seed the opening balance so the running balance is right from day one, dated before any transaction you then import. `order` is required and sets its position in the list.

Daily balance

Get the day-by-day cumulative balance across accounts, returned as `[date, balance]` tuples. Unlike the per-account balances endpoint, these are converted into the company's base currency and summed, so this is the series to plot as a cash curve. Restrict it to specific accounts with a comma-separated `accountIds`.