Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Budgets

Get budget

get/v1/businesses/{client_id}/budgets/{budget_id}

Path parameters

client_idinteger required
Example:123

The ID of the business.

budget_idstring required

The ID of the budget.

Response

OK

idstring required

The ID of the budget.

namestring required

The name of the budget.

budget_type'BUDGET' | 'SUBSCRIPTION' required

The type of budget.

available_amountnumber required

The available amount of the budget.

spent_amountnumber required

The amount of the budget that has been spent.

reset_amountnumber required

The reset amount of the budget.

reset_period'DAILY' | 'WEEKLY' | 'FORTNIGHTLY' | 'MONTHLY' | 'QUARTERLY' | 'ANNUALLY' | 'JULY_FINANCIAL_YEAR' | 'APRIL_FINANCIAL_YEAR' | 'NEVER' required

The reset cadence for the budget. JULY_FINANCIAL_YEAR resets on 1 July; APRIL_FINANCIAL_YEAR resets on 1 April.

current_period_startstring date-time nullable required

The start date of the current period in UTC.

current_period_endstring date-time nullable required

The end date of the current period in UTC.

has_member_limitsboolean required

Whether the budget has member limits.

rollover_fundsboolean required

When true, unspent balance rolls over to the next period instead of resetting.

limit_categoriesboolean required

When true, only categories listed in categories are visible on the budget. When false, all enabled business categories are visible.

is_deletedboolean required

Whether the budget is deleted.

createdstring date-time required

The date and time when the budget was created in UTC.

updatedstring date-time required

The date and time when the budget was last updated in UTC.

Example response

{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "name": "Sales Team",
  "budget_type": "BUDGET",
  "available_amount": 800,
  "spent_amount": 200,
  "reset_amount": 1000,
  "reset_period": "MONTHLY",
  "current_period_start": "2024-01-01T00:00:00Z",
  "current_period_end": "2024-01-31T23:59:59Z",
  "categories": [
    {
      "id": "7f183748-c7fb-428a-9b2a-603a03dcabdb",
      "name": "Travel"
    }
  ],
  "custom_fields": [
    {
      "id": "44b2add5-eeb2-456c-8918-9bb362b0e896",
      "name": "Department"
    }
  ],
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z"
}