FireFly III icon

FireFly III

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

Actions45

Overview

This node interacts with the "Rules & Groups API" of FireFly III, a personal finance manager. Specifically, the Get Rule operation retrieves detailed information about a single rule identified by its ID. Rules in FireFly III are used to automate categorization or processing of transactions based on defined criteria.

Typical use cases include:

  • Fetching the configuration and details of a specific rule to review or audit automation logic.
  • Integrating rule data into workflows for reporting or conditional processing.
  • Debugging or verifying rules programmatically without manual UI access.

Example: You want to retrieve the details of a rule that automatically categorizes grocery expenses, so you can log or modify it in your workflow.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing (optional).
Rule/Group ID The unique identifier of the rule or group to operate on. Required to specify which rule to get.

Output

The output is a JSON object containing the full details of the requested rule as returned by the FireFly III API. This typically includes properties such as the rule's ID, name, conditions, actions, and metadata describing how the rule operates within FireFly III.

No binary data is produced by this operation.

Example output structure (simplified):

{
  "id": "123",
  "name": "Grocery Categorization",
  "conditions": [...],
  "actions": [...],
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-02-01T12:00:00Z"
}

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 /rules/{ruleId}.

Troubleshooting

  • Missing or invalid Rule/Group ID: The operation requires a valid rule ID. Ensure the ID is correct and exists in your FireFly III instance.
  • Authentication errors: If the API key or OAuth token is missing or expired, the request will fail. Verify your credentials setup.
  • Network or connectivity issues: The node depends on network access to the FireFly III server. Check firewall or proxy settings if requests time out.
  • API version mismatch: Using an incompatible FireFly III API version may cause unexpected errors. Confirm your FireFly III version matches the API documentation.

Common error messages:

  • 404 Not Found: The specified rule ID does not exist.
  • 401 Unauthorized: Authentication failed; check API credentials.
  • 400 Bad Request: Invalid parameters sent; verify the Rule/Group ID format.

Links and References

Discussion