FireFly III icon

FireFly III

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

Actions89

Rules & Groups API → Trigger Rule

AI-generated

Overview

This node operation triggers a specific rule within the FireFly III Rules & Groups API. It is useful for automating the application of predefined rules to transactions or data sets within a specified date range and optionally filtered by account IDs. For example, a user can trigger a rule to categorize transactions automatically based on certain criteria within a given time frame.

Use Case Examples

  1. Trigger a rule to automatically categorize transactions from the last month for specific accounts.
  2. Trigger a rule to apply custom transaction processing logic for a defined date range.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Rule/Group ID The ID of the rule or group to operate on.
Date Range Filters Filters to specify the start and end dates for testing or triggering the rule, formatted as YYYY-MM-DD.
Account IDs Comma-separated list of account IDs to filter the transactions the rule will be triggered on.

Output

JSON

  • json - The JSON response from the FireFly III API after triggering the rule, containing the result of the trigger operation.

Dependencies

  • FireFly III API with appropriate OAuth2 credentials

Troubleshooting

  • Ensure the Rule/Group ID is valid and exists in the FireFly III system.
  • Verify that the date range filters are correctly formatted as YYYY-MM-DD and that the start date is before the end date.
  • Check that the account IDs, if provided, are valid and accessible by the authenticated user.
  • If the API returns an error, verify the OAuth2 credentials and permissions for the FireFly III API integration.

Links

Discussion