Explorar a referência

Beneficiários

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

List payees in this household

GET/households/{householdId}/payees

read:payees

Exemplo de pedido

bash

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

Resposta200 · Success

Create a payee

POST/households/{householdId}/payees

write:payees

Corpo do pedido

json

{  "name": "Local supermarket"}

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/payees \     -d '{"name":"Local supermarket"}'

Resposta201 · Success

Get a payee

GET/households/{householdId}/payees/{payeeId}

read:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	path	Obrigatório

Exemplo de pedido

bash

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

Resposta200 · Success

Update a payee (recomputes normalized_name on rename)

PATCH/households/{householdId}/payees/{payeeId}

write:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	path	Obrigatório

Corpo do pedido

json

{  "name": "Whole Foods"}

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/payees/{payeeId} \     -d '{"name":"Whole Foods"}'

Resposta200 · Success

Soft-delete a payee

DELETE/households/{householdId}/payees/{payeeId}

write:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	path	Obrigatório

Exemplo de pedido

bash

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

Resposta204 · No content

List aliases of a payee

GET/households/{householdId}/payees/{payeeId}/aliases

read:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	path	Obrigatório

Exemplo de pedido

bash

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

Resposta200 · Success

Add an alias to a payee (dedup by normalized form)

POST/households/{householdId}/payees/{payeeId}/aliases

write:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	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/payees/{payeeId}/aliases

Resposta201 · Success

Remove an alias

DELETE/households/{householdId}/payees/{payeeId}/aliases/{aliasId}

write:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	path	Obrigatório
aliasId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/payees/{payeeId}/aliases/{aliasId}

Resposta204 · No content

List payees in this household whose vector embedding is near-duplicate of :payeeId (cosine similarity >= 0.9).

GET/households/{householdId}/payees/{payeeId}/dedupe-candidates

read:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/payees/{payeeId}/dedupe-candidates

Resposta200 · Success

Merge this payee into another: reassign transactions, dedupe aliases, soft-delete source

POST/households/{householdId}/payees/{payeeId}/merge

write:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	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/payees/{payeeId}/merge

Resposta200 · Success

Undo a merge: resurrect this (soft-deleted) payee and move the listed transactions back from the target

POST/households/{householdId}/payees/{payeeId}/unmerge

write:payees

Parâmetros

Nome	Local	Obrigatório
payeeId	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/payees/{payeeId}/unmerge

Resposta200 · Success

Household-wide near-duplicate payee clusters (vector cosine >= 0.9), for the duplicates review tray.

GET/households/{householdId}/payees/duplicate-groups

read:payees

Exemplo de pedido

bash

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

Resposta200 · Success

Search, filter, sort and paginate the payee register

GET/households/{householdId}/payees/page

read:payees

Parâmetros

Nome	Local	Obrigatório
sort	query	Opcional
categoryId	query	Opcional
segment	query	Opcional
q	query	Opcional
pageSize	query	Opcional
page	query	Opcional

Exemplo de pedido

bash

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

Resposta200 · Success