Actions45
- General Actions
- About API Actions
- Accounts API Actions
- Transactions API Actions
- Categories API Actions
- Tags API Actions
- Rules & Groups API Actions
Overview
This node integrates with the FireFly III API, a personal finance manager, allowing users to read, update, write, and delete financial data programmatically. It supports multiple resource categories such as accounts, transactions, categories, tags, rules, and general system information.
Common scenarios where this node is beneficial include:
- Automating financial data synchronization between FireFly III and other systems.
- Creating or updating accounts, transactions, categories, or tags based on external triggers.
- Fetching insights, reports, or exporting data for further analysis.
- Managing rules and groups to automate transaction categorization or processing.
- Running system-level commands like cron jobs or retrieving system/user info.
Practical examples:
- Automatically creating a new transaction in FireFly III when a payment is received in another app.
- Exporting transaction data monthly for accounting purposes.
- Fetching account balances and recent transactions to display in a custom dashboard.
- Triggering rule groups to categorize imported transactions automatically.
Properties
Name | Meaning |
---|---|
Tip | A notice with a link to the official FireFly III API documentation site for user reference. |
X-Trace-ID | A unique UUID identifier for the request, used for debugging and tracing (e.g., 123e4567-e89b-12d3-a456-426614174000 ). |
Output
The node outputs JSON data representing the response from the FireFly III API for the requested operation. The structure of the JSON depends on the selected resource and operation, for example:
- For "getAccount" operation: JSON contains details of a specific account.
- For "listTransactions": JSON contains a list of transactions with pagination info.
- For "createCategory": JSON contains the newly created category details.
If the operation involves exporting data (e.g., exportData under the general resource), the node outputs binary data containing the exported file (such as CSV). This binary data is accessible under the binary.data
field, with the filename derived from the HTTP response headers or defaulted to "export.csv".
Dependencies
- Requires an OAuth2 API credential configured in n8n to authenticate requests to the FireFly III API.
- Relies on the FireFly III API being accessible and properly configured.
- No additional external dependencies beyond the API and credentials.
Troubleshooting
- Authentication errors: Ensure the OAuth2 API credential is correctly set up with valid tokens and permissions.
- Invalid UUID for X-Trace-ID: If using the X-Trace-ID property, ensure it is a valid UUID string; otherwise, tracing may fail.
- API endpoint errors: Verify that the selected resource and operation are supported by your FireFly III instance version.
- Export data issues: When exporting data, if the binary output is empty or corrupted, check the API response headers and ensure the export format and type parameters are correct.
- Pagination handling: Some list operations support pagination options; incorrect pagination parameters might lead to incomplete data or errors.
- Network connectivity: Confirm that the n8n instance can reach the FireFly III API endpoint without firewall or network restrictions.