FireFly III icon

FireFly III

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

Actions89

Piggy Banks API → Delete Piggy Bank

AI-generated

Overview

This node operation deletes a specific piggy bank in the FireFly III system using the Piggy Banks API. It is useful for users who want to remove a piggy bank or savings goal from their financial management setup. For example, if a savings goal is no longer needed or was created by mistake, this operation allows for its removal by specifying the piggy bank's ID.

Use Case Examples

  1. Deleting a piggy bank by providing its unique ID to clean up unused savings goals.
  2. Automating the removal of piggy banks as part of a financial workflow.

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 be deleted. This is a required field.

Output

JSON

  • success - Indicates whether the piggy bank was successfully deleted (true).
  • id - The ID of the piggy bank that was deleted.

Dependencies

  • Requires an API key credential for FireFly III OAuth2 authentication to authorize the request.

Troubleshooting

  • Ensure the Piggy Bank ID provided is correct and exists in the FireFly III system; otherwise, the deletion will fail.
  • If the API returns an authorization error, verify that the OAuth2 credentials are correctly configured and have the necessary permissions.
  • Network or connectivity issues may cause the request to fail; check the connection and retry.

Links

Discussion