---
title: "Update existing budget."
method: PUT
path: "/v1/budgets/{id}"
tags: ["budgets"]
---

# Update existing budget.

`PUT /v1/budgets/{id}`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/budgets/{id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

Update existing budget. This endpoint cannot be used to set budget amount limits.

## Path parameters

- `id` string, required

## Headers

- `X-Trace-Id` string, uuid

## Request body

- BudgetUpdate
  - `name` string, string, required
  - `active` boolean
  - `order` integer
  - `notes` string, string, nullable
  - `fire_webhooks` boolean: 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_id` string, string, nullable: Use either currency_id or currency_code. Defaults to the user's financial administration's currency.
  - `auto_budget_currency_code` string, string, nullable: Use either currency_id or currency_code. Defaults to the user's financial administration's currency.
  - `auto_budget_amount` string, amount, nullable
  - `auto_budget_period` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'half-year' | 'yearly' | 'null', string, nullable: Period for the auto budget

## Response `200`

Updated budget stored, result in response

- BudgetSingle
  - `data` BudgetRead, required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` BudgetProperties, required
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `active` boolean
      - `name` string, string, required
      - `order` integer
      - `notes` string, string, nullable
      - `auto_budget_type` 'reset' | 'rollover' | 'none' | 'null', string, nullable: The type of auto-budget that Firefly III must create.
      - `auto_budget_period` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'half-year' | 'yearly' | 'null', string, nullable: Period for the auto budget
      - `object_group_id` string, string, nullable: The group ID of the group this object is part of. NULL if no group.
      - `object_group_order` integer, nullable: The order of the group. At least 1, for the highest sorting.
      - `object_group_title` string, string, nullable: The name of the group. NULL if no group.
      - `object_has_currency_setting` boolean: Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.
      - `currency_id` string, string: The currency ID of the currency associated with this object.
      - `currency_name` string, string: The currency name of the currency associated with this object.
      - `currency_code` string, string: The currency code of the currency associated with this object.
      - `currency_symbol` string, string
      - `currency_decimal_places` integer
      - `primary_currency_id` string, string: The currency ID of the administration's primary currency.
      - `primary_currency_name` string, string: The currency name of the administration's primary currency.
      - `primary_currency_code` string, string: The currency code of the administration's primary currency.
      - `primary_currency_symbol` string, string: The currency symbol of the administration's primary currency.
      - `primary_currency_decimal_places` integer: The currency decimal places of the administration's primary currency.
      - `auto_budget_amount` string, amount, nullable: The amount for the auto-budget, if set.
      - `pc_auto_budget_amount` string, amount, nullable: The amount for the auto-budget, if set in the primary currency of the administration.
      - `spent` ArrayEntryWithCurrencyAndSum[]: Information on how much was spent in this budget. Is only filled in when the start and end date are submitted.
        - `currency_id` string, string
        - `currency_code` string, string
        - `currency_symbol` string, string
        - `currency_decimal_places` integer: Number of decimals supported by the currency
        - `sum` string, amount: The amount earned, spent or transferred.
      - `pc_spent` ArrayEntryWithCurrencyAndSum[]: Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration.
        - `currency_id` string, string
        - `currency_code` string, string
        - `currency_symbol` string, string
        - `currency_decimal_places` integer: Number of decimals supported by the currency
        - `sum` string, amount: The amount earned, spent or transferred.

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `422`: Validation error. The body will have the exact details.
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-1.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-1/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-1/revisions/d60bf328844a?raw)