Actions89
- General Actions
- About API Actions
- Accounts API Actions
- Available Budgets API Actions
- Bills API Actions
- Budgets API Actions
- Transactions API Actions
- Categories API Actions
- Tags API Actions
- Rules & Groups API Actions
- Piggy Banks API Actions
- Object Groups API Actions
- Recurrences API Actions
Rules & Groups API → Trigger Rule Group
AI-generatedOverview
This node operation triggers a specific rule group in the FireFly III API. It allows users to execute the rules defined within a rule group for a specified date range and optionally filtered by account IDs. This is useful for automating financial rules processing based on transaction data within a given period.
Use Case Examples
- Triggering a rule group to apply financial rules to transactions from the last month for specific accounts.
- Automating the execution of rule groups to categorize or manage transactions based on predefined criteria.
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 the transactions to be considered when triggering the rule group. |
| Account IDs | Comma-separated list of account IDs to filter the transactions considered by the rule group trigger. |
Output
JSON
json- The JSON response from the FireFly III API after triggering the rule group, containing the result of the operation.
Dependencies
- Requires an API key credential for FireFly III API authentication.
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.
- Check that the account IDs, if provided, are valid and exist in the system.
- If the API returns an error, verify the X-Trace-ID for debugging and tracing the request.
Links
- FireFly III API Documentation - Trigger Rule Group - Official API documentation for triggering a rule group in FireFly III.