Skip to main content

How to create and manage budgets via the OpenAPI

  • Updated

The Weel OpenAPI lets you create, update, and delete budgets programmatically, so your spend controls can respond to events in the systems you already run — a new project in your ERP, a new hire in your HRIS, or a budget cycle rolling over.

Before you start

You will need:

  • A Weel Enterprise plan.
  • Admin access, or the API permission enabled for your role.
  • An API key — see How to generate and manage API keys.
  • Your Client ID, shown on the Settings > API page in the Weel web app.

Include your API key as a bearer token in the Authorization header of every request. The full endpoint reference is at developer.letsweel.com.

Steps

1. Create a budget

Send POST /v1/businesses/{client_id}/budgets. All configuration fields are required — there are no silent defaults:

  • name — the budget's name
  • reset_amount and reset_period — the amount the budget resets to each period
  • has_member_limits — when true, each member gets their own cap and the member caps must add up to the budget's reset_amount; when false, members share the budget's pot
  • rollover_funds — whether unspent balance rolls over to the next period
  • members and owners — at least one of each

You can optionally restrict which categories are visible on the budget (limit_categories plus a list of category IDs) and attach custom fields.

2. Update or delete a budget

  • Update configuration with PATCH /v1/businesses/{client_id}/budgets/{budget_id}.
  • Delete with DELETE /v1/businesses/{client_id}/budgets/{budget_id}. This also removes the budget's members and owners.

3. Manage members and owners

  • Add, update, or remove members with POST /budgets/{budget_id}/members, PATCH .../members/{budget_member_id}, and DELETE .../members/{budget_member_id}.
  • Add or remove Budget Owners with POST /budgets/{budget_id}/owners and DELETE .../owners/{budget_owner_id}.

4. Top up a budget

  • Top up the budget's shared pot with POST /budgets/{budget_id}/topups.
  • Top up an individual member with POST /budgets/{budget_id}/members/{budget_member_id}/topups.

What happens next

The budget appears on the Budgets page in Weel, and members can spend from it with their budget cards straight away. Wire the calls to your source system to keep budgets in step with your business.

Related articles