FireFly III icon

FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions89

Recurrences API → Create Recurrence

AI-generated

Overview

This node operation creates a new recurring transaction in the FireFly III system. It allows users to define the type of recurring transaction (withdrawal, transfer, or deposit), set the title and first date for the recurrence, configure recurrence settings such as activity status, rules application, description, notes, repetition limits, and schedule patterns for when the recurrence should fire. Additionally, users specify the transaction details that will be created each time the recurrence fires, including amounts, source and destination accounts, and optional transaction metadata like categories, budgets, tags, and currency information. This operation is useful for automating regular financial transactions, such as monthly bill payments, salary deposits, or transfers between accounts.

Use Case Examples

  1. Automate monthly rent payment by creating a withdrawal recurrence on the 1st of each month.
  2. Set up a weekly transfer recurrence to move funds from a checking account to a savings account every Friday.
  3. Create a yearly deposit recurrence for an annual bonus payment.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Type The type of recurring transaction (withdrawal, transfer, or deposit).
Title Name of the recurring transaction.
First Date The first date the recurring transaction will fire (must be after today).
Recurrence Settings Additional settings for the recurrence such as active status, rule application, description, notes, number of repetitions, and repeat until date.
Repetitions Schedule patterns defining when the recurrence should fire, including type (daily, weekly, monthly, yearly, or n-th weekday of the month), moment details, skip count, and weekend handling.
Transactions Details of transactions to create when the recurrence fires, including description, amount, source and destination account IDs, and optional transaction metadata like bill ID, budget ID, category ID, currency, foreign amounts, piggy bank ID, and tags.

Output

JSON

  • id - The unique identifier of the created recurrence.
  • type - The type of the recurring transaction.
  • title - The title/name of the recurring transaction.
  • first_date - The first date the recurrence will fire.
  • active - Whether the recurrence is active.
  • apply_rules - Whether rules are applied after each transaction creation.
  • description - Description of the recurring transaction.
  • notes - Additional notes about the recurrence.
  • repeat_until - Date until which the recurrence can fire.
  • repetitions - Array of repetition schedule objects defining when the recurrence fires.
  • transactions - Array of transaction objects created by the recurrence, including details and metadata.

Dependencies

  • An API key credential for FireFly III API authentication

Troubleshooting

  • Ensure the 'First Date' is set to a date after today, as the API requires this for creating recurrences.
  • Verify that either 'Number of Repetitions' or 'Repeat Until' is set, but not both simultaneously, to avoid conflicts.
  • Check that all required transaction details (description, amount, source and destination account IDs) are provided to prevent API errors.
  • If using tags in transaction details, ensure they are provided as a comma-separated string; the node converts them to an array format.
  • Common error messages may include validation errors for date formats or missing required fields; verify input formats and completeness.

Links

Discussion