Models

PiggyBankStore

object

namestringrequired

Example

New digital camera

accountsArray<PiggyBankAccountStore>

Show child attributes

idstring | nullrequired

The ID of the account.

Example

namestring | null

The name of the account.

Example

Checking account

current_amountstring<amount>

The amount saved currently.

Example

123.45

target_amountstring<amount> | nullrequired

Example

123.45

current_amountstring<amount>

Example

123.45

start_datestring<date>required

The date you started with this piggy bank.

Example

2026-10-01

target_datestring<date> | null

The date you intend to finish saving money.

Example

2026-10-31

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_titlestring | null

The name of the group. NULL if no group.

Example

Example Group

Example

{
  "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-10-01",
  "target_date": "2026-10-31",
  "order": 5,
  "active": true,
  "notes": "Some notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}