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> (budgetId) <= 36 characters

The ID of the budget to work with.

Example: b489ea2c-0dd1-4fb1-b345-de5a596a5527
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50072
include
Array of any

Optional embeds to include when returning the budget.

Items Enum: "children" "balance" "details" "detailsActive" "budgetHierarchy" "settlementDetails"
Example: include=balance, children, budgetHierarchy
currencyCode
string (currencyCode) ^[A-Z]{3}$

The currency code, in ISO-4217 format.

Example: currencyCode=USD
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/budgets/{budgetId}
Request samples 
Response samples 
application/json
{
  • "id": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
  • "boxId": "string",
  • "name": "Team Party",
  • "accountId": "F50072",
  • "parentId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
  • "feature": [
    ],
  • "currency": [
    ],
  • "balance": [
    ],
  • "totalBalance": [
    ],
  • "children": [
    ],
  • "details": [
    ],
  • "settlementDetails": {
    },
  • "individualBudgetHolder": { },
  • "priority": 1,
  • "level": 1,
  • "type": "shared",
  • "status": "active",
  • "allowCurrencyAlignment": false,
  • "createdAt": "2023-01-30T08:30:00Z",
  • "updatedAt": "2023-01-30T08:30:00Z"
}