FireFly III icon

FireFly III

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

Actions45

Overview

This node integrates with the FireFly III API to manage categories within a user's financial data. Specifically, the "Create Category" operation allows users to add new categories by specifying a name and optional notes. This is useful for organizing transactions or budgeting by grouping expenses or income under meaningful category labels.

Common scenarios include:

  • Adding a new spending category like "Groceries" or "Utilities" to better track expenses.
  • Creating custom categories for specific projects or events.
  • Enhancing reporting and insights by categorizing transactions accurately.

Example: A user wants to create a category named "Vacation" with notes describing it as "Expenses related to travel and accommodation." Using this node operation, they can automate adding this category to their FireFly III instance.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing (e.g., 123e4567-e89b-12d3-a456-426614174000). Optional but helpful for tracing requests in logs.
Name The name of the category to create. This is required and defines the label for the new category.
Notes Additional notes or description about the category. Optional text providing more context or details.

Output

The output JSON contains the response from the FireFly III API after creating the category. It typically includes the newly created category's details such as its ID, name, notes, creation timestamp, and other metadata provided by the API.

No binary data output is generated by this operation.

Dependencies

  • Requires an active connection to the FireFly III API with appropriate authentication credentials (such as an OAuth2 token or API key).
  • The node expects the FireFly III instance URL and credentials to be configured in n8n.
  • The "X-Trace-ID" header is optional but can be included for enhanced request tracing if supported by the API.

Troubleshooting

  • Missing Required Fields: If the "Name" property is not provided, the API will likely return a validation error. Ensure the category name is set.
  • Authentication Errors: If credentials are invalid or missing, the API will reject the request. Verify that the API key or OAuth token is correctly configured.
  • Duplicate Category Names: The API may reject creating a category with a name that already exists depending on FireFly III settings. Check for existing categories before creating new ones.
  • Invalid UUID for X-Trace-ID: If provided, ensure the X-Trace-ID is a valid UUID format; otherwise, the API might ignore it or return an error.
  • Network Issues: Connectivity problems between n8n and the FireFly III server will cause request failures. Confirm network access and endpoint correctness.

Links and References

Discussion