Browse the reference

Accounts

14 endpoints

List accounts in this household

GET/households/{householdId}/accounts

read:accounts

Parameters

Name	In	Required
status	query	Optional

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/accounts

Response200 · Success

Create a financial account

POST/households/{householdId}/accounts

write:accounts

Request body

json

{  "name": "Everyday checking",  "type": "checking",  "currency": "EUR",  "balanceCents": "125000"}

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/accounts \     -d '{"name":"Everyday checking","type":"checking","currency":"EUR","balanceCents":"125000"}'

Response201 · Success

Get a single account with its computed balance

GET/households/{householdId}/accounts/{accountId}

read:accounts

Parameters

Name	In	Required
accountId	path	Required

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/accounts/{accountId}

Response200 · Success

Update an account

PATCH/households/{householdId}/accounts/{accountId}

write:accounts

Parameters

Name	In	Required
accountId	path	Required

Request body

json

{  "name": "Joint checking"}

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/accounts/{accountId} \     -d '{"name":"Joint checking"}'

Response200 · Success

Soft-delete an account (rejects non-zero balance unless force)

DELETE/households/{householdId}/accounts/{accountId}

write:accounts

Parameters

Name	In	Required
accountId	path	Required
force	query	Optional

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/accounts/{accountId}

Response204 · No content

Daily running balance for an account

GET/households/{householdId}/accounts/{accountId}/balance-history

read:accounts

Parameters

Name	In	Required	Description
accountId	path	Required	-
fromDate	query	Optional	YYYY-MM-DD
toDate	query	Optional	YYYY-MM-DD

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/accounts/{accountId}/balance-history

Response200 · Success

Close an account; any remaining balance is booked as a balance adjustment dated on the caller's local day

POST/households/{householdId}/accounts/{accountId}/close

write:accounts

Parameters

Name	In	Required
accountId	path	Required

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/accounts/{accountId}/close

Response200 · Success

Convert an account to another type (safe moves only: same group, cash<->credit, loan<->tracking; crossing the budget boundary is refused with guidance)

POST/households/{householdId}/accounts/{accountId}/convert

write:accounts

Parameters

Name	In	Required
accountId	path	Required

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/accounts/{accountId}/convert

Response200 · Success

Loan payoff planner: amortization with the current terms, optional extra monthly principal, and this month’s ledger split

GET/households/{householdId}/accounts/{accountId}/loan-projection

read:accounts

Parameters

Name	In	Required	Description
accountId	path	Required	-
extraMonthlyCents	query	Optional	Extra principal paid every month, integer cents

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/accounts/{accountId}/loan-projection

Response200 · Success

Loan payoff simulator: what-if projection for an alternative payment, recurring/one-off extras, or a target payoff month (solved to the required payment)

GET/households/{householdId}/accounts/{accountId}/loan-simulation

read:accounts

Parameters

Name	In	Required	Description
accountId	path	Required	-
targetPayoffYearMonth	query	Optional	Solve the minimal payment that pays off by this YYYY-MM
oneTimeExtraCents	query	Optional	One-off extra principal this month, integer cents
extraMonthlyCents	query	Optional	Extra principal every month, integer cents
paymentCents	query	Optional	Alternative full monthly payment, integer cents

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/accounts/{accountId}/loan-simulation

Response200 · Success

Dated changes of a loan’s rate, payment and escrow (newest first)

GET/households/{householdId}/accounts/{accountId}/loan-terms-history

read:accounts

Parameters

Name	In	Required
accountId	path	Required

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/accounts/{accountId}/loan-terms-history

Response200 · Success

Reconcile account against the real bank balance: books an adjustment for any gap, then locks cleared transactions as reconciled

POST/households/{householdId}/accounts/{accountId}/reconcile

write:accounts

Parameters

Name	In	Required
accountId	path	Required

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/accounts/{accountId}/reconcile

Response200 · Success

Reopen a previously closed account

POST/households/{householdId}/accounts/{accountId}/reopen

write:accounts

Parameters

Name	In	Required
accountId	path	Required

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/accounts/{accountId}/reopen

Response200 · Success

Atomically set the manual position of accounts within their groups

POST/households/{householdId}/accounts/reorder

write:accounts

Example request

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/accounts/reorder

Response204 · No content