FireFly III icon

FireFly III

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

Actions89

Recurrences API → Trigger Recurrence

AI-generated

Overview

This node operation triggers a specific recurring transaction in the FireFly III system for a given date. It is useful for automating the creation of transactions based on predefined recurrence schedules, such as monthly bills or subscriptions. For example, a user can trigger a rent payment recurrence on a specific date to generate the transaction automatically.

Use Case Examples

  1. Trigger a monthly subscription payment recurrence on the 1st of each month.
  2. Manually trigger a recurring transaction for a specific date to ensure it is recorded in the system.

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 be triggered.
Trigger Date The date for which to trigger the recurrence. The transaction will be created and dated on this day.

Output

JSON

  • json - The response from the FireFly III API after triggering the recurrence, typically containing details of the created transaction or confirmation of the trigger action.

Dependencies

  • Requires an API key credential for FireFly III OAuth2 authentication to access the FireFly III API.

Troubleshooting

  • Ensure the Recurrence ID is valid and corresponds to an existing recurring transaction in FireFly III.
  • Verify the Trigger Date is in the correct format (YYYY-MM-DD) and is a valid date.
  • Check that the API credentials are correctly configured and have the necessary permissions to trigger recurrences.
  • If the API returns an error, review the X-Trace-ID for debugging and tracing the request in FireFly III logs.

Links

Discussion