FireFly III icon

FireFly III

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

Actions89

Recurrences API → Get Recurrence

AI-generated

Overview

This node operation retrieves details of a specific recurring transaction from the FireFly III API using the provided Recurrence ID. It is useful for users who want to fetch information about a particular recurrence, such as its schedule, transactions involved, and settings.

Use Case Examples

  1. Fetch details of a recurring transaction by specifying its Recurrence ID to monitor or update the recurrence schedule.
  2. Use this operation to get the current state and configuration of a recurring transaction for reporting or auditing purposes.

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 retrieve. This is a required field.

Output

JSON

  • json - The JSON response containing the details of the requested recurrence, including its schedule, transactions, and settings.

Dependencies

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

Troubleshooting

  • Ensure the Recurrence ID is correctly provided and exists in the FireFly III system; otherwise, the API will return an error indicating the recurrence was not found.
  • Verify that the API credentials are valid and have the necessary permissions to access recurrence data.
  • If using the X-Trace-ID, ensure it is a valid UUID format to aid in debugging and tracing requests.

Links

Discussion