Models

BudgetStore

object

namestringrequired

Example

Bills

activeboolean

Example

false

orderinteger<int32>read only

Example

notesstring | null

Example

Some notes

fire_webhooksbooleantrue

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

Example

true

auto_budget_typeAutoBudgetType | nullresetrollovernonenull

The type of auto-budget that Firefly III must create.

Example

reset

auto_budget_currency_idstring | null

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

Example

auto_budget_currency_codestring | null

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

Example

EUR

auto_budget_amountstring<amount> | null

Example

-1012.12

auto_budget_periodAutoBudgetPeriod | nulldailyweeklymonthlyquarterlyhalf-yearyearlynull

Period for the auto budget

Example

monthly

Example

{
  "name": "Bills",
  "active": false,
  "order": 5,
  "notes": "Some notes",
  "fire_webhooks": true,
  "auto_budget_type": "reset",
  "auto_budget_currency_id": "12",
  "auto_budget_currency_code": "EUR",
  "auto_budget_amount": "-1012.12",
  "auto_budget_period": "monthly"
}