{ "opencollection": "1.0.0", "info": { "name": "m3ter Account CreditReason API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "CreditReason", "type": "folder" }, "items": [ { "info": { "name": "List Credit Reasons", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/picklists/creditreasons", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of credit reasons to retrieve per page." }, { "name": "nextToken", "value": "", "type": "query", "description": "`nextToken` for multi page retrievals." }, { "name": "ids", "value": "", "type": "query", "description": "List of Credit Reason IDs to retrieve." }, { "name": "codes", "value": "", "type": "query", "description": "List of Credit Reason short codes to retrieve." }, { "name": "archived", "value": "", "type": "query", "description": "TRUE / FALSE archived flag to filter the list. CreditReasons can be archived once they are obsolete.\n\n* TRUE includes archived CreditReasons.\n* FALSE excludes CreditReasons that are archived. " } ] }, "docs": "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. " }, { "info": { "name": "Create Credit Reason", "type": "http" }, "http": { "method": "POST", "url": "https://api.m3ter.com/organizations/:orgId/picklists/creditreasons", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization. The Organization represents your company as a direct customer of the m3ter service." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Credit Reason for your Organization. When you've created a Credit Reason, it becomes available as a credit type for adding Credit line items to Bills. See [Credits](https://www.m3ter.com/docs/api#tag/Credits)." }, { "info": { "name": "Retrieve Credit Reason", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/picklists/creditreasons/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Credit Reason to retrieve." } ] }, "docs": "Retrieve the Credit Reason with the given UUID." }, { "info": { "name": "Update Credit Reason", "type": "http" }, "http": { "method": "PUT", "url": "https://api.m3ter.com/organizations/:orgId/picklists/creditreasons/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Credit Reason to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Credit Reason with the given UUID." }, { "info": { "name": "Delete Credit Reason", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.m3ter.com/organizations/:orgId/picklists/creditreasons/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "UUID of the organization. The Organization represents your company as a direct customer of the m3ter service." }, { "name": "id", "value": "", "type": "path", "description": "The UUID of the Credit Reason to delete." } ] }, "docs": "Delete the Credit Reason with the given UUID." } ] } ], "bundled": true }