v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

budgets

Add or update a budget member

Add a new user member to an existing budget. You can also update details about an existing user member assigned to the budget.

put/v3/spend/budgets/{budgetId}/members/{userId}

Path parameters

budgetIdstring required

BILL-generated ID or UUID of the budget

Example:{{se_budget_uuid}}

userIdstring required

BILL-generated ID or UUID of the user

Example:{{se_user_uuid}}

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Request body

limitnumber

Funds assigned to the user in the current budget period.

Note: This field is required with shareBudgetFunds is set as false.

recurringLimitnumber

Funds assigned to the user in all future budget periods.

Note: This field is required when shareBudgetFunds is set as false.

role'MEMBER' | 'OWNER' | 'OBSERVER'

Budget user role

shareBudgetFundsboolean

Set as true to share all the budget funds with the user.

Note: You cannot set this field as true when either limit or recurringLimit is set.

Example request

{
  "limit": "50",
  "recurringLimit": "100"
}

Response

Add or update a budget member response

userIdstring

BILL-generated ID of the user

userUuidstring

BILL-generated UUID of the user

spentnumber

Total amount spent by the user in the current budget period

limitnumber

Funds assigned to the user in the current budget period

recurringLimitnumber

Funds assigned to the user in all future budget periods

recurringboolean

Set as true if the user receives the recurringLimit funds in all future budget periods.

budgetRole'MEMBER' | 'OWNER' | 'OBSERVER'

Budget user role

namestring

User display name

retiredboolean

Set as true if the budget member is retired

shareBudgetFundsboolean

Set as true if all the budget funds are shared with the user