FireFly III icon

FireFly III

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

Overview

This node integrates with the FireFly III API to perform various operations related to financial data management. Specifically, for the Tags API resource and the Get Tag operation, it retrieves detailed information about a specific tag by its name or ID.

Common scenarios where this node is beneficial include:

  • Fetching metadata or details of a particular tag used in financial transactions.
  • Automating workflows that require tag information for categorization or reporting.
  • Integrating tag data into other systems or dashboards for enhanced financial insights.

For example, you might use this node to get the details of a tag named "Groceries" to analyze all transactions associated with it or to update your budgeting system based on tag 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 troubleshooting.
Target Tag Name/ID The name or ID of the tag to retrieve. This value is used directly in the API path. Note: Using tag names with international (non-ASCII) characters may cause issues. This property is required.

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

Output

The output JSON contains the full response from the FireFly III API for the requested tag. This typically includes:

  • Tag ID
  • Tag name
  • Description or notes associated with the tag
  • Metadata such as creation and update timestamps
  • Any other tag-related attributes provided by the API

No binary data is returned for this operation.

Example output structure (simplified):

{
  "id": "123",
  "tag": "Groceries",
  "description": "Expenses related to groceries",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-06-01T08:30:00Z"
}

Dependencies

  • Requires an active connection to the FireFly III API via an OAuth2 or similar API authentication credential configured in n8n.
  • The node depends on the FireFly III API being accessible and properly authenticated.
  • No additional external services are required beyond the FireFly III API.

Troubleshooting

  • Invalid Tag Name/ID: If the tag specified does not exist or is misspelled, the API will likely return a 404 error. Verify the tag name or ID is correct.
  • International Characters Issue: Using non-ASCII characters in the tag name may cause unexpected errors or failures due to URL encoding issues. Prefer using tag IDs or ASCII-only names.
  • Authentication Errors: Ensure the API credentials are valid and have sufficient permissions to access tag data.
  • X-Trace-ID Usage: If debugging requests, provide a unique UUID in the X-Trace-ID property to trace logs on the server side.
  • Network Issues: Confirm network connectivity to the FireFly III API endpoint.

Links and References

Discussion