CreditReason
List Credit Reasons
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
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