Skip to main content
GET
Show cash flow

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Query Parameters

month
string<date>

First day of the calendar month to summarize (ISO 8601, e.g. 2025-01-01). Defaults to the current month. Must not be in the future. Cannot be combined with view=sankey.

include
enum<string>

Pass sankey to append a Sankey graph to the standard monthly CashFlow response. Cannot be combined with view.

Available options:
sankey
view
enum<string>

Pass sankey to retrieve a Sankey-only CashFlowGraph response for an arbitrary date range. Requires start_date and end_date. Cannot be combined with include or month.

Available options:
sankey
start_date
string<date>

Start of the custom date range (ISO 8601). Required when view=sankey.

end_date
string<date>

End of the custom date range (ISO 8601). Required when view=sankey. Must be on or after start_date.

Response

cash flow returned

month
string<date>
required

First day of the requested month (ISO 8601).

as_of
string<date>
required

Date the response was calculated.

time_zone
string
required

IANA time zone identifier for the authenticated user.

currency
string
required

Family primary currency code.

period
object
required
income
string
required

Total income for the period as a decimal string.

spending
string
required

Total spending for the period as a decimal string.

net_savings
string
required

income - spending as a decimal string.

spending_comparison
object
required
savings_rate
string | null

Savings rate as a percentage decimal string (0–100), or null when income is zero.

sankey
object | null

Sankey graph data. Present only when include=sankey is passed.