available_budgets

List all available budget amounts.

Firefly III calculates the total amount of money budgeted in so-called "available budgets". This endpoint returns all of these amounts and the periods for which they are calculated.

get/v1/available-budgets

Request

Base URL
https://demo.firefly-iii.org/api
URL
https://demo.firefly-iii.org/api/v1/available-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

Query parameters

limitinteger

Example:10

Number of items per page. The default pagination is per 50 items.

pageinteger

Example:1

Page number. The default pagination is per 50 items.

startstring date

Example:2026-03-01

A date formatted YYYY-MM-DD.

endstring date

Example:2026-03-31

A date formatted YYYY-MM-DD.

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of available budget amounts.

Example response

{
  "data": [
    {
      "type": "available_budgets",
      "id": "2",
      "attributes": {
        "created_at": "2026-03-01T00:00:00+00:00",
        "updated_at": "2026-03-01T00:00:00+00:00",
        "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",
        "start": "2026-03-01T00:00:00+00:00",
        "end": "2026-03-31T23:59:59+00:00",
        "spent_in_budgets": [
          {
            "currency_id": "5",
            "currency_code": "USD",
            "currency_symbol": "$",
            "currency_decimal_places": 2,
            "sum": "123.45"
          }
        ],
        "pc_spent_in_budgets": [
          {
            "currency_id": "5",
            "currency_code": "USD",
            "currency_symbol": "$",
            "currency_decimal_places": 2,
            "sum": "123.45"
          }
        ],
        "spent_outside_budgets": [
          {
            "currency_id": "5",
            "currency_code": "USD",
            "currency_symbol": "$",
            "currency_decimal_places": 2,
            "sum": "123.45"
          }
        ],
        "pc_spent_outside_budgets": [
          {
            "currency_id": "5",
            "currency_code": "USD",
            "currency_symbol": "$",
            "currency_decimal_places": 2,
            "sum": "123.45"
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 20,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes

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