accounts

Get Account Summary

Changed on
get/api/accounts/{account_id}/summary

Request

Path parameters

account_idstring uuid required

Query parameters

fromstring nullable

YYYY-MM-DD

tostring nullable

YYYY-MM-DD

bill_idstring uuid nullable

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

unbilled_onlyboolean

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
opening_balancenumber required
monthly_incomenumber required
monthly_expensesnumber required
projected_incomenumber
projected_expensesnumber
current_balance_primarynumber nullable
opening_balance_primarynumber nullable
monthly_income_primarynumber nullable
monthly_expenses_primarynumber nullable
projected_income_primarynumber nullable
projected_expenses_primarynumber nullable
fx_fallbackboolean

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status