Sign in
accounts

Get Account Summary

get/api/accounts/{account_id}/summary

Path parameters

account_idstring uuid required

Query parameters

fromstring nullable

YYYY-MM-DD

YYYY-MM-DD

tostring nullable

YYYY-MM-DD

YYYY-MM-DD

bill_idstring uuid nullable

Aggregate by bill_id (issue #92); takes precedence over from/to

Aggregate by bill_id (issue #92); takes precedence over from/to

unbilled_onlyboolean

Cycle-math fallback only: exclude txs already linked to any bill

Cycle-math fallback only: exclude txs already linked to any bill

Headers

X-Workspace-Idstring nullable

Response

Successful Response

account_idstring uuid required
current_balancenumber required
monthly_incomenumber required
monthly_expensesnumber required
current_balance_primarynumber nullable
monthly_income_primarynumber nullable
monthly_expenses_primarynumber nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.