# PiggyBankProperties

Type: object

Schema: [PiggyBankProperties](https://sourcey-firefly.pages.dev/api/models/piggybankproperties/index.md)

- `created_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `updated_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `name` (required)
  Type: string, string
  
  Example:
  
  ```json
  "New digital camera"
  ```

- `percentage` (optional)
  Type: integer, int32; nullable
  
  The percentage of the target amount that has been saved, if a target amount is set.
  
  readOnly: true
  
  Example:
  
  ```json
  12
  ```

- `start_date` (optional)
  Type: string, date-time
  
  The date you started with this piggy bank.
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `target_date` (optional)
  Type: string, date-time; nullable
  
  The date you intend to finish saving money.
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `order` (optional)
  Type: integer, int32
  
  Example:
  
  ```json
  5
  ```

- `active` (optional)
  Type: boolean
  
  readOnly: true
  
  Example:
  
  ```json
  true
  ```

- `notes` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "Some notes"
  ```

- `object_group_id` (optional)
  Type: string, string; nullable
  
  The group ID of the group this object is part of. NULL if no group.
  
  Example:
  
  ```json
  "5"
  ```

- `object_group_order` (optional)
  Type: integer, int32; nullable
  
  The order of the group. At least 1, for the highest sorting.
  
  readOnly: true
  
  Example:
  
  ```json
  5
  ```

- `object_group_title` (optional)
  Type: string, string; nullable
  
  The name of the group. NULL if no group.
  
  Example:
  
  ```json
  "Example Group"
  ```

- `accounts` (optional)
  Type: array
  
  Items:
    Reference: [PiggyBankAccountRead](https://sourcey-firefly.pages.dev/api/models/piggybankaccountread/index.md); Type: object

- `object_has_currency_setting` (optional)
  Type: boolean
  
  Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  true
  ```

- `currency_id` (optional)
  Type: string, string
  
  The currency ID of the currency associated with this object.
  
  Example:
  
  ```json
  "5"
  ```

- `currency_name` (optional)
  Type: string, string
  
  The currency name of the currency associated with this object.
  
  Example:
  
  ```json
  "Euro"
  ```

- `currency_code` (optional)
  Type: string, string
  
  The currency code of the currency associated with this object.
  
  Example:
  
  ```json
  "EUR"
  ```

- `currency_symbol` (optional)
  Type: string, string
  
  readOnly: true
  
  Example:
  
  ```json
  "$"
  ```

- `currency_decimal_places` (optional)
  Type: integer, int32
  
  readOnly: true
  
  Example:
  
  ```json
  2
  ```

- `primary_currency_id` (optional)
  Type: string, string
  
  The currency ID of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "5"
  ```

- `primary_currency_name` (optional)
  Type: string, string
  
  The currency name of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "Euro"
  ```

- `primary_currency_code` (optional)
  Type: string, string
  
  The currency code of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "EUR"
  ```

- `primary_currency_symbol` (optional)
  Type: string, string
  
  The currency symbol of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "$"
  ```

- `primary_currency_decimal_places` (optional)
  Type: integer, int32
  
  The currency decimal places of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  2
  ```

- `target_amount` (required)
  Type: string, amount; nullable
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_target_amount` (optional)
  Type: string, amount; nullable
  
  The target amount in the primary currency of the administration.
  
  Example:
  
  ```json
  "123.45"
  ```

- `current_amount` (optional)
  Type: string, amount
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_current_amount` (optional)
  Type: string, amount
  
  The current amount in the primary currency of the administration.
  
  Example:
  
  ```json
  "123.45"
  ```

- `left_to_save` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "700.00"
  ```

- `pc_left_to_save` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "700.00"
  ```

- `save_per_month` (optional)
  Type: string, string; nullable
  
  readOnly: true
  
  Example:
  
  ```json
  "12.45"
  ```

- `pc_save_per_month` (optional)
  Type: string, string; nullable
  
  readOnly: true
  
  Example:
  
  ```json
  "12.45"
  ```