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

List budgets

Request

Path
client_idintegerrequired

The ID of the business.

Example: 123
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
budget_typestring

The type of budget.

Enum"BUDGET""SUBSCRIPTION"
Example: budget_type=BUDGET
has_member_limitsboolean

Whether the budget has member limits.

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

Responses

OK

Bodyapplication/json
countinteger

The total number of budgets that match the query.

Example: 100
nextstring

The URL to the next page of budgets.

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

The URL to the previous page of budgets.

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

Get budget

Request

Path
client_idintegerrequired

The ID of the business.

Example: 123
budget_idstringrequired

The ID of the budget.

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

Responses

OK

Bodyapplication/json
idstring

The ID of the budget.

Example: "e33b7c61-5124-4ba0-b238-e4c573133715"
namestring

The name of the budget.

Example: "Sales Team"
budget_typestring

The type of budget.

Enum"BUDGET""SUBSCRIPTION"
Example: "BUDGET"
available_amountnumber

The available amount of the budget.

Example: 800
spent_amountnumber

The amount of the budget that has been spent.

Example: 200
reset_amountnumber

The reset amount of the budget.

Example: 1000
reset_periodstring

The reset period of the budget.

Enum"DAILY""WEEKLY""MONTHLY""QUARTERLY""YEARLY""FINANCIAL_YEAR""NEVER"
Example: "MONTHLY"
current_period_startstring(date-time)

The start date of the current period in UTC.

Example: "2024-01-01T00:00:00Z"
current_period_endstring or null(date-time)

The end date of the current period in UTC.

Example: "2024-01-31T23:59:59Z"
has_member_limitsboolean

Whether the budget has member limits.

Example: false
is_deletedboolean

Whether the budget is deleted.

Example: false
Response
application/json
{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "name": "Sales Team",
  "budget_type": "BUDGET",
  "available_amount": 800,
  "spent_amount": 200,
  "reset_amount": 1000,
  "reset_period": "MONTHLY",
  "current_period_start": "2024-01-01T00:00:00Z",
  "current_period_end": "2024-01-31T23:59:59Z",
  "has_member_limits": false,
  "is_deleted": false
}

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

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