FireFly III icon

FireFly III

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

Actions45

Overview

This node interacts with the FireFly III API, specifically focusing on the "Categories API" resource and its operations. The "Get Category" operation retrieves detailed information about a specific category by its ID. This is useful in scenarios where you want to fetch metadata or details about a particular financial category within FireFly III, such as for reporting, auditing, or further processing in workflows.

Practical examples include:

  • Fetching category details to display in a dashboard.
  • Using category data to filter or enrich transaction records.
  • Automating updates or notifications based on category attributes.

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.
Category ID The unique identifier of the category to retrieve. This is required to specify which category's details to fetch.

Additionally, there is a notice property linking to the official FireFly III API documentation for further reference.

Output

The output JSON contains the full details of the requested category as returned by the FireFly III API. This typically includes fields such as the category's name, notes, creation date, and other metadata defined by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "notes": "string",
  "created_at": "string",
  "updated_at": "string",
  ...
}

Dependencies

  • Requires an active connection to the FireFly III API via an OAuth2-based API credential configured in n8n.
  • The node depends on the FireFly III API being accessible and the provided API key/token having permissions to read category data.

Troubleshooting

  • Common issues:

    • Invalid or missing Category ID: The node requires a valid category ID; ensure it is correctly provided.
    • Authentication errors: Verify that the API credentials are correctly set up and have sufficient permissions.
    • Network or connectivity problems: Ensure the FireFly III API endpoint is reachable from the n8n environment.

  • Error messages:

    • 404 Not Found: The specified category ID does not exist. Double-check the ID.
    • 401 Unauthorized: Authentication failed. Check API credentials.
    • 400 Bad Request: Input parameters may be malformed or missing.

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

Links and References

Discussion