Skip to main content
GET
Cash flow statement

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Tokens.

Query Parameters

buckets
integer

Number of trailing buckets to return. Defaults to 12 months / 8 quarters / 5 years by period.

Required range: 0 < x <= 24
months
integer

Legacy alias for buckets.

Required range: 0 < x <= 24
currency
string
Required string length: 3
period
enum<string>
Available options:
month,
quarter,
year
accountIds
string

Comma-separated ledger account ids of bank-backed cash accounts to scope the report to. Defaults to all.

Response

200 - application/json

The bucketed cash-flow report

report
object
required