> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Budgets Overview

> Use these endpoints to create and manage budgets for your end users.

You can create a budget for a specific category or autogenerate a budget for several categories based on existing transactions.

Each budget has a `category_guid`, relating to one of the [categories](/api-reference/platform-api/reference/categories#default-categories-and-subcategories).

## Budget Fields

| Field                  | Data Type | Description                                                                                                                                                                                       |
| :--------------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `amount`               | Decimal   | A goal amount set by the user for a category's transaction total during a month.                                                                                                                  |
| `category_guid`        | String    | Unique identifier for the budget category. Defined by MX.                                                                                                                                         |
| `created_at`           | String    | Date and time the budget was created, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).                                                                             |
| `guid`                 | String    | Unique identifier for the budget. Defined by MX.                                                                                                                                                  |
| `is_exceeded`          | Boolean   | If the budget has been exceeded, this field will be true. Otherwise, this field will be false.                                                                                                    |
| `is_off_track`         | Boolean   | If the budget is off track, this field will be true. Otherwise, this field will be false.                                                                                                         |
| `metadata`             | String    | Additional information a partner can store on the budget.                                                                                                                                         |
| `name`                 | String    | The name of the budget that is visible to the user (i.e., "Food", "Bills", "Entertainment", etc).                                                                                                 |
| `off_track_percentage` | Decimal   | The percentage amount of off-track spending. (Deprecated).                                                                                                                                        |
| `parent_guid`          | String    | Unique identifier for the parent budget. Defined by MX.                                                                                                                                           |
| `percent_spent`        | Decimal   | The percentage of a budget that has been spent during the current calendar month. Calculated as: (`transaction_total` / `amount`) \* 100. A value of zero will be returned when `amount` is zero. |
| `projected_spending`   | Decimal   | The projected amount of spending for the budget.                                                                                                                                                  |
| `revision`             | Integer   | The revision number of this budget record.                                                                                                                                                        |
| `transaction_total`    | Decimal   | The cumulative amount of all transactions under the budget.                                                                                                                                       |
| `updated_at`           | String    | Date and time the budget was updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).                                                                             |
| `user_guid`            | String    | Unique identifier for the user. Defined by MX.                                                                                                                                                    |