Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Budget Members

Add budget member

Adds a user (or pending invite) as a member of the budget. Provide exactly one of user or invite. If an invite has already been accepted, the response will contain user rather than invite.

Side effect: On budgets with per-member limits, adding a member increases the budget's total limit and available amount by the new member's reset_amount. Re-fetch the budget if you need the updated totals. Shared-pot budgets are unaffected.

post/v1/businesses/{client_id}/budgets/{budget_id}/members

Path parameters

client_idinteger required
Example:123

The ID of the business.

budget_idstring required

The ID of the budget.

Request body

OR

Example request

{
  "user": {
    "id": 123
  },
  "invite": {
    "id": "e33b7c61-5124-4ba0-b238-e4c573133715"
  },
  "reset_amount": 500
}

Response

Created

idstring

The ID of the budget member.

available_amountnumber

The available amount of the budget member.

spent_amountnumber

The amount of the budget that has been spent by the budget member.

reset_amountnumber

The reset amount of the budget member.

is_deletedboolean

Whether the budget member is deleted.

createdstring date-time

The date and time when the budget member was created in UTC.

updatedstring date-time

The date and time when the budget member was last updated in UTC.

Example response

{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "user": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "name": "John Doe"
  },
  "invite": {
    "id": 99,
    "email": "jane.doe@example.com",
    "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "role": "Team Member",
    "payment_types": [
      "cards",
      "reimbursements"
    ],
    "created": "2026-05-01T00:00:00Z",
    "updated": "2026-05-01T00:00:00Z"
  },
  "available_amount": 800,
  "spent_amount": 200,
  "reset_amount": 1000,
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z"
}