Actions45
- General Actions
- About API Actions
- Accounts API Actions
- Transactions API Actions
- Categories API Actions
- Tags API Actions
- Rules & Groups API Actions
Overview
The node integrates with the FireFly III API, specifically providing a "Search All API" operation under the "General" resource. This operation allows users to perform search queries across different entity types within FireFly III, such as transactions or accounts.
Typical use cases include:
- Quickly finding specific transactions or accounts by keyword or identifier.
- Filtering accounts by type or searching within specific account fields.
- Automating financial data retrieval workflows where dynamic search is required.
For example, you could search for all transactions containing a certain description or find accounts matching a particular IBAN or account number.
Properties
| Name | Meaning |
|---|---|
| X-Trace-ID | A unique UUID string used to trace and debug the request in the FireFly III system logs. |
| Search For | The type of entity to search. Options: transactions (search transactions), accounts (search accounts). |
| Query | The search query string to look for within the selected entity type. |
| Account Type | (Only when searching accounts) Filter accounts by their type. Options: all, asset, cash, expense, revenue, special, hidden, liability, liabilities, loan, debt, mortgage, none (empty string). |
| Field | (Only when searching accounts) The account field(s) to search in. Options: all, iban, name, number, id. |
| Pagination Options | Collection to control pagination: - Limit: Maximum number of results to return (minimum 1, default 50). - Page: The page number to retrieve (minimum 1, default 1). |
Output
The output JSON contains the raw response from the FireFly III API search endpoint corresponding to the selected entity type (transactions or accounts). The structure depends on the FireFly III API's search response format but generally includes an array of matched entities with their details.
No binary data output is produced by this operation.
Dependencies
- Requires connection to a FireFly III instance with valid API credentials (an API key or OAuth2 token).
- The node uses internal helper functions to make HTTP requests to the FireFly III API endpoints.
- No additional external services are required beyond the FireFly III API itself.
Troubleshooting
- Empty Results: If the search returns no results, verify that the query string is correct and matches existing data. Also, check if filters like account type or field are too restrictive.
- Invalid UUID for X-Trace-ID: Ensure the X-Trace-ID, if provided, is a valid UUID format; otherwise, tracing may not work correctly.
- API Authentication Errors: Confirm that the API credentials are properly configured and have sufficient permissions to perform searches.
- Pagination Issues: If requesting pages beyond available data, the API may return empty arrays. Adjust the limit and page parameters accordingly.
- Network or Endpoint Errors: Check connectivity to the FireFly III server and ensure the API endpoint
/search/{entity}is accessible.