FireFly III icon

FireFly III

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

Actions45

Overview

This node interacts with the FireFly III API to retrieve attachments related to a specific account. The "Get Attachments" operation under the "Accounts API" resource fetches all attachment data associated with the given account ID.

Typical use cases include:

  • Automating retrieval of documents or files linked to financial accounts.
  • Integrating account attachments into workflows for further processing, such as archiving or analysis.
  • Synchronizing attachments from FireFly III into other systems or storage solutions.

For example, a user might want to automatically download all receipts or invoices attached to an account after each transaction batch is processed.

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 tracing requests in logs.
Account ID The unique identifier of the account whose attachments are to be retrieved. This is required.
Pagination Options Controls pagination of results when listing attachments. Includes:
• Limit: Maximum number of results to return (minimum 1, default 50).
• Page: Page number to retrieve (minimum 1, default 1).

Note: For this specific operation ("Get Attachments"), only the "Account ID" and optionally "X-Trace-ID" are used; pagination options are defined but not applied in the code for this operation.

Output

The output is a JSON object containing the list of attachments for the specified account. The structure corresponds directly to the response from the FireFly III API endpoint /accounts/{accountId}/attachments.

Example output structure (simplified):

{
  "data": [
    {
      "id": "attachment-id-1",
      "name": "receipt.pdf",
      "size": 12345,
      "mime_type": "application/pdf",
      "created_at": "2023-01-01T12:00:00Z",
      "url": "https://firefly.example.com/api/attachments/attachment-id-1/download"
    },
    {
      "id": "attachment-id-2",
      "name": "invoice.jpg",
      "size": 23456,
      "mime_type": "image/jpeg",
      "created_at": "2023-01-02T15:30:00Z",
      "url": "https://firefly.example.com/api/attachments/attachment-id-2/download"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires a valid API authentication token configured in n8n credentials to access the FireFly III API.
  • The node uses the FireFly III REST API endpoint /accounts/{accountId}/attachments via HTTP GET.
  • Optionally supports passing an "X-Trace-ID" header for request tracing if provided.

Troubleshooting

  • Missing or invalid Account ID: The operation requires a valid account ID. If omitted or incorrect, the API will likely return a 400 or 404 error. Ensure the account ID exists in FireFly III.
  • Authentication errors: If the API key or OAuth token is missing or expired, the node will fail with authentication errors. Verify credentials in n8n.
  • API rate limits or connectivity issues: Network problems or API throttling may cause request failures. Check network connectivity and FireFly III API status.
  • Empty attachments list: If no attachments exist for the account, the returned data array will be empty. This is expected behavior.

Links and References

Discussion