FireFly III

Overview

The "List Accounts" operation of the FireFly III node retrieves a list of financial accounts from the FireFly III API. This includes asset, cash, expense, and revenue accounts, among others. Users can filter accounts by type and paginate through results.

This operation is useful for scenarios such as:

• Displaying all user accounts in a dashboard or report.
• Synchronizing account lists with other financial tools.
• Filtering accounts by type to focus on specific categories like assets or expenses.

Example use case: A user wants to fetch all their asset accounts to analyze their investment portfolio separately from their daily expenses.

Properties

Output

The output is a JSON object representing the list of accounts returned by the FireFly III API. It typically contains an array of account objects with details such as account ID, name, type, and balances.

No binary data is output by this operation.

Example structure (simplified):

{
  "data": [
    {
      "id": "1",
      "name": "Checking Account",
      "type": "asset",
      "balance": 1000.00,
      ...
    },
    {
      "id": "2",
      "name": "Credit Card",
      "type": "expense",
      "balance": -500.00,
      ...
    }
  ],
  "meta": {
    "pagination": {
      "total": 10,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Dependencies

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

Troubleshooting

• Empty or missing results: Ensure the correct account type filter is set or try removing the filter to get all accounts.
• Pagination issues: If not all accounts appear, check the Limit and Page parameters to navigate through pages correctly.
• Invalid X-Trace-ID: The trace ID should be a valid UUID if provided; otherwise, omit it.
• API authentication errors: Verify that the API credentials are valid and have sufficient permissions.
• Date format errors: When using the Account Balance Date, ensure the date is in YYYY-MM-DD format to avoid API errors.

Common error messages may relate to invalid parameters or authentication failures. Reviewing the API documentation linked below can help resolve these.

Links and References

• FireFly III API Documentation
• FireFly III Official Website
• FireFly III API Search Feature