Skip to main content
GET
/
organizations
/
{orgId}
/
counteradjustments
List CounterAdjustments
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/counteradjustments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "counterId": "<string>",
      "accountId": "<string>",
      "date": "2023-12-25",
      "value": 123,
      "purchaseOrderNumber": "<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

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Query Parameters

​
pageSize
integer<int32>

Number of CounterAdjustments to retrieve per page

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

nextToken for multi page retrievals.

​
counterId
string

List CounterAdjustment items for the Counter UUID.

​
accountId
string

List CounterAdjustment items for the Account UUID.

​
date
string

List CounterAdjustment items for the given date.

​
endDateStart
string

Only include CounterAdjustments with end dates equal to or later than this date.

​
endDateEnd
string

Only include CounterAdjustments with end dates earlier than this date.

​
sortOrder
string

Sort order for the results

​
dateStart
string | null
​
dateEnd
string | null

Response

Returns list of CounterAdjustments

​
data
object[]
​
nextToken
string