Skip to main content
GET
/
organizations
/
{orgId}
/
charges
List Charges
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/charges \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "name": "<string>",
      "code": "<string>",
      "accountId": "<string>",
      "billDate": "2023-12-25",
      "amount": 123,
      "units": 123,
      "unitPrice": 123,
      "currency": "<string>",
      "description": "<string>",
      "entityId": "<string>",
      "billId": "<string>",
      "accountingProductId": "<string>",
      "servicePeriodStartDate": "2023-11-07T05:31:56Z",
      "servicePeriodEndDate": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "contractId": "<string>",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "scheduleId": "<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

Query Parameters

​
pageSize
integer<int32>

Number of Charges to retrieve per page

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

nextToken for multi page retrievals

​
accountId
string

List Charge items for the Account UUID

​
entityType
enum<string>

List Charge items for the EntityType The entity type the Charge has been created for.

Available options:
AD_HOC,
BALANCE
​
entityId
string

List Charge items for the Entity UUID

​
billDate
string<date>

List Charge items for the Bill Date

​
ids
string

List of Charge UUIDs to retrieve

​
scheduleId
string

List Charge items for the Schedule UUID

Response

ListCharges 200 response

​
data
object[]
​
nextToken
string