Create a budget

Creates a budget for a given accountId.

SecurityCommonAuth
Request
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50072
Request Body schema: application/json
required
parentId
string or null <uuid> <= 36 characters

The ID of the parent budget. Required for shared and individual budgets, can be null only for accountBalance and forwardDeposits.

name
string <= 75 characters

The name of the budget.

features
required
Array of strings (feature)

Array of all the features that are enabled for this budget. Only features enabled on an account can be enabled on a budget.

Items Enum: "payments" "peopleCards" "budgetCards"
currencies
required
Array of strings (currencies) non-empty

Array of all the currencies that are enabled for this budget.

type
required
string or null

The budget type.

Enum: "accountBalance" "shared" "individual" null
status
any (status)

The status of a budget.

Enum: "active" "archived" "hidden"
boxId
string (boxId)

The ID of the box to work with.

personaId
string or null <uuid> <= 36 characters

The ID of the persona that must be assigned to the budget. Required only forindividual budgets.

Responses
201

Created

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

post/budgets
Request samples
application/json
{
  • "parentId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
  • "name": "Team Party",
  • "features": [
    ],
  • "currencies": [
    ],
  • "type": "shared",
  • "status": "active",
  • "boxId": "a43231c221",
  • "personaId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527"
}
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"
}