FireFly IIIInstall

Overview

This node interacts with the FireFly III Rules & Groups API, specifically supporting operations related to rule groups and rules within those groups. The "List Rules in Group" operation retrieves all rules that belong to a specified rule group.

Use cases for this node include automating financial workflows by managing and inspecting rules that categorize or process transactions automatically. For example, you might list all rules in a particular group to audit or modify them programmatically, or to trigger further automation based on the rules' criteria.

Practical example: You have a rule group for categorizing recurring expenses. Using this node, you can fetch all rules in that group to review or update them as part of your financial automation pipeline.

Properties

Output

The output is a JSON object containing the list of rules within the specified rule group. The structure corresponds directly to the API response from the endpoint /rule-groups/{ruleGroupId}/rules. It typically includes an array of rule objects with their details such as IDs, names, conditions, actions, and metadata.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "data": [
    {
      "id": "123",
      "name": "Rule 1",
      "conditions": [...],
      "actions": [...],
      ...
    },
    {
      "id": "124",
      "name": "Rule 2",
      "conditions": [...],
      "actions": [...],
      ...
    }
  ],
  "meta": {
    "pagination": {
      "total": 100,
      "count": 50,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 2
    }
  }
}

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/{ruleGroupId}/rules.
• Optional use of the X-Trace-ID header for request tracing if provided.

Troubleshooting

• Missing or invalid Rule/Group ID: The operation requires a valid rule group ID. Ensure the ID is correct and exists in your FireFly III instance.
• Authentication errors: If the API key or token is missing or invalid, requests will fail. Verify your credentials configuration.
• Pagination issues: If you request a page number beyond available pages, the API may return empty results. Adjust the page and limit parameters accordingly.
• Network or connectivity problems: Ensure your n8n instance can reach the FireFly III API endpoint.
• API rate limits: If you hit rate limits, consider adding delays or reducing request frequency.

Common error messages:

• 404 Not Found: The specified rule group ID does not exist.
• 401 Unauthorized: Authentication failed due to invalid or missing credentials.
• 400 Bad Request: Invalid parameters, e.g., non-numeric pagination values.

Resolving these usually involves verifying input parameters, credentials, and network connectivity.

Links and References

• FireFly III API Documentation
• Rules & Groups API Reference
• FireFly III Official Website