Weel API (v1)

The Weel API empowers businesses with seamless expense management and real-time insights. Our platform makes it easy to integrate and automate expense workflows, manage receipts, and keep track of spending across your organization.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://help.letsweel.com

Contact our support

help@letsweel.com

Terms of Service

Languages
Servers

https://public.letsweel.com/

Users

This group of endpoints allows you to retrieve and manage user data, including listing users and fetching individual user details.

Operations

Transactions

This group of endpoints allows you to retrieve and manage transaction data, including listing transactions with various filters and fetching individual transaction details.

Operations

Budgets

This group of endpoints allows you to retrieve and manage budget data, including listing budgets and fetching individual budget details.

Budgets are organised in a hierarchy where a budget can have multiple members. Each member is associated with a user. Funds can be allocated at the budget level or at the member level, using the flag has_member_limits.

Budget Hierachy

Operations

Budget Members

This group of endpoints allows you to retrieve and manage budget member data, including listing budget members and fetching individual budget member details.

Operations

List budget members

Request

A budget member is a user who has been invited to a budget.

Path
client_idintegerrequired

The ID of the business.

Example: 123
budget_idstringrequired

The ID of the budget.

Query
offsetinteger

Offset to retrieve items from.

Default 0
Example: offset=50
limitinteger<= 500

Number of items per page.

Default 50
Example: limit=50
is_deletedboolean

Whether the resource is deleted.

Example: is_deleted=false
user_idinteger

The ID of the user to filter by.

Example: user_id=123
curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/budgets/{budget_id}/members?is_deleted=false&limit=50&offset=50&user_id=123' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
countinteger

The total number of budget members that match the query.

Example: 100
nextstring

The URL to the next page of budget members.

Example: "offset=50&limit=50"
previousstring

The URL to the previous page of budget members.

Example: "offset=0&limit=50"
resultsArray of objects(BudgetMember)
Response
application/json
{
  "count": 100,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "results": [
    { … }
  ]
}

Get budget member

Request

Path
client_idintegerrequired

The ID of the business.

Example: 123
budget_idstringrequired

The ID of the budget.

budget_member_idintegerrequired

The ID of the budget member.

curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/budgets/{budget_id}/members/{budget_member_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring

The ID of the budget member.

Example: "e33b7c61-5124-4ba0-b238-e4c573133715"
userobject or null(SubUser)

The user for the budget member. Only present if the user has accepted their invite to Weel.

inviteobject or null(Invite)

The invite for the budget member. Only present if the user has not accepted their invite to Weel.

available_amountnumber

The available amount of the budget member.

Example: 800
spent_amountnumber

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

Example: 200
reset_amountnumber

The reset amount of the budget member.

Example: 1000
is_deletedboolean

Whether the budget member is deleted.

Example: false
Response
application/json
{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "user": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "name": "John Doe"
  },
  "invite": {
    "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
    "email": "john.doe@example.com"
  },
  "available_amount": 800,
  "spent_amount": 200,
  "reset_amount": 1000,
  "is_deleted": false
}

Budget Topups

This group of endpoints allows you to retrieve and create budget topups. Topups are used to increase or decrease the available amount of a budget or budget member.

Topups will be automatically approved, unless a Workflow or Policy has been configured in Weel for that requires approval for budget topups.

There are two types of topups:

  • Budget topups are used to increase or decrease the available amount of a budget. This is only permitted when has_member_limits is false for the budget.
  • Budget member topups are used to increase or decrease the available amount of a budget member. This is only permitted when has_member_limits is true for the budget.

has_member_limits is set to true when this toggle is enabled in the budget creation form. Has Member Limits is true

Operations