Store a new recurring transaction

Creates a new recurring transaction. The data required can be submitted as a JSON body or as a list of parameters.

post/v1/recurrences

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

type'withdrawal' | 'transfer' | 'deposit' string required

titlestring string required

descriptionstring string

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

first_datestring date required

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

repeat_untilstring date nullable required

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

nr_of_repetitionsinteger nullable

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

apply_rulesboolean

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

activeboolean

If the recurrence is even active.

notesstring string nullable

Example request

{
  "type": "withdrawal",
  "title": "Rent",
  "description": "Recurring transaction for the monthly rent",
  "first_date": "2026-08-31",
  "repeat_until": "2026-08-31",
  "nr_of_repetitions": 5,
  "apply_rules": true,
  "active": true,
  "notes": "Some notes",
  "repetitions": [
    {
      "type": "weekly",
      "moment": "3",
      "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": [
        "Barbecue preparation"
      ],
      "piggy_bank_id": "123",
      "bill_id": "123"
    }
  ]
}

Response

New recurring transaction stored, result in response.

Changes

No recorded changes to this endpoint across all 1 revision of this API.