FIfirefly-iii
piggy_banks

Store a new piggy bank

Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters.

post/v1/piggy-banks

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/piggy-banks
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

namestring string required
target_amountstring amount nullable required
current_amountstring amount
start_datestring date required

The date you started with this piggy bank.

target_datestring date nullable

The date you intend to finish saving money.

orderinteger
activeboolean
notesstring string nullable
object_group_idstring string nullable

The group ID of the group this object is part of. NULL if no group.

object_group_titlestring string nullable

The name of the group. NULL if no group.

Example request

{
  "name": "New digital camera",
  "accounts": [
    {
      "id": "3",
      "name": "Checking account",
      "current_amount": "123.45"
    }
  ],
  "target_amount": "123.45",
  "current_amount": "123.45",
  "start_date": "2026-08-01",
  "target_date": "2026-08-31",
  "order": 5,
  "active": true,
  "notes": "Some notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}

Response

New piggy bank stored, result in response.

Example response

{
  "data": {
    "type": "piggy_banks",
    "id": "2",
    "attributes": {
      "created_at": "2026-08-01T00:00:00+00:00",
      "updated_at": "2026-08-01T00:00:00+00:00",
      "name": "New digital camera",
      "percentage": 12,
      "start_date": "2026-08-01T00:00:00+00:00",
      "target_date": "2026-08-01T00:00:00+00:00",
      "order": 5,
      "active": true,
      "notes": "Some notes",
      "object_group_id": "5",
      "object_group_order": 5,
      "object_group_title": "Example Group",
      "accounts": [
        {
          "account_id": "3",
          "name": "Checking account",
          "current_amount": "123.45",
          "pc_current_amount": "123.45"
        }
      ],
      "object_has_currency_setting": true,
      "currency_id": "5",
      "currency_name": "Euro",
      "currency_code": "EUR",
      "currency_symbol": "$",
      "currency_decimal_places": 2,
      "primary_currency_id": "5",
      "primary_currency_name": "Euro",
      "primary_currency_code": "EUR",
      "primary_currency_symbol": "$",
      "primary_currency_decimal_places": 2,
      "target_amount": "123.45",
      "pc_target_amount": "123.45",
      "current_amount": "123.45",
      "pc_current_amount": "123.45",
      "left_to_save": "700.00",
      "pc_left_to_save": "700.00",
      "save_per_month": "12.45",
      "pc_save_per_month": "12.45"
    },
    "links": {
      "0": {
        "rel": "self",
        "uri": "/OBJECTS/1"
      },
      "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
    }
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.