FireFly III

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

Actions45

Overview

The "Get Transactions by Category" operation in the Categories API resource retrieves a list of financial transactions associated with a specific category. This node is useful for users who want to analyze or report on all transactions grouped under a particular category, such as expenses for "Groceries" or income from "Salary."

Common scenarios include:

Generating reports of spending or income within a category over a certain period.
Auditing transactions linked to a category for budgeting or tax purposes.
Filtering transactions by date range and pagination to handle large datasets efficiently.

For example, a user could fetch all transactions categorized as "Utilities" between January 1, 2023, and March 31, 2023, limiting results to 100 per page.

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`). Optional but helpful for troubleshooting.
Category ID	The unique identifier of the category whose transactions you want to retrieve. Required field.
Date Range Filters	Optional filters to limit transactions by date: - Start Date: Filter results starting from this date (format YYYY-MM-DD). - End Date: Filter results up to this date (format YYYY-MM-DD).
Pagination Options	Controls the number of results and pages returned: - Limit: Maximum number of results per page (minimum 1, default 50). - Page: Page number to retrieve (default 1).

Output

The output is a JSON object containing the list of transactions that belong to the specified category, optionally filtered by date range and paginated according to the input parameters.

The structure typically includes transaction details such as amounts, dates, descriptions, and related metadata as provided by the FireFly III API's /categories/{categoryId}/transactions endpoint.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "data": [
    {
      "id": "transaction-id-1",
      "date": "2023-01-15",
      "amount": 100.00,
      "description": "Electricity bill",
      "category_id": "category-id"
    },
    {
      "id": "transaction-id-2",
      "date": "2023-02-10",
      "amount": 50.00,
      "description": "Water bill",
      "category_id": "category-id"
    }
  ],
  "meta": {
    "pagination": {
      "total": 200,
      "count": 50,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 4
    }
  }
}

Dependencies

Requires an active connection to the FireFly III API with proper authentication via an API key or OAuth2 token configured in n8n credentials.
The node depends on the FireFly III API being accessible and responsive.
No additional external services are required beyond the FireFly III API.

Troubleshooting

Invalid Category ID: If the category ID does not exist or is malformed, the API will likely return a 404 error. Verify the category ID is correct.
Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key or OAuth2 token is correctly set up in n8n.
Date Format Issues: Dates must be in YYYY-MM-DD format. Incorrect formats may lead to errors or empty results.
Pagination Limits: Requesting a page number beyond available pages will return empty results. Adjust the page number accordingly.
Network Issues: Connectivity problems with the FireFly III API will cause request failures. Check network access and API server status.