Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Query Parameters

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

features
enum<string>[]
required

The feature in a budget.

Available options:
payments,
peopleCards,
budgetCards
type
enum<string> | null
required

The budget type.

Available options:
accountBalance,
forwardDeposits,
shared,
individual
parentId
string<uuid> | null

The ID of the budget to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

boxId
string

The ID of the box to work with.

Example:

"a43231c221"

name
string

The name of the budget.

Maximum string length: 75
Example:

"Team Party"

currencies
enum<string>[]
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
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
status
enum<string>
Available options:
active,
archived,
hidden
personaId
string<uuid> | null

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

Maximum string length: 36

Response

201 - application/json

Created

id
string<uuid> | null
required

The ID of the budget to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

name
string
required

The name of the budget.

Maximum string length: 256
Example:

"Team Party"

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

boxId
string | null

The ID of the box to work with.

Example:

"a43231c221"

parentId
string<uuid> | null

The ID of the budget to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

feature
object[]
currency
object[]
balance
object[] | null
totalBalance
object[] | null
children
object[] | null
details
object[]
deprecated

Legacy. The box bank account details, included when details is passed to the include query parameter. Prefer settlementDetails instead.

settlementDetails
object | null

The settlement details.

individualBudgetHolder
object | null
priority
number

Defines the priority of a budget, where 1 is the highest priority.

Example:

1

level
number

Defines the hierarchy level of a budget, where 0 is the highest level (accountBalance).

Example:

1

type
enum<string>

The budget type.

Available options:
accountBalance,
forwardDeposits,
shared,
individual
status
enum<string>
Available options:
active,
archived,
hidden
allowCurrencyAlignment
boolean

Whether or not to enable currency alignment on a 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.

createdAt
string<date-time>

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAt
string<date-time>

The date the Resource was last modified. ISO 8601 format without milliseconds.