Update a budget's details

Updates the details of a given budget.

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
Request Body schema: application/json
required
non-empty
object non-empty

Details about the feature(s) to enable for the budget.

allowCurrencyAlignment
boolean

Whether or not currency alignment is enabled for the budget. Currency alignment allows a cardholder to pay in a currency that is different from the budget's currency, with Equals Money doing the conversion.

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

patch/budgets/{budgetId}
Request samples
application/json
{
  • "feature": {
    },
  • "allowCurrencyAlignment": false
}
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"
}