Sign in
CounterAdjustments

List CounterAdjustments

Retrieve a list of CounterAdjustments created for Accounts in your Organization. You can filter the list returned by date, Account ID, or Counter ID.

CONSTRAINTS:

  • The counterId query parameter is always required when calling this endpoint, used either as a single query parameter or in combination with any of the other query parameters.
  • If you want to use the date, dateStart, or dateEnd query parameters, you must also use the accountId query parameter.
get/organizations/{orgId}/counteradjustments

Path parameters

orgIdstring required

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

Query parameters

pageSizeinteger

Number of CounterAdjustments to retrieve per page

nextTokenstring

nextToken for multi page retrievals.

counterIdstring

List CounterAdjustment items for the Counter UUID.

accountIdstring

List CounterAdjustment items for the Account UUID.

datestring

List CounterAdjustment items for the given date.

endDateStartstring

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

endDateEndstring

Only include CounterAdjustments with end dates earlier than this date.

sortOrderstring

Sort order for the results

dateStartstring nullable
dateEndstring nullable

Response

Returns list of CounterAdjustments

nextTokenstring

Changes

Changed in 2 of the 10 revisions of this API.223

  • 9f9e5f3dbde713See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the new optional query request parameter sortOrder

      new-optional-request-parameter

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b512See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog