FireFly III icon

FireFly III

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

Actions45

Overview

The "Get Transaction Journal" operation in the Transactions API resource retrieves detailed information about a specific transaction journal (also known as a split) from FireFly III. This operation is useful when you want to fetch all data related to a particular transaction journal, such as its splits, linked transactions, or metadata.

Typical use cases include:

  • Viewing the full details of a transaction journal for auditing or reporting.
  • Fetching transaction journal data to synchronize with other financial systems.
  • Debugging or tracing specific transactions by their unique IDs.

For example, if you have a transaction journal ID and want to get all associated splits and details, this node operation will return that comprehensive data.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing. Example: 123e4567-e89b-12d3-a456-426614174000
Transaction ID The ID of the transaction journal to retrieve. This is required and identifies which journal to fetch.

Additionally, there are informational notices guiding users to the official API documentation and clarifying that the Transaction ID should correspond to the transaction journal or split ID.

Output

The output JSON contains the full details of the requested transaction journal. This typically includes:

  • The transaction journal's metadata (ID, date, description, etc.).
  • All splits associated with the journal.
  • Related links or references to connected transactions.
  • Any additional fields provided by the FireFly III API for transaction journals.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "transaction_journal_id",
  "date": "2024-01-01",
  "description": "Payment for invoice #123",
  "splits": [
    {
      "id": "split_id_1",
      "amount": 100,
      "account_id": "account_1"
    },
    {
      "id": "split_id_2",
      "amount": -100,
      "account_id": "account_2"
    }
  ],
  "links": [ /* related transaction links */ ]
}

Dependencies

  • Requires an active connection to a FireFly III instance via an OAuth2 API credential or equivalent API authentication token.
  • The node depends on the FireFly III REST API being accessible and properly configured.
  • No additional external services are required beyond the FireFly III API.

Troubleshooting

  • Missing or invalid Transaction ID: The operation requires a valid transaction journal ID. Ensure the ID is correct and exists in your FireFly III instance.
  • Authentication errors: If the API credentials are missing or invalid, requests will fail. Verify that the API key or OAuth2 token is correctly set up in n8n.
  • Network or connectivity issues: Ensure that the FireFly III API endpoint is reachable from the n8n environment.
  • API rate limits or server errors: If the FireFly III server returns errors, check server logs or API usage limits.
  • X-Trace-ID usage: Providing a unique X-Trace-ID can help trace and debug requests on the server side; if omitted, tracing may be less effective.

Links and References

Discussion