---
title: "List all available budget amounts."
method: GET
path: "/v1/available-budgets"
tags: ["available_budgets"]
---

# List all available budget amounts.

`GET /v1/available-budgets`

## Request

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

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.

## Query parameters

- `limit` integer
- `page` integer
- `start` string, date
- `end` string, date

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of available budget amounts.

- AvailableBudgetArray
  - `data` AvailableBudgetRead[], required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` AvailableBudgetProperties, required
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `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.
      - `amount` string, amount: The amount of this available budget in the currency of this available budget.
      - `pc_amount` string, amount: The amount of this available budget in the primary currency (pc) of this administration.
      - `start` string, date-time: Start date of the available budget.
      - `end` string, date-time: End date of the available budget.
      - `spent_in_budgets` ArrayEntryWithCurrencyAndSum[]
        - `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_in_budgets` ArrayEntryWithCurrencyAndSum[]: The amount spent in budgets in the primary currency (pc) of this 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.
      - `spent_outside_budgets` ArrayEntryWithCurrencyAndSum[]
        - `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_outside_budgets` ArrayEntryWithCurrencyAndSum[]: The amount spent outside of budgets in the primary currency (pc) of this 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.
  - `meta` Meta, required
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `500`: Internal exception

---

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