FireFly III icon

FireFly III

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

Actions89

Recurrences API → Update Recurrence

AI-generated

Overview

This node operation updates an existing recurring transaction in the FireFly III system. It allows users to modify recurrence settings such as activation status, description, first date, notes, repetition limits, and title. Additionally, users can update the schedule patterns (repetitions) that define when the recurrence fires and the transaction details associated with the recurrence. This operation is useful for managing and adjusting recurring financial transactions automatically within FireFly III, such as monthly bills or yearly subscriptions.

Use Case Examples

  1. Updating the title and description of a monthly recurring transaction.
  2. Changing the first date and number of repetitions for a weekly recurring transaction.
  3. Modifying transaction details like amount, category, or tags for a specific recurrence.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Recurrence ID The ID of the recurring transaction to update.
Recurrence Settings Settings for the recurrence such as active status, description, first date, notes, number of repetitions, repeat until date, and title.
Repetitions Schedule patterns for when the recurrence should fire, including type, moment, skip count, and weekend handling.
Transactions Transaction details to update when the recurrence fires, including amount, category, currency, description, destination account, tags, and other optional fields.

Output

JSON

  • json - The updated recurrence object returned from the FireFly III API after the update operation.

Dependencies

  • An API key credential for FireFly III API authentication

Troubleshooting

  • Ensure the Recurrence ID is valid and exists in the FireFly III system to avoid 'not found' errors.
  • Validate date formats for 'first_date' and 'repeat_until' fields to be in 'YYYY-MM-DD' format.
  • When updating transactions, ensure that tags are properly formatted as arrays if provided as comma-separated strings.
  • Check API permissions to confirm the user has rights to update recurrences.

Links

Discussion