Browse the reference
All resources
Payees
13 endpoints
List payees in this household
GET
/households/{householdId}/payeesread:payees
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/payeesResponse200 · Success
Create a payee
POST
/households/{householdId}/payeeswrite:payees
Request body
json
{ "name": "Local supermarket"}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/payees \ -d '{"name":"Local supermarket"}'Response201 · Success
Get a payee
GET
/households/{householdId}/payees/{payeeId}read:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/payees/{payeeId}Response200 · Success
Update a payee (recomputes normalized_name on rename)
PATCH
/households/{householdId}/payees/{payeeId}write:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Request body
json
{ "name": "Whole Foods"}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/payees/{payeeId} \ -d '{"name":"Whole Foods"}'Response200 · Success
Soft-delete a payee
DELETE
/households/{householdId}/payees/{payeeId}write:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X DELETE https://api.vokse.ai/households/current/payees/{payeeId}Response204 · No content
List aliases of a payee
GET
/households/{householdId}/payees/{payeeId}/aliasesread:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/payees/{payeeId}/aliasesResponse200 · Success
Add an alias to a payee (dedup by normalized form)
POST
/households/{householdId}/payees/{payeeId}/aliaseswrite:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/payees/{payeeId}/aliasesResponse201 · Success
Remove an alias
DELETE
/households/{householdId}/payees/{payeeId}/aliases/{aliasId}write:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
| aliasId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X DELETE https://api.vokse.ai/households/current/payees/{payeeId}/aliases/{aliasId}Response204 · 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-candidatesread:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/payees/{payeeId}/dedupe-candidatesResponse200 · Success
Merge this payee into another: reassign transactions, dedupe aliases, soft-delete source
POST
/households/{householdId}/payees/{payeeId}/mergewrite:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/payees/{payeeId}/mergeResponse200 · Success
Undo a merge: resurrect this (soft-deleted) payee and move the listed transactions back from the target
POST
/households/{householdId}/payees/{payeeId}/unmergewrite:payees
Parameters
| Name | In | Required |
|---|---|---|
| payeeId | path | Required |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/payees/{payeeId}/unmergeResponse200 · Success
Household-wide near-duplicate payee clusters (vector cosine >= 0.9), for the duplicates review tray.
GET
/households/{householdId}/payees/duplicate-groupsread:payees
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/payees/duplicate-groupsResponse200 · Success
Search, filter, sort and paginate the payee register
GET
/households/{householdId}/payees/pageread:payees
Parameters
| Name | In | Required |
|---|---|---|
| sort | query | Optional |
| categoryId | query | Optional |
| segment | query | Optional |
| q | query | Optional |
| pageSize | query | Optional |
| page | query | Optional |
Example request
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/payees/pageResponse200 · Success