FireFly III

Overview

The "Trigger Rule Group" operation in the Rules & Groups API resource allows users to programmatically trigger a specific rule group within FireFly III. This operation is useful for applying predefined sets of rules to transactions over a specified date range and optionally filtered by account IDs. It can be used to automate transaction categorization, tagging, or other rule-based processing without manual intervention.

Practical scenarios include:

• Automatically applying a group of financial rules to recent transactions to update their categories or tags.
• Re-triggering rule groups after importing new transactions to ensure consistent data classification.
• Testing how a rule group affects transactions within a certain period before committing changes.

Properties

Output

The node outputs a JSON object representing the response from the FireFly III API after triggering the rule group. This typically includes details about the triggered rules' effects, such as which transactions were affected or any summary information returned by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "success": true,
  "message": "Rule group triggered successfully",
  "details": {
    "transactionsProcessed": 42,
    "rulesApplied": 5
  }
}

(Note: Actual fields depend on the FireFly III API response.)

Dependencies

• Requires an active connection to a FireFly III instance with appropriate API access.
• Needs an API authentication token configured in n8n credentials to authorize requests.
• The node uses the FireFly III REST API endpoints under /rule-groups/{id}/trigger.
• The user should have permissions to trigger rule groups in FireFly III.

Troubleshooting

• Invalid Rule/Group ID: If the provided Rule/Group ID does not exist or is incorrect, the API will return an error. Verify the ID is correct and corresponds to an existing rule group.
• Date Format Errors: Ensure that the Start Date and End Date are in the YYYY-MM-DD format. Incorrect formats may cause the API to reject the request.
• Empty or Invalid Account IDs: If filtering by accounts, ensure the account IDs are valid and comma-separated without extra spaces.
• Authentication Failures: Check that the API key or OAuth2 credentials are correctly configured and have sufficient permissions.
• API Rate Limits or Server Errors: If the API returns rate limit errors or server errors, consider retrying after some time or checking the FireFly III server status.

Links and References

• FireFly III API Documentation
• FireFly III Rules & Groups API Reference (specific section for rule groups)
• n8n Documentation on HTTP Request Nodes (for understanding API calls)

This summary is based solely on static analysis of the provided source code and property definitions.