# BudgetLimitProperties

Type: object

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

- `start` (optional)
  Type: string, date-time
  
  Start date of the budget limit.
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `end` (optional)
  Type: string, date-time
  
  End date of the budget limit.
  
  Example:
  
  ```json
  "2026-10-31T23:59:59+00:00"
  ```

- `budget_id` (optional)
  Type: string, string
  
  The budget ID of the associated budget.
  
  readOnly: true
  
  Example:
  
  ```json
  "23"
  ```

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

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

- `pc_amount` (optional)
  Type: string, amount; nullable
  
  The amount of this budget limit in the user's primary currency, if the original amount is in a different currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "123.45"
  ```

- `period` (optional)
  Type: string, string; nullable
  
  Period of the budget limit. Only used when auto-generated by auto-budget.
  
  readOnly: true
  
  Example:
  
  ```json
  "monthly"
  ```

- `spent` (optional)
  Type: array
  
  Amount(s) spent in the currencies in the database for this budget limit.
  
  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 budget limit.
  
  readOnly: true
  
  Items:
    Reference: [ArrayEntryWithCurrencyAndSum](https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md); Type: object

- `notes` (optional)
  Type: string, string; nullable
  
  Some notes for this specific budget limit.
  
  Example:
  
  ```json
  "Some example notes"
  ```