# BudgetProperties

Type: object

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

- `active` (optional)
  Type: boolean
  
  Example:
  
  ```json
  false
  ```

- `name` (required)
  Type: string, string
  
  Example:
  
  ```json
  "Bills"
  ```

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

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

- `auto_budget_type` (optional)
  Reference: [AutoBudgetType](https://sourcey-firefly.pages.dev/api/models/autobudgettype/index.md); Type: string, string; nullable
  
  The type of auto-budget that Firefly III must create.
  
  enum: ["reset","rollover","none",null]
  
  Example:
  
  ```json
  "reset"
  ```

- `auto_budget_period` (optional)
  Reference: [AutoBudgetPeriod](https://sourcey-firefly.pages.dev/api/models/autobudgetperiod/index.md); Type: string, string; nullable
  
  Period for the auto budget
  
  enum: ["daily","weekly","monthly","quarterly","half-year","yearly",null]
  
  Example:
  
  ```json
  "monthly"
  ```

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

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

- `auto_budget_amount` (optional)
  Type: string, amount; nullable
  
  The amount for the auto-budget, if set.
  
  Example:
  
  ```json
  "-1012.12"
  ```

- `pc_auto_budget_amount` (optional)
  Type: string, amount; nullable
  
  The amount for the auto-budget, if set in the primary currency of the administration.
  
  Example:
  
  ```json
  "-1012.12"
  ```

- `spent` (optional)
  Type: array
  
  Information on how much was spent in this budget. Is only filled in when the start and end date are submitted.
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object

- `pc_spent` (optional)
  Type: array
  
  Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration.
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object