M3m3ter-com
CreditReason

List Credit Reasons

Changed on

Retrieve a list of the Credit Reason entities created for your Organization. You can filter the list returned for the call by Credit Reason ID, Credit Reason short code, or by Archive status.

get/organizations/{orgId}/picklists/creditreasons

Request

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 credit reasons to retrieve per page.

nextTokenstring

nextToken for multi page retrievals.

idsstring[]

List of Credit Reason IDs to retrieve.

codesstring[]

List of Credit Reason short codes to retrieve.

archivedboolean

TRUE / FALSE archived flag to filter the list. CreditReasons can be archived once they are obsolete.

  • TRUE includes archived CreditReasons.
  • FALSE excludes CreditReasons that are archived.

Response

List of CreditReasons

nextTokenstring

Changes

  • 85c514abc692Revision changes
    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

  • 9f9e5f3dbde7Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status