Aller au contenu
vokse.
Parcourir la référence
Toutes les ressources

Rapports

9 endpoints · Les descriptions des points de terminaison sont en anglais.

Plan vs reality: per-month assigned vs spent totals, adherence share of budgeted categories, and the biggest overruns of the range. Max 5-year range.

GET/households/{householdId}/reports/budget-adherence
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/budget-adherence
Réponse200 · Success

Per-month income vs expense vs net (in base currency) over the range. Optional accountIds CSV (only these accounts). Max 5-year range.

GET/households/{householdId}/reports/cash-flow
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/cash-flow
Réponse200 · Success

Month-over-month spend per category (dense, zero-filled series in base currency). Optional accountIds CSV (only these accounts) and categoryIds CSV filters. Max 5-year range.

GET/households/{householdId}/reports/category-trends
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/category-trends
Réponse200 · Success

Income by source over the range (ADR 0107): unlabelled inflows plus every income category, month by month in the base currency. Optional accountIds CSV. Max 5-year range.

GET/households/{householdId}/reports/income-by-source
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/income-by-source
Réponse200 · Success

Per-month-end net worth in base currency. Optional accountIds CSV (only these accounts) and excludeAccountIds CSV filters. Max 5-year range.

GET/households/{householdId}/reports/net-worth
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/net-worth
Réponse200 · Success

Per-month savings rate (net/income) over the range, plus the overall rate. Months with no income report null. Optional accountIds CSV (only these accounts). Max 5-year range.

GET/households/{householdId}/reports/savings-rate
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/savings-rate
Réponse200 · Success

Spend per category over the range, sorted most-negative first. Optional accountIds CSV (only these accounts), accountId + categoryIds CSV filters. Income rows excluded; income lives in /cash-flow.

GET/households/{householdId}/reports/spending-by-category
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/spending-by-category
Réponse200 · Success

Top payees by spend over the range. Default limit=50, sort=totalDesc; optional accountIds CSV (only these accounts) and accountId filters. Free-text transactions (no payeeId) are excluded.

GET/households/{householdId}/reports/spending-by-payee
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/spending-by-payee
Réponse200 · Success

Current subscriptions rollup: outflow recurrences normalised to a per-month cost in base currency. status=active (default) | paused | all; optional accountIds CSV (only these accounts).

GET/households/{householdId}/reports/subscriptions
read:reports
Exemple de requête
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/reports/subscriptions
Réponse200 · Success