FireFly III icon

FireFly III

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

Actions89

Piggy Banks API → Update Piggy Bank

AI-generated

Overview

This node operation updates an existing piggy bank in the FireFly III system using the Piggy Banks API. It allows users to modify various attributes of a piggy bank such as its name, target amount, start date, currency code, associated accounts, and additional fields like notes, object group details, order, and target date. This operation is useful for managing and adjusting savings goals dynamically within financial workflows.

Use Case Examples

  1. Updating the name and target amount of a piggy bank to reflect new savings goals.
  2. Changing the start date and currency code of a piggy bank to correct or update its financial settings.
  3. Modifying the accounts linked to a piggy bank to reflect changes in asset accounts.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Piggy Bank ID The ID of the piggy bank to update.
Accounts Asset accounts connected to this piggy bank, including account ID, name, and current amount saved.
Name The new name of the piggy bank.
Target Amount The new target amount to save in the piggy bank.
Start Date The new start date for the piggy bank savings.
Currency Code The currency code (e.g., USD, EUR) for the piggy bank.
Update Fields Additional optional fields to update such as currency ID, notes, object group ID and title, display order, and target date.

Output

JSON

  • id - The unique identifier of the updated piggy bank.
  • name - The updated name of the piggy bank.
  • target_amount - The updated target amount to save.
  • start_date - The updated start date of the piggy bank.
  • transaction_currency_code - The updated currency code of the piggy bank.
  • accounts - The updated list of asset accounts connected to the piggy bank, including account IDs, names, and current amounts.
  • notes - Additional notes about the piggy bank, if updated.
  • object_group_id - The updated group ID the piggy bank belongs to.
  • object_group_title - The updated name of the group the piggy bank belongs to.
  • order - The updated display order of the piggy bank.
  • target_date - The updated target date to finish saving money.

Dependencies

  • FireFly III API authentication token

Troubleshooting

  • Ensure the Piggy Bank ID is valid and exists in the FireFly III system to avoid 'not found' errors.
  • Verify that the currency code or currency ID provided is supported by the FireFly III system.
  • Check that the accounts data structure is correctly formatted with valid account IDs and amounts.
  • If the API returns an authentication error, confirm that the API authentication token is correctly configured and has the necessary permissions.

Links

Discussion