---
title: "List transactions"
method: GET
path: "/v2/businesses/{client_id}/transactions"
tags: ["Transactions"]
---

# List transactions

`GET /v2/businesses/{client_id}/transactions`

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 parameters

- `client_id` integer, required

## Query parameters

- `offset` integer
- `limit` integer
- `min_auth_date` string, date
- `max_auth_date` string, date
- `min_cleared_date` string, date
- `max_cleared_date` string, date
- `expense_status` 'COMPLETE' | 'INCOMPLETE_EXPENSE'
- `status` 'AUTHED' | 'CLEARED' | 'REFUNDED' | 'DECLINED' — The status of the transaction.

## Response `200`

OK

- TransactionListResponse
  - `count` integer — The total number of transactions that match the query.
  - `next` string — The URL to the next page of transactions.
  - `previous` string — The URL to the previous page of transactions.
  - `results` Transaction[]
    - `id` string — The ID of the transaction.
    - `cleared_date` string, date-time, nullable — The date the transaction was cleared in UTC.
    - `auth_date` string, date-time — The date the transaction was authorised in UTC.
    - `merchant_name` string — The name of the merchant.
    - `attendees` string[] — The names of the attendees of the transaction.
    - `budget` TransactionBudget
      - `id` string — The ID of the budget.
      - `name` string — The name of the budget.
      - `budget_type` 'BUDGET' | 'SUBSCRIPTION' — The type of budget.
    - `currency` string — The currency of the transaction.
    - `custom_fields` CustomFieldValue[]
      - `field_name` string — The name of the custom field.
      - `entry_text` string — The text value of the custom field.
    - `fx_amount` number — The foreign currency amount of the transaction.
    - `amount` number — The amount of the transaction in AUD (positive for credits, negative for debits).
    - `gst` number — The GST amount of the transaction.
    - `expense_status` 'COMPLETE' | 'INCOMPLETE_EXPENSE' — The expense completion status of the transaction.
    - `status` 'AUTHED' | 'CLEARED' | 'REFUNDED' | 'DECLINED' — The status of the transaction.
    - `transaction_type` 'CARD_TRANSACTION' | 'CHARGE' | 'DEPOSIT_DIRECT_CREDIT' | 'DEPOSIT_DIRECT_DEBIT' | 'BILL' | 'REIMBURSEMENT' | 'EXTERNAL_TRANSFER' | 'MANUAL_TRANSFER' | 'CREDIT' — The type of transaction.
    - `user` SubUser, nullable
      - `id` integer — The ID of the user.
      - `first_name` string — The first name of the user.
      - `last_name` string — The last name of the user.
      - `name` string — The full name of the user or the display name if the user has set one.
    - `line_items` LineItem[] — The line items of the transaction.
      - `id` string — The ID of the line item.
      - `amount` number — The amount of the line item in AUD.
      - `gst_amount` number — The GST amount of the line item. When a `tax_rate` is applied to the line item, this is derived from `tax_rate.rate`.
      - `tax_rate` TaxRate, nullable — A tax rate applied to a line item. May be `null` when itemised tax rates are enabled for the business but a rate could not be resolved.
        - `id` string, uuid — The ID of the tax rate.
        - `name` string — The name of the tax rate.
        - `rate` number — The tax rate as a decimal fraction.
        - `code` string, nullable — The tax rate code.
        - `is_default_for` 'DOMESTIC' | 'INTERNATIONAL' | 'BOTH' | 'NONE' — Which transaction types the tax rate is the default for.
        - `is_enabled` boolean — Whether the tax rate is enabled.
        - `source` 'WEEL' | 'MANUAL' | 'ASP' — The source of the tax rate.
      - `category` LineItemCategory
        - `id` string — The ID of the category.
        - `name` string — The name of the category in Weel.
        - `code` string, nullable — The accounting code of the category, if any.
      - `custom_fields` CustomFieldValue[]
        - `field_name` string — The name of the custom field.
        - `entry_text` string — The text value of the custom field.
      - `description` string — The description of the line item.
    - `receipt_urls` string[] — The URLs of the receipts for the transaction.
    - `created` string, date-time — The date and time when the transaction was created in UTC.
    - `updated` string, date-time — The date and time when the transaction was last updated in UTC.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/letsweel/apis/weel-openapi.md) · [All operations](https://skmtc.net/letsweel/apis/weel-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/letsweel/weel-openapi/revisions/5a8ffd533c9c/schema)