Skip to content

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

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

Statements

This group of endpoints allows you to retrieve a list of balances for the required period for a given business.

Operations

List statements

Request

This endpoint allows you to retrieve a list of balances for the required period for a given business.

Security
BearerAuth
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
start_datestring(date)required

The start date for this statement in UTC.

end_datestring(date)required

The end date for this statement in UTC.

curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/statements?offset=50&limit=50&start_date=2019-08-24&end_date=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
countinteger

The total number of daily balance records for the given period.

Example: 100
nextstring

The URL to the next page of daily balance records.

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

The URL to the previous page of daily balance records.

Example: "offset=0&limit=50"
start_datestring(date)

The start date for this statement in UTC.

Example: "2024-01-01"
end_datestring(date)

The end date for this statement in UTC.

Example: "2024-01-31"
currencystring

The currency of the statement.

Example: "AUD"
opening_balancenumber

The opening balance of the statement.

Example: 1000
closing_balancenumber

The closing balance of the statement.

Example: 1000
daily_balancesArray of objects(DailyBalance)
Response
application/json
{
  "count": 100,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "start_date": "2024-01-01",
  "end_date": "2024-01-31",
  "currency": "AUD",
  "opening_balance": 1000,
  "closing_balance": 1000,
  "daily_balances": [
    { … }
  ]
}

Get account balances

Request

Retrieve real-time account balances for all currencies associated with your business. This endpoint returns the current balance for each currency wallet associated with your business account.

Security
BearerAuth
Path
client_idintegerrequired

The ID of the business.

Example: 123
curl -i -X GET \
  https://public.letsweel.com/v1/businesses/123/balance \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
balancenumberrequired

Account balance amount as a decimal number

Example: 123.45
currencystringrequired

ISO 4217 currency code

Example: "AUD"
]
Response
application/json
[
  {
    "balance": 123.45,
    "currency": "AUD"
  }
]