FireFly III

Overview

The "Get Piggy Bank Events" operation in the Transactions API resource retrieves events related to a specific transaction's piggy bank activities. This node is useful when you want to track or analyze changes and movements within piggy banks associated with a particular transaction in FireFly III.

Typical use cases include:

• Auditing piggy bank contributions or withdrawals linked to a transaction.
• Monitoring savings goals or piggy bank status changes triggered by transactions.
• Integrating piggy bank event data into financial reports or dashboards.

For example, if you have a transaction representing a deposit into a piggy bank, this operation can fetch all events that describe how that deposit affected the piggy bank's balance or state.

Properties

Output

The output JSON contains the list of piggy bank events associated with the specified transaction. Each event typically includes details such as event type, amount, date, and any relevant metadata describing the piggy bank activity.

No binary data is returned by this operation.

Example output structure (simplified):

{
  "data": [
    {
      "id": "event-id-1",
      "type": "deposit",
      "amount": 100,
      "date": "2024-01-01",
      "piggyBankId": "pb-123",
      "notes": "Monthly saving"
    },
    {
      "id": "event-id-2",
      "type": "withdrawal",
      "amount": 50,
      "date": "2024-02-01",
      "piggyBankId": "pb-123",
      "notes": "Emergency fund usage"
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

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 backend service being accessible and the user having permission to access transaction and piggy bank data.

Troubleshooting

• Missing or invalid Transaction ID: The operation requires a valid transaction ID. Ensure the ID is correct and corresponds to an existing transaction.
• API authentication errors: Verify that the API credentials are correctly set up and have sufficient permissions.
• Pagination issues: If no results appear, check the pagination parameters; the requested page might be beyond available data.
• Network or connectivity problems: Confirm that the FireFly III API endpoint is reachable from your environment.
• Unexpected empty results: The transaction may not have any piggy bank events associated; verify the transaction's piggy bank activity in FireFly III.

Links and References

• FireFly III API Documentation
• FireFly III Official Site
• Piggy Banks Concept in FireFly III