Get balance sheet

Returns the family’s net worth, total assets, and total liabilities in the family’s primary currency.

GET /api/v1/balance_sheet

Get balance sheet

cURL

curl --request GET \
  --url https://app.sure.am/api/v1/balance_sheet \
  --header 'X-Api-Key: <api-key>'

200

{
  "currency": "<string>",
  "net_worth": {},
  "assets": {},
  "liabilities": {}
}

Authorizations

X-Api-Key · string · header · required

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

Response

200 - application/json

balance sheet retrieved

currency · string · required

Family's primary currency code

net_worth · object · required

Net worth as a Money object

assets · object · required

Total assets as a Money object

liabilities · object · required

Total liabilities as a Money object