Skip to main content
GET
/
organizations
/
{orgId}
/
balances
List Balances
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/balances \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "code": "<string>",
      "name": "<string>",
      "description": "<string>",
      "accountId": "<string>",
      "amount": 123,
      "currency": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "rolloverAmount": 123,
      "rolloverEndDate": "2023-11-07T05:31:56Z",
      "balanceDrawDownDescription": "<string>",
      "overageSurchargePercent": 123,
      "overageDescription": "<string>",
      "productIds": [
        "<string>"
      ],
      "lineItemTypes": [
        "STANDING_CHARGE"
      ],
      "contractId": "<string>",
      "consumptionsAccountingProductId": "<string>",
      "feesAccountingProductId": "<string>",
      "allowOverdraft": true,
      "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.

Query Parameters

​
pageSize
integer<int32>

The maximum number of Balances to return per page.

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

The nextToken for retrieving the next page of Balances. It is used to fetch the next page of Balances in a paginated list.

​
accountId
string

The unique identifier (UUID) for the end customer's account.

​
endDateStart
string

Only include Balances with end dates equal to or later than this date. If a Balance has a rollover amount configured, then the rolloverEndDate will be used as the end date.

​
endDateEnd
string

Only include Balances with end dates earlier than this date. If a Balance has a rollover amount configured, then the rolloverEndDate will be used as the end date.

​
contract
string
​
contractId
string

Filter Balances by contract id. Use '' with accountId to fetch unlinked balances.

​
ids
string[]

A list of unique identifiers (UUIDs) for specific Balances to retrieve.

Response

Returns list of Balances

​
data
object[]
​
nextToken
string