---
title: "List Transactions"
method: GET
path: "/organizations/{orgId}/balances/{balanceId}/transactions"
tags: ["Balances"]
---

# List Transactions

`GET /organizations/{orgId}/balances/{balanceId}/transactions`

## Request

- Base URL: `https://api.m3ter.com`
- URL: `https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/transactions`
- Auth: OAuth 2
  - Authorization code: `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize`, token URL `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token`
  - Client credentials, token URL `/oauth/token`
- TypeScript: <https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/balances/:balanceId/transactions/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve all Transactions for a specific Balance.

This endpoint returns a list of all Transactions associated with a specific Balance. You can paginate through the Transactions by using the `pageSize` and `nextToken` parameters.

## Path parameters

- `orgId` string, required
- `balanceId` string, required

## Query parameters

- `pageSize` integer
- `nextToken` string
- `transactionTypeId` string, nullable
- `entityType` 'BILL' | 'COMMITMENT' | 'USER' | 'SERVICE_USER' | 'SCHEDULER'
- `entityId` string, nullable

## Response `200`

Returns the list of Balance Transactions

- PaginatedBalanceTransactionResponseData
  - `data` BalanceTransactionResponse[]
    - `id` string, required: The UUID of the entity.
    - `version` integer: The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
    - `description` string: A brief description explaining the purpose or context of the transaction.
    - `amount` number: The financial value of the transaction, as recorded in the balance.
    - `paid` number: The actual payment amount if the payment currency differs from the Balance currency.
    - `currencyPaid` string: The currency code such as USD, GBP, EUR of the payment, if it differs from the balance currency.
    - `entityType` 'BILL' | 'COMMITMENT' | 'USER' | 'SERVICE_USER' | 'SCHEDULER'
    - `entityId` string: The unique identifier (UUID) for the entity associated with the Transaction, as specified by the `entityType`.
    - `transactionTypeId` string: The unique identifier (UUID) for the Transaction type. This is obtained from the list of created Transaction Types within the Organization Configuration.
    - `appliedDate` string, date-time: The date *(in ISO 8601 format)* when the balance transaction was applied, i.e., when the balance was affected.
    - `transactionDate` string, date-time: The date *(in ISO 8601 format)* when the transaction was recorded in the system.
    - `dtCreated` string, date-time: The date and time *(in ISO 8601 format)* when the balance transaction was first created.
    - `dtLastModified` string, date-time: The date and time *(in ISO 8601 format)* when the balance transaction was last modified.
    - `createdBy` string: The unique identifier (UUID) for the user who created the balance transaction.
    - `lastModifiedBy` string: The unique identifier (UUID) for the user who last modified the balance transaction.
  - `nextToken` string

## Other responses

- `4XX`: Error message
- `5XX`: Error message

## Changes

- **2026-10-16** `85c514abc692`: 1 breaking
  - the `data/items/allOf[subschema #2]/` response's property type changed from no type to `object` for status `200`
- **2025-08-01** `9f9e5f3dbde7`: 1 breaking, 5 info
  - the response's body type changed from no type to `object` for status `200`
  - added the new optional `query` request parameter `entityId`
  - added the new optional `query` request parameter `entityType`
  - for the `query` request parameter `pageSize`, the max was increased from `100.00` to `200.00`
  - …2 more
- **2025-02-04** `9433593378b5`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `data` from the response with the `200` status
  - removed the optional property `nextToken` from the response with the `200` status

[Operation history](https://skmtc.dev/m3ter-com/apis/m3ter-api/changes/organizations/:orgId/balances/:balanceId/transactions/get.md)

---

[API](https://skmtc.dev/m3ter-com/apis/m3ter-api.md) - [All operations](https://skmtc.dev/m3ter-com/apis/m3ter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/m3ter-com/apis/m3ter-api/revisions/85c514abc692?raw)