Models

PiggyBankEventRead

object

typestringrequired

Immutable value

Example

piggy_bank_events

idstringrequired

Example

attributesPiggyBankEventPropertiesrequired

Show child attributes

created_atstring<date-time>

Example

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

updated_atstring<date-time>

Example

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

amountstring<amount>

Example

123.45

pc_amountstring<amount>

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

transaction_journal_idstring | null

The journal associated with the event.

Example

transaction_group_idstring | null

The transaction group associated with the event.

Example

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

{
  "type": "piggy_bank_events",
  "id": "2",
  "attributes": {
    "created_at": "2026-10-01T00:00:00+00:00",
    "updated_at": "2026-10-01T00:00:00+00:00",
    "amount": "123.45",
    "pc_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,
    "transaction_journal_id": "4291",
    "transaction_group_id": "4291"
  },
  "links": {
    "0": {
      "rel": "self",
      "uri": "/OBJECTS/1"
    },
    "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
  }
}