FIfirefly-iii
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

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/budgets
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

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.

Example response

{
  "data": {
    "type": "budgets",
    "id": "2",
    "attributes": {
      "created_at": "2025-12-01T00:00:00+00:00",
      "updated_at": "2025-12-01T00:00:00+00:00",
      "name": "Bills",
      "order": 5,
      "notes": "Some notes",
      "auto_budget_type": "reset",
      "auto_budget_period": "monthly",
      "object_group_id": "5",
      "object_group_order": 5,
      "object_group_title": "Example Group",
      "object_has_currency_setting": true,
      "currency_id": "5",
      "currency_name": "Euro",
      "currency_code": "EUR",
      "currency_symbol": "$",
      "currency_decimal_places": 2,
      "primary_currency_id": "5",
      "primary_currency_name": "Euro",
      "primary_currency_code": "EUR",
      "primary_currency_symbol": "$",
      "primary_currency_decimal_places": 2,
      "auto_budget_amount": "-1012.12",
      "pc_auto_budget_amount": "-1012.12",
      "spent": [
        {
          "currency_id": "5",
          "currency_code": "USD",
          "currency_symbol": "$",
          "currency_decimal_places": 2,
          "sum": "123.45"
        }
      ],
      "pc_spent": [
        {
          "currency_id": "5",
          "currency_code": "USD",
          "currency_symbol": "$",
          "currency_decimal_places": 2,
          "sum": "123.45"
        }
      ]
    }
  }
}

Changes

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