FireFly III icon

FireFly III

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

Actions45

Overview

This node interacts with the FireFly III API to retrieve data related to user accounts, transactions, categories, tags, rules, and general system information. Specifically, for the Accounts API resource and the Get Piggy Banks operation, it fetches all piggy banks associated with a specified account.

Use cases include financial management workflows where you want to automate retrieval of piggy bank data (savings goals or sub-accounts) linked to a particular account in FireFly III. For example, you might use this node to:

  • Automatically list all piggy banks under a given account to display savings progress.
  • Integrate piggy bank data into reports or dashboards.
  • Trigger further automation based on piggy bank balances or statuses.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Account ID The ID of the account whose piggy banks you want to retrieve. (Required)
Pagination Options Options to control pagination of results:
• Limit: Max number of results to return.
• Page: The page number to retrieve.

Note: Pagination options are available but optional for this operation.

Output

The output is a JSON object containing the list of piggy banks associated with the specified account. The structure corresponds directly to the FireFly III API response for the endpoint /accounts/{accountId}/piggy-banks.

Typical fields in the JSON output may include details about each piggy bank such as its ID, name, target amount, current balance, and other metadata defined by the FireFly III API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the FireFly III API via an OAuth2 or similar API authentication credential configured in n8n.
  • The node uses internal helper functions to make HTTP requests to the FireFly III API endpoints.
  • The Account ID must be valid and correspond to an existing account in the FireFly III instance.

Troubleshooting

  • Invalid Account ID: If the provided Account ID does not exist or is malformed, the API will likely return a 404 or error response. Verify the Account ID is correct.
  • Authentication Errors: Ensure that the API credentials are correctly set up and have sufficient permissions to access account piggy banks.
  • Pagination Issues: If many piggy banks exist, consider using pagination options (limit and page) to manage large result sets.
  • Network or API Downtime: Network issues or FireFly III service downtime can cause request failures. Check connectivity and API status.
  • X-Trace-ID Usage: Use the X-Trace-ID property to provide a unique request ID for easier debugging if supported by your FireFly III server logs.

Links and References

Discussion