# List budgets

Endpoint: GET /v1/businesses/{client_id}/budgets
Version: v1
Security: BearerAuth

## Query parameters:

  - `offset` (integer)
    Offset to retrieve items from.
    Example: 50

  - `limit` (integer)
    Number of items per page.
    Example: 50

  - `is_deleted` (boolean)
    Whether the resource is deleted.

  - `budget_type` (string)
    The type of budget.
    Enum: "BUDGET", "SUBSCRIPTION"

  - `has_member_limits` (boolean)
    Whether the budget has member limits.

## Path parameters:

  - `client_id` (integer, required)
    The ID of the business.
    Example: 123

## Response 200 fields (application/json):

  - `count` (integer)
    The total number of budgets that match the query.
    Example: 100

  - `next` (string)
    The URL to the next page of budgets.
    Example: "offset=50&limit=50"

  - `previous` (string)
    The URL to the previous page of budgets.
    Example: "offset=0&limit=50"

  - `results` (array)

  - `results.id` (string, required)
    The ID of the budget.
    Example: "e33b7c61-5124-4ba0-b238-e4c573133715"

  - `results.name` (string, required)
    The name of the budget.
    Example: "Sales Team"

  - `results.budget_type` (string, required)
    The type of budget.
    Enum: same as `budget_type` (2 values)

  - `results.available_amount` (number, required)
    The available amount of the budget.
    Example: 800

  - `results.spent_amount` (number, required)
    The amount of the budget that has been spent.
    Example: 200

  - `results.reset_amount` (number, required)
    The reset amount of the budget.
    Example: 1000

  - `results.reset_period` (string, required)
    The reset cadence for the budget. JULY_FINANCIAL_YEAR resets on 1 July;
APRIL_FINANCIAL_YEAR resets on 1 April.
    Enum: "DAILY", "WEEKLY", "FORTNIGHTLY", "MONTHLY", "QUARTERLY", "ANNUALLY", "JULY_FINANCIAL_YEAR", "APRIL_FINANCIAL_YEAR", "NEVER"

  - `results.current_period_start` (string,null, required)
    The start date of the current period in UTC.
    Example: "2024-01-01T00:00:00Z"

  - `results.current_period_end` (string,null, required)
    The end date of the current period in UTC.
    Example: "2024-01-31T23:59:59Z"

  - `results.has_member_limits` (boolean, required)
    Whether the budget has member limits.

  - `results.rollover_funds` (boolean, required)
    When true, unspent balance rolls over to the next period instead of resetting.

  - `results.limit_categories` (boolean, required)
    When true, only categories listed in categories are visible on
the budget. When false, all enabled business categories are visible.

  - `results.categories` (array, required)
    Categories currently visible on the budget. Returns an empty array
when limit_categories is false (no restriction in force).

  - `results.categories.id` (string, required)
    Example: "7f183748-c7fb-428a-9b2a-603a03dcabdb"

  - `results.categories.name` (string, required)
    Example: "Travel"

  - `results.custom_fields` (array, required)
    Custom fields attached to this budget.

  - `results.custom_fields.id` (string, required)
    The id of the custom field.
    Example: "44b2add5-eeb2-456c-8918-9bb362b0e896"

  - `results.custom_fields.name` (string, required)
    Example: "Department"

  - `results.custom_fields.allow_options` (array,null, required)
    For LIST-type custom fields, the list-item ids selectable on
this budget. null means no per-budget restriction (all
enabled options are selectable). An empty array means no
options are selectable on this budget. Always null for
FREE_TEXT custom fields.

  - `results.is_deleted` (boolean, required)
    Whether the budget is deleted.

  - `results.created` (string, required)
    The date and time when the budget was created in UTC.
    Example: "2024-01-01T00:00:00Z"

  - `results.updated` (string, required)
    The date and time when the budget was last updated in UTC.
    Example: "2024-01-01T00:00:00Z"


## Response 401 fields

## Response 403 fields