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

List transactions

Request

This endpoint allows you to retrieve a list of transactions for a given business. You can filter the transactions by date range, status, and expense completion status.

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
min_auth_datestring(date)

The minimum authorised date for the transactions.

max_auth_datestring(date)

The maximum authorised date for the transactions.

min_cleared_datestring(date)

The minimum cleared date for the transactions.

max_cleared_datestring(date)

The maximum cleared date for the transactions.

expense_statusstring

The expense completion status of the transactions.

Enum"COMPLETE""INCOMPLETE_EXPENSE"
Example: expense_status=COMPLETE
curl -i -X GET \
  'https://public.letsweel.com/v2/businesses/{client_id}/transactions?expense_status=COMPLETE&limit=50&max_auth_date=2019-08-24&max_cleared_date=2019-08-24&min_auth_date=2019-08-24&min_cleared_date=2019-08-24&offset=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
countinteger

The total number of transactions that match the query.

Example: 100
nextstring

The URL to the next page of transactions.

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

The URL to the previous page of transactions.

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

Get transaction

Request

Path
client_idintegerrequired

The ID of the business.

Example: 123
transaction_idstringrequired

The ID of the transaction.

curl -i -X GET \
  'https://public.letsweel.com/v2/businesses/{client_id}/transactions/{transaction_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring

The ID of the transaction.

Example: "e33b7c61-5124-4ba0-b238-e4c573133715"
cleared_datestring or null(date-time)

The date the transaction was cleared.

Example: "2024-01-01T00:00:00Z"
auth_datestring(date-time)

The date the transaction was authorised.

Example: "2024-01-01T00:00:00Z"
merchant_namestring

The name of the merchant.

Example: "Bunnings Warehouse"
attendeesArray of strings

The names of the attendees of the transaction.

Example: ["Jane Doe"]
budgetobject(TransactionBudget)

The budget associated with the transaction.

currencystring

The currency of the transaction.

Example: "AUD"
custom_fieldsArray of objects(CustomField)
fx_amountnumber

The foreign currency amount of the transaction.

Example: 100
amountnumber

The amount of the transaction in AUD (positive for credits, negative for debits).

Example: -100
gstnumber

The GST amount of the transaction.

Example: 9.09
expense_statusstring

The expense completion status of the transaction.

Enum"COMPLETE""INCOMPLETE_EXPENSE"
Example: "COMPLETE"
statusstring

The status of the transaction.

Enum"CLEARED""AUTHED"
Example: "CLEARED"
transaction_typestring

The type of transaction.

Enum"CARD_TRANSACTION""CHARGE""DEPOSIT_DIRECT_CREDIT""DEPOSIT_DIRECT_DEBIT""BILL""REIMBURSEMENT""EXTERNAL_TRANSFER""MANUAL_TRANSFER""CREDIT"
Example: "CARD_TRANSACTION"
userobject or null(SubUser)

The user who made the transaction.

line_itemsArray of objects(LineItem)

The line items of the transaction.

receipt_urlsArray of strings

The URLs of the receipts for the transaction.

Example: ["https://divipay-user-production.s3.amazonaws.com/123/68eae8f6-cb90-4403-ba76-a2cc12c3979j.png"]
Response
application/json
{
  "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
  "cleared_date": "2024-01-01T00:00:00Z",
  "auth_date": "2024-01-01T00:00:00Z",
  "merchant_name": "Bunnings Warehouse",
  "attendees": [
    "Jane Doe"
  ],
  "budget": {
    "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
    "name": "Sales Team",
    "budget_type": "BUDGET"
  },
  "currency": "AUD",
  "custom_fields": [
    { … }
  ],
  "fx_amount": 100,
  "amount": -100,
  "gst": 9.09,
  "expense_status": "COMPLETE",
  "status": "CLEARED",
  "transaction_type": "CARD_TRANSACTION",
  "user": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe"
  },
  "line_items": [
    { … }
  ],
  "receipt_urls": [
    "https://divipay-user-production.s3.amazonaws.com/123/68eae8f6-cb90-4403-ba76-a2cc12c3979j.png"
  ]
}

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