FireFly III icon

FireFly III

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

Actions89

Piggy Banks API → Create Piggy Bank

AI-generated

Overview

This node operation creates a new piggy bank (savings goal) in the FireFly III system using the Piggy Banks API. It allows users to specify details such as the piggy bank's name, associated accounts, target amount, start date, currency, and additional optional fields like notes, object group, order, and target date. This operation is useful for managing and tracking savings goals within personal finance workflows.

Use Case Examples

  1. Creating a piggy bank named 'Vacation Fund' with a target amount of 1000 USD, starting from 2024-01-01, linked to specific asset accounts.
  2. Setting up a piggy bank with additional notes and grouping it under a specific object group for better organization.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Name Name of the piggy bank to be created.
Accounts List of accounts associated with this piggy bank, each with account ID, optional name, and current amount.
Target Amount The target amount to save in the piggy bank.
Start Date The date when the piggy bank savings started.
Currency Code Currency code for the piggy bank (e.g., USD, EUR). Recommended to provide.
Additional Fields Optional additional fields including currency ID, notes, object group ID and title, display order, and target date.

Output

JSON

  • id - The unique identifier of the created piggy bank.
  • name - The name of the created piggy bank.
  • accounts - Array of accounts associated with the piggy bank, including account IDs and optional details.
  • target_amount - The target amount set for the piggy bank.
  • start_date - The start date of the piggy bank savings.
  • transaction_currency_code - The currency code used for the piggy bank transactions.
  • transaction_currency_id - The currency ID used for the piggy bank transactions, if provided.
  • target_date - The target date to finish saving money, if provided.
  • order - The display order of the piggy bank, if provided.
  • notes - Additional notes about the piggy bank, if provided.
  • object_group_id - The ID of the object group the piggy bank belongs to, if provided.
  • object_group_title - The title of the object group the piggy bank belongs to, if provided.

Dependencies

  • FireFly III API with OAuth2 authentication

Troubleshooting

  • Ensure all required fields (Name, Target Amount, Start Date) are provided; missing these will cause errors.
  • Verify that account IDs provided in the Accounts field exist and are valid in the FireFly III system.
  • Check that the currency code or currency ID is valid and supported by the FireFly III API.
  • If the API returns an error, review the X-Trace-ID for debugging and tracing the request in the FireFly III system.

Links

Discussion