# CategoryProperties

Type: object

Schema: [CategoryProperties](https://sourcey-firefly.pages.dev/api/models/categoryproperties/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
  "Lunch"
  ```

- `color` (optional)
  Type: string, string
  
  The color of the category in HEX format. Firefly III does not use this field, but your app might.
  
  Example:
  
  ```json
  "FF0000"
  ```

- `last_activity` (optional)
  Type: string, date-time; nullable
  
  Last activity of the category.
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

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

- `object_has_currency_setting` (optional)
  Type: boolean
  
  This object never has its own currency setting, so this value is always false.
  
  Example:
  
  ```json
  false
  ```

- `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
  ```

- `spent` (optional)
  Type: array
  
  Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set.
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object

- `pc_spent` (optional)
  Type: array
  
  Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set. 
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object

- `earned` (optional)
  Type: array
  
  Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set.
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object

- `pc_earned` (optional)
  Type: array
  
  Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set. 
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object

- `transferred` (optional)
  Type: array
  
  Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set. 
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object

- `pc_transferred` (optional)
  Type: array
  
  Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set. 
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object