Models

PiggyBankSingle

object

dataPiggyBankReadrequired

Show child attributes

typestringrequired

Immutable value

Example

piggy_banks

idstringrequired

Example

attributesPiggyBankPropertiesrequired

Show child attributes

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

namestringrequired

Example

New digital camera

percentageinteger<int32> | nullread only

The percentage of the target amount that has been saved, if a target amount is set.

Example

start_datestring<date-time>

The date you started with this piggy bank.

Example

2026-10-01T00:00:00+00:00

target_datestring<date-time> | null

The date you intend to finish saving money.

Example

2026-10-01T00:00:00+00:00

orderinteger<int32>

Example

activebooleanread only

Example

true

notesstring | null

Example

Some notes

object_group_idstring | null

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

Example

object_group_orderinteger<int32> | nullread only

The order of the group. At least 1, for the highest sorting.

Example

object_group_titlestring | null

The name of the group. NULL if no group.

Example

Example Group

accountsArray<PiggyBankAccountRead>

Show child attributes

account_idstringread only

The ID of the account.

Example

namestringread only

Example

Checking account

current_amountstring<amount>

Example

123.45

pc_current_amountstring<amount>

If convertToPrimary is on, this will show the amount in the primary currency.

Example

123.45

object_has_currency_settingbooleanread only

Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.

Example

true

currency_idstring

The currency ID of the currency associated with this object.

Example

currency_namestring

The currency name of the currency associated with this object.

Example

Euro

currency_codestring

The currency code of the currency associated with this object.

Example

EUR

currency_symbolstringread only

Example

currency_decimal_placesinteger<int32>read only

Example

primary_currency_idstringread only

The currency ID of the administration's primary currency.

Example

primary_currency_namestringread only

The currency name of the administration's primary currency.

Example

Euro

primary_currency_codestringread only

The currency code of the administration's primary currency.

Example

EUR

primary_currency_symbolstringread only

The currency symbol of the administration's primary currency.

Example

primary_currency_decimal_placesinteger<int32>read only

The currency decimal places of the administration's primary currency.

Example

target_amountstring<amount> | nullrequired

Example

123.45

pc_target_amountstring<amount> | null

The target amount in the primary currency of the administration.

Example

123.45

current_amountstring<amount>

Example

123.45

pc_current_amountstring<amount>

The current amount in the primary currency of the administration.

Example

123.45

left_to_savestring | null

Example

700.00

pc_left_to_savestring | null

Example

700.00

save_per_monthstring | nullread only

Example

12.45

pc_save_per_monthstring | nullread only

Example

12.45

linksObjectLinkrequired

Show child attributes

0object

Show child attributes

relstring

Example

self

uristring

Example

/OBJECTS/1

selfstring<uri>

Example

https://demo.firefly-iii.org/api/v1/OBJECTS/1

Example

{
  "data": {
    "type": "piggy_banks",
    "id": "2",
    "attributes": {
      "created_at": "2026-10-01T00:00:00+00:00",
      "updated_at": "2026-10-01T00:00:00+00:00",
      "name": "New digital camera",
      "percentage": 12,
      "start_date": "2026-10-01T00:00:00+00:00",
      "target_date": "2026-10-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"
    }
  }
}