Create a budget

Creates a budget for a given accountId.

SecurityCommonAuth

Request

query Parameters

accountId

required

string

The ID of the account to work with.

Example: accountId=F50091

Request Body schema: application/json

Body

parentId	string or null <uuid> <= 36 characters The ID of the budget to work with.
boxId	string The ID of the box to work with.
name	string <= 75 characters The name of the budget.
features required	Array of strings Items Enum: "payments" "peopleCards" "budgetCards"
currencies	Array of strings Items Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SEK" "SGD" "SHN" "SLL" "SOS" "SRD" "SSP" "STN" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMK" "ZMW" "ZWD"
type required	string or null The budget type. Enum: "accountBalance" "forwardDeposits" "shared" "individual"
status	string Enum: "active" "archived" "hidden"
personaId	string or null <uuid> <= 36 characters The ID of the persona that must be assigned to the budget. Required only for`individual` budgets.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

post/budgets

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"parentId": "775596ae-2624-40af-a9dc-9756110a4a03",
"boxId": "a43231c221",
"name": "Team Party",
"features": ["payments"
],
"currencies": ["USD"
],
"type": "accountBalance",
"status": "active",
"personaId": "0387819c-a33e-454c-ad84-570bf53cd75f"
}

Response samples

application/json

{"id": "775596ae-2624-40af-a9dc-9756110a4a03",
"boxId": "a43231c221",
"name": "Team Party",
"accountId": "F50091",
"parentId": "775596ae-2624-40af-a9dc-9756110a4a03",
"feature": [{"id": "string",
"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"BudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"payments": true,
"budgetCards": true,
"peopleCards": true,
"forwardDeposits": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"currency": [{"id": "string",
"boxCurrencyId": 0,
"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"BudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"currencyCode": "USD",
"local": "unique",
"international": "unique",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"balance": [{"id": "string",
"currencyCode": "USD",
"availableBalance": 10,
"lastUpdatedSequentialId": 0,
"currency": "USD",
"BudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"ledgerBalance": 50,
"pendingBalance": 40,
"allocatedBalance": 10,
"ledgerAndAllocatedBalance": 60,
"activeCurrencyOnBudget": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"totalBalance": [{"id": "string",
"currencyCode": "USD",
"availableBalance": 10,
"lastUpdatedSequentialId": 0,
"currency": "USD",
"BudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"ledgerBalance": 50,
"pendingBalance": 40,
"allocatedBalance": 10,
"ledgerAndAllocatedBalance": 60,
"activeCurrencyOnBudget": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"children": [{"id": "string",
"currencyCode": "USD",
"availableBalance": 10,
"lastUpdatedSequentialId": 0,
"currency": "USD",
"BudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"ledgerBalance": 50,
"pendingBalance": 40,
"allocatedBalance": 10,
"ledgerAndAllocatedBalance": 60,
"activeCurrencyOnBudget": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"details": [{"currency": "USD",
"sortCode": "12-34-56",
"accountNumber": "12345678",
"ibans": [{"iban": "GB26SPPV23188497371875",
"bic": "BARCGB22"
}
],
"accountName": "Equals Money",
"bankName": "SPECTRUM PAYMENT SERVICES",
"bankAddress": "Vintners Place, 68 Upper Thames St, London, EC4V 3BJ, United Kingdom",
"balanceReference": "Balance reference"
}
],
"settlementDetails": {"currencyDetails": [{"currencyCode": "USD",
"local": {"accountIdentifier": "31510604",
"bankIdentifier": "10-00-00",
"payeeName": "ACME",
"bankName": "Brilliant Bank",
"bankAddress": {"addressLine1": "41 Middle Street",
"addressLine2": "string",
"addressLine3": "string",
"city": "Enfield",
"postcode": "EN1 3JY",
"country": "United Kingdom"
}
},
"international": {"accountIdentifier": "31510604",
"bankIdentifier": "10-00-00",
"payeeName": "ACME",
"bankName": "Brilliant Bank",
"bankAddress": {"addressLine1": "41 Middle Street",
"addressLine2": "string",
"addressLine3": "string",
"city": "Enfield",
"postcode": "EN1 3JY",
"country": "United Kingdom"
}
}
}
],
"balanceReference": "Balance reference"
},
"individualBudgetHolder": {"id": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"personaId": "775596ae-2624-40af-a9dc-9756110a4a04",
"createdAt": "2023-01-30T08:30:00Z"
},
"priority": 1,
"level": 1,
"type": "accountBalance",
"status": "active",
"allowCurrencyAlignment": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}