FIfirefly-iii
budgets

Update existing budget limit.

Update existing budget limit.

put/v1/budgets/{id}/limits/{limitId}

Request

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

Path parameters

idstring required
Example:123

The ID of the budget. The budget limit MUST be associated to the budget ID.

limitIdstring required
Example:123

The ID of the budget limit. The budget limit MUST be associated to the budget ID.

Headers

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

Unique identifier associated with this request.

Request body

created_atstring date-time
updated_atstring date-time
startstring date-time

Start date of the budget limit.

endstring date-time

End date of the budget limit.

budget_idstring string

The budget ID of the associated budget.

object_has_currency_settingboolean

Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.

currency_idstring string

The currency ID of the currency associated with this object.

currency_namestring string

The currency name of the currency associated with this object.

currency_codestring string

The currency code of the currency associated with this object.

currency_symbolstring string
currency_decimal_placesinteger
primary_currency_idstring string

The currency ID of the administration's primary currency.

primary_currency_namestring string

The currency name of the administration's primary currency.

primary_currency_codestring string

The currency code of the administration's primary currency.

primary_currency_symbolstring string

The currency symbol of the administration's primary currency.

primary_currency_decimal_placesinteger

The currency decimal places of the administration's primary currency.

periodstring string nullable

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

amountstring amount
pc_amountstring amount nullable

The amount of this budget limit in the user's primary currency, if the original amount is in a different currency.

spentstring amount nullable

Will be in the primary currency if this is turned on by the user.

notesstring string nullable

Some notes for this specific budget limit.

Example request

{
  "created_at": "2025-10-01T00:00:00+00:00",
  "updated_at": "2025-10-01T00:00:00+00:00",
  "start": "2025-10-01T00:00:00+00:00",
  "end": "2025-10-31T23:59:59+00:00",
  "budget_id": "23",
  "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,
  "period": "monthly",
  "amount": "123.45",
  "pc_amount": "123.45",
  "spent": "-1012.12",
  "notes": "Some example notes"
}

Response

Updated budget limit stored, result in response

Example response

{
  "data": {
    "type": "budget_limits",
    "id": "2",
    "attributes": {
      "created_at": "2025-10-01T00:00:00+00:00",
      "updated_at": "2025-10-01T00:00:00+00:00",
      "start": "2025-10-01T00:00:00+00:00",
      "end": "2025-10-31T23:59:59+00:00",
      "budget_id": "23",
      "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,
      "amount": "123.45",
      "pc_amount": "123.45",
      "period": "monthly",
      "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"
        }
      ],
      "notes": "Some example notes"
    }
  }
}

Changes

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