# BudgetLimitStore

Type: object

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

- `currency_id` (optional)
  Type: string, string
  
  Use either currency_id or currency_code. Defaults to the user's primary currency.
  
  Example:
  
  ```json
  "5"
  ```

- `currency_code` (optional)
  Type: string, string
  
  Use either currency_id or currency_code. Defaults to the user's primary currency.
  
  Example:
  
  ```json
  "EUR"
  ```

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

- `start` (required)
  Type: string, date
  
  Start date of the budget limit.
  
  Example:
  
  ```json
  "2026-10-01"
  ```

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

- `end` (required)
  Type: string, date
  
  End date of the budget limit.
  
  Example:
  
  ```json
  "2026-10-31"
  ```

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

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

- `fire_webhooks` (optional)
  Type: boolean
  
  Whether or not to fire the webhooks that are related to this event.
  
  default: true
  
  Example:
  
  ```json
  true
  ```