Sign in
budgets

Store a new budget

Creates a new budget. The data required can be submitted as a JSON body or as a list of parameters.

post/v1/budgets

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

namestring string required
activeboolean
orderinteger
notesstring string nullable
fire_webhooksboolean

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

auto_budget_type'reset' | 'rollover' | 'none' | 'null' string nullable

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

auto_budget_currency_idstring string nullable

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

auto_budget_currency_codestring string nullable

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

auto_budget_amountstring amount nullable
auto_budget_period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'half-year' | 'yearly' | 'null' string nullable

Period for the auto budget

Example request

{
  "name": "Bills",
  "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"
}

Response

New budget stored, result in response.

Changes

No recorded changes to this endpoint across all 1 revision of this API.