FireFly III icon

FireFly III

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

Actions45

Overview

The node integrates with the FireFly III API to manage categories within a user's financial data. Specifically, the "Update Category" operation allows users to modify an existing category's details such as its name and notes. This is useful for keeping category information up-to-date, correcting mistakes, or refining categorization schemes.

Common scenarios include:

  • Renaming a category to better reflect its purpose.
  • Adding or updating descriptive notes for clarity.
  • Maintaining consistent category data across multiple systems by syncing updates.

Example: A user wants to rename the category "Groceries" to "Supermarket" and add notes about preferred stores. Using this node operation, they can update the category directly via the API without manual intervention.

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 update. This is required to specify which category to modify.
Name The new name for the category. Required field to set or change the category's display name.
Notes Additional notes or description for the category. Optional text field to provide more context or details.

Output

The node outputs a JSON object representing the updated category as returned by the FireFly III API. This typically includes fields such as the category's ID, name, notes, creation and update timestamps, and possibly other metadata related to the category.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the FireFly III API, authenticated via an OAuth2 API credential or equivalent API key/token configured in n8n.
  • The node depends on the FireFly III API being accessible and the user having appropriate permissions to update categories.
  • No additional external services are required beyond the FireFly III API.

Troubleshooting

  • Invalid Category ID: If the provided Category ID does not exist, the API will likely return a 404 error. Verify the ID is correct and corresponds to an existing category.
  • Missing Required Fields: Omitting the required "Name" or "Category ID" properties will cause validation errors. Ensure these fields are populated.
  • Authentication Errors: If the API credentials are invalid or expired, the request will fail with authentication errors. Re-authenticate or update credentials as needed.
  • API Rate Limits: Excessive requests may trigger rate limiting. Implement retries with backoff or reduce request frequency.
  • X-Trace-ID Usage: While optional, providing a unique X-Trace-ID helps trace and debug issues in API logs if problems arise.

Links and References

Discussion