Explorar a referência

Orçamentos

9 endpoints · As descrições dos endpoints estão em inglês.

Budget snapshot for the given month (YYYY-MM) including ABT and per-category state

GET/households/{householdId}/budgets/{yearMonth}

read:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório

Exemplo de pedido

bash

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

Resposta200 · Success

Raise every category with a goal to its suggested monthly amount, capped by ABT

POST/households/{householdId}/budgets/{yearMonth}/auto-assign-from-goals

write:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/budgets/{yearMonth}/auto-assign-from-goals

Resposta200 · Success

Snapshot for a single category in the given month

GET/households/{householdId}/budgets/{yearMonth}/categories/{categoryId}

read:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório
categoryId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/budgets/{yearMonth}/categories/{categoryId}

Resposta200 · Success

Assign or update the amount a category receives this month

PATCH/households/{householdId}/budgets/{yearMonth}/categories/{categoryId}

write:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório
categoryId	path	Obrigatório

Corpo do pedido

json

{  "assignedCents": 50000}

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/budgets/{yearMonth}/categories/{categoryId} \     -d '{"assignedCents":50000}'

Resposta200 · Success

Assignment history for one category in the given month: every assign and every money move in or out, newest first

GET/households/{householdId}/budgets/{yearMonth}/categories/{categoryId}/history

read:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório
categoryId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/budgets/{yearMonth}/categories/{categoryId}/history

Resposta200 · Success

Copy every assignment from sourceYearMonth into yearMonth (overwrites destination)

POST/households/{householdId}/budgets/{yearMonth}/copy-from/{sourceYearMonth}

write:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório
sourceYearMonth	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/budgets/{yearMonth}/copy-from/{sourceYearMonth}

Resposta200 · Success

Move money from one category to another within a single month (atomic, conservative)

POST/households/{householdId}/budgets/{yearMonth}/move

write:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório

Corpo do pedido

json

{  "fromCategoryId": "01J8ME9B7QW3ZK5X2V8T4R6S1D",  "toCategoryId": "01J8ME9D8VK2QW4X6T3R5S7Z9M",  "amountCents": 10000}

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/budgets/{yearMonth}/move \     -d '{"fromCategoryId":"01J8ME9B7QW3ZK5X2V8T4R6S1D","toCategoryId":"01J8ME9D8VK2QW4X6T3R5S7Z9M","amountCents":10000}'

Resposta200 · Success

Clear every assignment in this month (owner only)

POST/households/{householdId}/budgets/{yearMonth}/reset

write:budgets

Parâmetros

Nome	Local	Obrigatório
yearMonth	path	Obrigatório

Exemplo de pedido

bash

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

Resposta200 · Success

Age of Money: mean days the money you spend sat in on-budget cash accounts (last 10 outflows, FIFO); null until 10 outflows exist

GET/households/{householdId}/budgets/age-of-money

read:budgets

Exemplo de pedido

bash

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

Resposta200 · Success