FIfirefly-iii
budgets

Get a single budget.

Get a single budget. If the start date and end date are submitted as well, the "spent" array will be updated accordingly.

get/v1/budgets/{id}

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/budgets/{id}
  • 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 requested budget.

Query parameters

startstring date
Example:2025-11-01

A date formatted YYYY-MM-DD, to get info on how much the user has spent.

endstring date
Example:2025-11-30

A date formatted YYYY-MM-DD, to get info on how much the user has spent.

Headers

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

Unique identifier associated with this request.

Response

The requested budget

Example response

{
  "data": {
    "type": "budgets",
    "id": "2",
    "attributes": {
      "created_at": "2025-11-01T00:00:00+00:00",
      "updated_at": "2025-11-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.