In der Referenz stöbern

Wiederkehrende Buchungen

13 Endpunkte · Die Endpunktbeschreibungen sind auf Englisch.

List recurrences in the household

GET/households/{householdId}/recurrences

read:recurrences

Beispielanfrage

bash

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

Antwort200 · Success

Create a recurring transaction schedule

POST/households/{householdId}/recurrences

write:recurrences

Request-Body

json

{  "name": "Streaming service",  "accountId": "01J8ME9AZ2K3W7X4V5T6R7Q8S9",  "amountCents": -1599,  "currency": "EUR",  "frequency": "monthly",  "dayOfMonth": 1,  "startDate": "2026-07-01"}

Beispielanfrage

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/recurrences \     -d '{"name":"Streaming service","accountId":"01J8ME9AZ2K3W7X4V5T6R7Q8S9","amountCents":-1599,"currency":"EUR","frequency":"monthly","dayOfMonth":1,"startDate":"2026-07-01"}'

Antwort201 · Success

Fetch a single recurrence

GET/households/{householdId}/recurrences/{id}

read:recurrences

Parameter

Name	Ort	Erforderlich
id	path	Erforderlich

Beispielanfrage

bash

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

Antwort200 · Success

Update a recurrence (recomputes nextRunDate if schedule changes)

PATCH/households/{householdId}/recurrences/{id}

write:recurrences

Parameter

Name	Ort	Erforderlich
id	path	Erforderlich

Request-Body

json

{  "amountCents": -1999}

Beispielanfrage

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/recurrences/{id} \     -d '{"amountCents":-1999}'

Antwort200 · Success

Soft-delete a recurrence

DELETE/households/{householdId}/recurrences/{id}

write:recurrences

Parameter

Name	Ort	Erforderlich
id	path	Erforderlich

Beispielanfrage

bash

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

Antwort204 · No content

Force immediate materialization of the next due run (idempotent on external_id)

POST/households/{householdId}/recurrences/{id}/materialize-now

write:recurrences

Parameter

Name	Ort	Erforderlich
id	path	Erforderlich

Beispielanfrage

bash

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

Antwort200 · Success

Pause a recurrence (status → paused, no further runs)

POST/households/{householdId}/recurrences/{id}/pause

write:recurrences

Parameter

Name	Ort	Erforderlich
id	path	Erforderlich

Beispielanfrage

bash

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

Antwort200 · Success

Resume a paused recurrence

POST/households/{householdId}/recurrences/{id}/resume

write:recurrences

Parameter

Name	Ort	Erforderlich
id	path	Erforderlich

Beispielanfrage

bash

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

Antwort200 · Success

Recurring charges detected in the household activity that are not scheduled yet, plus price changes on tracked ones (ADR 0109)

GET/households/{householdId}/recurrences/suggestions

read:recurrences

Beispielanfrage

bash

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

Antwort200 · Success

Accept a suggestion: create the recurrence (origin detected) or apply the price change

POST/households/{householdId}/recurrences/suggestions/{key}/accept

write:recurrences

Parameter

Name	Ort	Erforderlich
key	path	Erforderlich

Beispielanfrage

bash

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

Antwort200 · Success

Dismiss a suggestion ("not recurring"); it stays hidden across recomputations

POST/households/{householdId}/recurrences/suggestions/{key}/dismiss

write:recurrences

Parameter

Name	Ort	Erforderlich
key	path	Erforderlich

Beispielanfrage

bash

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

Antwort204 · No content

Undo a dismissal

DELETE/households/{householdId}/recurrences/suggestions/{key}/dismiss

write:recurrences

Parameter

Name	Ort	Erforderlich
key	path	Erforderlich

Beispielanfrage

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/recurrences/suggestions/{key}/dismiss

Antwort204 · No content

What is coming in a window: recurrence occurrences, pending recurring rows, future one-off rows and card payment due days

GET/households/{householdId}/recurrences/upcoming

read:recurrences

Beispielanfrage

bash

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

Antwort200 · Success