List all budgets

Returns a list of all budgets on an account. Ordered alphabetically.

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

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
limit
integer [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

Example: limit=200
offset
integer
Default: 0

The number of items to skip before returning results.

Example: offset=100
string or Array of strings

The ID of the budget to work with. Use commas to pass multiple values. Has to be URL encoded.

string or Array of strings

Optional embeds to include when returning the budgets.

Enum: "balance" "budgetHierarchy" "settlementDetails"
Example: include=balance,budgetHierarchy
search
string <= 100 characters

The term to search the records for.

Example: search=Cesar+Treutel
type
string

The type of budget to filter results by.

Enum: "accountBalance" "forwardDeposits" "shared" "individual"
currencyCode
string^[A-Z]{3}$

The currency code, in ISO-4217 format.

Example: currencyCode=USD
lowBalanceAlertEnabled
string

Whether to filter results by low balance alert enabled.

Enum: "true" "false"
personId
string <uuid> <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
Responses
200

OK

get/budgets
Request samples 
Response samples 
application/json
{
  • "limit": 200,
  • "offset": 100,
  • "count": 67,
  • "rows": [
    ]
}