Skip to main content
GET
/
organizations
/
{orgId}
/
balances
/
{balanceId}
/
transactions
List Transactions
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "description": "<string>",
      "amount": 123,
      "paid": 123,
      "currencyPaid": "<string>",
      "entityType": "BILL",
      "entityId": "<string>",
      "transactionTypeId": "<string>",
      "appliedDate": "2023-11-07T05:31:56Z",
      "transactionDate": "2023-11-07T05:31:56Z",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

​
balanceId
string
required

The unique identifier (UUID) for the Balance whose Transactions you want to retrieve.

Query Parameters

​
pageSize
integer<int32>

The maximum number of transactions to return per page.

Required range: 1 <= x <= 200
​
nextToken
string

nextToken for multi page retrievals. A token for retrieving the next page of transactions. You'll get this from the response to your request.

​
transactionTypeId
string | null
​
entityType
enum<string>
Available options:
BILL,
COMMITMENT,
USER,
SERVICE_USER,
SCHEDULER
​
entityId
string | null

Response

Returns the list of Balance Transactions

​
data
object[]
​
nextToken
string