---
title: "Retrieve a list of budgets"
method: GET
path: "/Budgets"
tags: ["Accounting"]
---

# Retrieve a list of budgets

`GET /Budgets`

## Query parameters

- `IDs` string
- `DateTo` string, date
- `DateFrom` string, date

## Response `200`

Success - return response of type Budgets array with 0 to N Budgets

- Budgets
  - `Budgets` Budget[]
    - `BudgetID` string, uuid — Xero identifier
    - `Type` 'OVERALL' | 'TRACKING' — Type of Budget. OVERALL or TRACKING
    - `Description` string — The Budget description
    - `UpdatedDateUTC` string — UTC timestamp of last update to budget
    - `BudgetLines` BudgetLine[]
      - `AccountID` string, uuid — See Accounts
      - `AccountCode` string — See Accounts
      - `BudgetBalances` BudgetBalance[]
        - `Period` string — Period the amount applies to (e.g. “2019-08”)
        - `Amount` number, double — LineItem Quantity
        - `UnitAmount` number, double — Budgeted amount
        - `Notes` string — Any footnotes associated with this balance
    - `Tracking` TrackingCategory[]
      - `TrackingCategoryID` string, uuid — The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
      - `TrackingOptionID` string, uuid — The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f
      - `Name` string — The name of the tracking category e.g. Department, Region (max length = 100)
      - `Option` string — The option name of the tracking option e.g. East, West (max length = 100)
      - `Status` 'ACTIVE' | 'ARCHIVED' | 'DELETED' — The status of a tracking category
      - `Options` TrackingOption[] — See Tracking Options
        - `TrackingOptionID` string, uuid — The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a
        - `Name` string — The name of the tracking option e.g. Marketing, East (max length = 100)
        - `Status` 'ACTIVE' | 'ARCHIVED' | 'DELETED' — The status of a tracking option
        - `TrackingCategoryID` string, uuid — Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

---

[API](https://skmtc.net/xeroapi/apis/xero-accounting-api.md) · [All operations](https://skmtc.net/xeroapi/apis/xero-accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xeroapi/xero-accounting-api/versions/dc231cafd8de/schema)