Models

BudgetLimitStore

object

currency_idstring

Use either currency_id or currency_code. Defaults to the user's primary currency.

Example

currency_codestring

Use either currency_id or currency_code. Defaults to the user's primary currency.

Example

EUR

budget_idstringrequiredread only

The budget ID of the associated budget.

Example

startstring<date>required

Start date of the budget limit.

Example

2026-10-01

periodstring | nullread only

Period of the budget limit. Only used when auto-generated by auto-budget.

Example

monthly

endstring<date>required

End date of the budget limit.

Example

2026-10-31

amountstring<amount>required

Example

123.45

notesstring | null

Some notes for this specific budget limit.

Example

Some example notes

fire_webhooksbooleantrue

Whether or not to fire the webhooks that are related to this event.

Example

true

Example

{
  "currency_id": "5",
  "currency_code": "EUR",
  "budget_id": "23",
  "start": "2026-10-01",
  "period": "monthly",
  "end": "2026-10-31",
  "amount": "123.45",
  "notes": "Some example notes",
  "fire_webhooks": true
}