FireFly III icon

FireFly III

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

Overview

The "List Transactions" operation of the FireFly III node allows users to retrieve a filtered and paginated list of financial transactions from their FireFly III instance. This operation is useful for scenarios where you want to analyze, report on, or process transaction data programmatically. For example, you might use it to:

  • Extract all withdrawals within a specific date range for budgeting purposes.
  • Retrieve deposits and transfers to reconcile accounts.
  • Fetch opening balance transactions to audit initial account states.

By applying filters such as transaction type and date ranges, users can tailor the output to their specific needs, making this operation flexible for various financial workflows.

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).
Transaction Filters Collection of filters to narrow down the transactions:
- Transaction Type: Filter by type with options: All, Withdrawal, Deposit, Transfer, Opening Balance.
- Start Date: Start date for filtering transactions (format YYYY-MM-DD).
- End Date: End date for filtering transactions (format YYYY-MM-DD).
- Custom Transaction Type: Specify a custom transaction type string; overrides dropdown if set.
Pagination Options Controls pagination of results:
- Limit: Maximum number of results to return (minimum 1, default 50).
- Page: Page number to retrieve (minimum 1, default 1).

Output

The output is a JSON object containing the list of transactions matching the specified filters and pagination settings. The structure typically includes an array of transaction objects with details such as amounts, dates, types, and related metadata.

Example output structure (simplified):

{
  "data": [
    {
      "id": 123,
      "type": "withdrawal",
      "date": "2024-01-15",
      "amount": 100.00,
      "description": "Grocery shopping",
      ...
    },
    {
      "id": 124,
      "type": "deposit",
      "date": "2024-01-20",
      "amount": 500.00,
      "description": "Salary",
      ...
    }
  ],
  "meta": {
    "total": 200,
    "page": 1,
    "limit": 50
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires connection to a FireFly III API instance.
  • Requires an API authentication token configured in n8n credentials to authorize requests.
  • The node uses the FireFly III REST API endpoints under /transactions to fetch data.

Troubleshooting

  • Empty Results: If no transactions are returned, verify that the filter criteria (dates, types) match existing data.
  • Invalid Date Format: Ensure start and end dates are in YYYY-MM-DD format; otherwise, the API may reject the request.
  • API Authentication Errors: Check that the API key or OAuth2 token is valid and has sufficient permissions.
  • Pagination Issues: If requesting pages beyond available data, the result may be empty; adjust page and limit accordingly.
  • Custom Transaction Type Conflicts: If both dropdown and custom type are set, the dropdown value takes precedence.

Links and References

Discussion