{ "opencollection": "1.0.0", "info": { "name": "m3ter Account CounterAdjustments API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "CounterAdjustments", "type": "folder" }, "items": [ { "info": { "name": "List CounterAdjustments", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/counteradjustments", "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 CounterAdjustments to retrieve per page" }, { "name": "nextToken", "value": "", "type": "query", "description": "nextToken for multi page retrievals." }, { "name": "counterId", "value": "", "type": "query", "description": "List CounterAdjustment items for the Counter UUID." }, { "name": "accountId", "value": "", "type": "query", "description": "List CounterAdjustment items for the Account UUID." }, { "name": "date", "value": "", "type": "query", "description": "List CounterAdjustment items for the given date." }, { "name": "endDateStart", "value": "", "type": "query", "description": "Only include CounterAdjustments with end dates equal to or later than this date." }, { "name": "endDateEnd", "value": "", "type": "query", "description": "Only include CounterAdjustments with end dates earlier than this date." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order for the results" }, { "name": "dateStart", "value": "", "type": "query" }, { "name": "dateEnd", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of CounterAdjustments created for Accounts in your Organization. You can filter the list returned by date, Account ID, or Counter ID.\n\n**CONSTRAINTS:**\n* 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.\n* If you want to use the `date`, `dateStart`, or `dateEnd` query parameters, you must also use the `accountId` query parameter." }, { "info": { "name": "Create CounterAdjustment", "type": "http" }, "http": { "method": "POST", "url": "https://api.m3ter.com/organizations/:orgId/counteradjustments", "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 CounterAdjustment for an Account using a Counter.\n\n**Notes:**\n* Use the new absolute value for the Counter for the selected date - if it was 15 and has increased to 20, enter 20; if it was 15 and has decreased to 10, enter 10. *Do not enter* the plus or minus value relative to the previous Counter value on the Account.\n* CounterAdjustments on Accounts are supported down to a *specific day* of granularity - you cannot create more than one CounterAdjustment for any given day using the" }, { "info": { "name": "Retrieve CounterAdjustment", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/counteradjustments/: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 CounterAdjustment to retrieve." } ] }, "docs": "Retrieve a CounterAdjustment for the given UUID." }, { "info": { "name": "Update CounterAdjustment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.m3ter.com/organizations/:orgId/counteradjustments/: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 CounterAdjustment to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a CounterAdjustment for an Account." }, { "info": { "name": "Delete CounterAdjustment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.m3ter.com/organizations/:orgId/counteradjustments/: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 CounterAdjustment to delete." } ] }, "docs": "Delete a CounterAdjustment for the given UUID." } ] } ], "bundled": true }