Retrieve budget details

Returns the details of a given budget.

Use the include parameter to return optional information such as available, pending and ledger balances, and settlement details.

SecurityCommonAuth
Request
path Parameters
budgetId
required
string <uuid> <= 36 characters

The ID of the budget to work with.

Example: 775596ae-2624-40af-a9dc-9756110a4a03
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
include
Array of strings
Enum: "children" "balance" "details" "detailsActive" "budgetHierarchy" "settlementDetails"
currencyCode
string^[A-Z]{3}$

The currency code, in ISO-4217 format.

Example: currencyCode=USD
Responses
200

OK

get/budgets/{budgetId}
Request samples 
Response samples 
application/json
{
  • "id": "775596ae-2624-40af-a9dc-9756110a4a03",
  • "boxId": "a43231c221",
  • "name": "Team Party",
  • "accountId": "F50091",
  • "parentId": "775596ae-2624-40af-a9dc-9756110a4a03",
  • "feature": [
    ],
  • "currency": [
    ],
  • "balance": [
    ],
  • "totalBalance": [
    ],
  • "children": [
    ],
  • "details": [
    ],
  • "settlementDetails": {
    },
  • "individualBudgetHolder": {
    },
  • "priority": 1,
  • "level": 1,
  • "type": "accountBalance",
  • "status": "active",
  • "allowCurrencyAlignment": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}