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 tags within a user's financial data. Specifically, the "Create Tag" operation allows users to create new tags by specifying a tag name and optional additional details such as date and description. Tags are useful for categorizing transactions or other entities in FireFly III, enabling better organization and filtering.

Common scenarios where this node is beneficial include:

  • Automatically tagging transactions imported from external sources.
  • Creating custom tags for budgeting or reporting purposes.
  • Enriching financial data with metadata for easier analysis.

For example, a user might create a tag named "Vacation2024" with a description and date to mark all expenses related to a trip.

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).
New Tag Name The new name of the tag to be created. This is required and will be sent in the API request body as the tag's name.
Extra Tag Options Optional additional properties for the tag:
- Tag Date An optional date associated with the tag, formatted as YYYY-MM-DD.
- Tag Description An optional textual description providing more details about the tag.

Note: The "Tip" property is a notice linking to the official FireFly III API documentation and does not affect execution.

Output

The output JSON contains the response from the FireFly III API after creating the tag. Typically, this includes the newly created tag's details such as its ID, name, date, description, and any other metadata returned by the API.

Example output structure (simplified):

{
  "id": "string",
  "tag": "string",
  "date": "YYYY-MM-DD",
  "description": "string",
  ...
}

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the FireFly III API with appropriate authentication credentials (e.g., OAuth2 token).
  • The node expects the FireFly III instance URL and credentials to be configured in n8n.
  • The "X-Trace-ID" header can be optionally provided for request tracing but is not mandatory.

Troubleshooting

  • Missing Required Fields: If the "New Tag Name" is not provided, the API will likely return a validation error. Ensure this field is filled.
  • Authentication Errors: If the API credentials are invalid or expired, requests will fail with authorization errors. Verify and refresh credentials as needed.
  • Invalid Date Format: Providing a date in the wrong format (not YYYY-MM-DD) may cause the API to reject the request. Confirm the date format matches the expected pattern.
  • API Rate Limits: Excessive requests may trigger rate limiting. Implement retries or delays if encountering HTTP 429 errors.
  • Network Issues: Connectivity problems between n8n and the FireFly III server will cause request failures. Check network access and firewall settings.

Links and References

Discussion