Models

RecurrenceStore

object

typeRecurrenceTransactionTypewithdrawaltransferdepositrequired

Example

withdrawal

titlestringrequired

Example

Rent

descriptionstring

Not to be confused with the description of the actual transaction(s) being created.

Example

Recurring transaction for the monthly rent

first_datestring<date>required

First time the recurring transaction will fire. Must be after today.

Example

2026-10-31

repeat_untilstring<date> | nullrequired

Date until the recurring transaction can fire. Use either this field or repetitions.

Example

2026-10-31

nr_of_repetitionsinteger<int32> | null

Max number of created transactions. Use either this field or repeat_until.

Example

apply_rulesboolean

Whether or not to fire the rules after the creation of a transaction.

Example

true

activeboolean

If the recurrence is even active.

Example

true

notesstring | null

Example

Some notes

repetitionsArray<RecurrenceRepetitionStore>required

Show child attributes

typeRecurrenceRepetitionTypedailyweeklyndommonthlyyearlyrequired

The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week.

Example

weekly

momentstringrequired

Information that defined the type of repetition.

For 'daily', this is empty.
For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).
For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month
For 'monthly' it is the day of the month (1 - 31)
For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.

Example

skipinteger<int32>

How many occurrences to skip. 0 means skip nothing. 1 means every other.

Example

weekendinteger<int32>

How to respond when the recurring transaction falls in the weekend. Possible values:

Do nothing, just create it
Create no transaction.
Skip to the previous Friday.
Skip to the next Monday.

Example

transactionsArray<RecurrenceTransactionStore>required

Show child attributes

descriptionstringrequired

Example

Rent for the current month

amountstring<amount>required

Amount of the transaction.

Example

123.45

foreign_amountstring<amount> | null

Foreign amount of the transaction.

Example

123.45

currency_idstring

Submit either a currency_id or a currency_code.

Example

currency_codestring

Submit either a currency_id or a currency_code.

Example

EUR

foreign_currency_idstring | null

Submit either a foreign_currency_id or a foreign_currency_code, or neither.

Example

foreign_currency_codestring | null

Submit either a foreign_currency_id or a foreign_currency_code, or neither.

Example

GBP

budget_idstring

The budget ID for this transaction.

Example

category_idstring

Category ID for this transaction.

Example

source_idstringrequired

ID of the source account.

Example

destination_idstringrequired

ID of the destination account.

Example

tagsArray<string> | null

Array of tags.

Example

null

piggy_bank_idstring | null

Optional.

Example

bill_idstring | null

Optional.

Example

{
  "type": "withdrawal",
  "title": "Rent",
  "description": "Recurring transaction for the monthly rent",
  "first_date": "2026-10-31",
  "repeat_until": "2026-10-31",
  "nr_of_repetitions": 5,
  "apply_rules": true,
  "active": true,
  "notes": "Some notes",
  "repetitions": [
    {
      "type": "weekly",
      "moment": "3",
      "skip": 0,
      "weekend": 1
    }
  ],
  "transactions": [
    {
      "description": "Rent for the current month",
      "amount": "123.45",
      "foreign_amount": "123.45",
      "currency_id": "3",
      "currency_code": "EUR",
      "foreign_currency_id": "17",
      "foreign_currency_code": "GBP",
      "budget_id": "4",
      "category_id": "211",
      "source_id": "913",
      "destination_id": "258",
      "tags": null,
      "piggy_bank_id": "123",
      "bill_id": "123"
    }
  ]
}