openapi: 3.0.1
info:
title: m3ter Account StatementJob API
description: "If you are using Postman, you can:\n- Use the **Download** button above to download the m3ter Open API spec JSON file and then import this file as the **m3ter API Collection** into your Workspace. See [Importing the m3ter Open API](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls#importing-the-m3ter-open-api) in our main user Documentation for details.\n- Copy this link: [m3ter-Template API Collection](https://www.datocms-assets.com/78893/1672846767-m3ter-template-api-collection-postman_collection.json) and use it to import the **m3ter-Template API Collection** into your Workspace. See [Importing the m3ter Template API Collection](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls#importing-the-m3ter-template-api-collection) in our main user Documentation for details.\n\n---\n\n# Introduction\nThe m3ter platform supports two HTTP-based REST APIs returning JSON encoded responses:\n- The **Ingest API**, which you can use for submitting raw data measurements. *(See the [Submit Measurements](https://www.m3ter.com/docs/api#tag/Measurements/operation/SubmitMeasurements) endpoint in this API Reference.)*\n- The **Config API**, which you can use for configuration and management. *(All other endpoints in this API Reference.)* \n\n## Authentication and Authorization\nOur APIs use an industry-standard authorization protocol known as the OAuth 2.0 specification.\n\nOAuth2 supports several grant types, each designed for a specific use case. m3ter uses the following two grant types:\n - **Authorization Code**: Used for human login access via the m3ter Console.\n - **Client Credentials**: Used for machine-to-machine communication and API access.\n\nComplete the following flow for API access:\n\n1. **Create a Service User and add Permissions**: Log in to the m3ter Console, go to **Settings**, **Access** then **Service Users** tab, and create a Service User. To enable API calls, grant the user **Administrator** permissions. \n \n2. **Generate Access Keys**: In the Console, open the *Overview* page for the Service User by clicking on the name. Generate an **Access Key id** and **Api Secret**. Make sure you copy the **Api Secret** because it is only visible at the time of creation. \n\nSee [Service Authentication](https://www.m3ter.com/docs/guides/authenticating-with-the-platform/service-authentication) for detailed instructions and an example.\n\n3. **Obtain a Bearer Token using Basic Auth**: We implement the OAuth 2.0 Client Credentials Grant authentication flow for Service User Authentication. Submit a request to the m3ter OAuth Client Credentials authentication flow, using your concatenated **Access Key id** and **Api Secret** to obtain a Bearer Token for your Service User. *See examples below.* \n \n4. **Bearer Token Usage**: Use the HTTP 'Authorization' header with the bearer token to authorise all subsequent API requests. \n\n> Warning: The Bearer Token is valid for 18,000 seconds or 5 hours. When the token has expired, you must obtain a new one.\n\nBelow are two examples for obtaining a Bearer Token using Basic Auth: the first in cURL and the second as a Python script. \n\n### cURL Example\n1. Open your terminal or command prompt. \n2. Use the following `cURL` command to obtain a Bearer Token:\n\n```bash\ncurl -X POST https://api.m3ter.com/oauth/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -u your_access_key_id:your_api_secret \\\n -d 'grant_type=client_credentials'\n```\n\nReplace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**.\n\n3. Run the command, and if successful, it will return a JSON response containing the Bearer Token. The response will look like this:\n\n```json\n{\n \"access_token\": \"your_bearer_token\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 18000\n}\n```\n\nYou can then use the Bearer Token *(the value of `\"access_token\"`)* for subsequent API calls to m3ter.\n\n### Python Example\n1. Install the `requests` library if you haven't already:\n\n```bash\npip install requests\n```\n\n2. Use the following Python script to obtain a Bearer Token:\n\n```python\nimport requests\nimport base64\n\n# Replace these with your Access Key id and Api Secret\naccess_key_id = 'your_access_key_id'\napi_secret = 'your_api_secret'\n\n# Encode the Access Key id and Api Secret in base64 format\ncredentials = base64.b64encode(f'{access_key_id}:{api_secret}'.encode('utf-8')).decode('utf-8')\n\n# Set the m3ter token endpoint URL\ntoken_url = 'https://api.m3ter.com/oauth/token'\n\n# Set the headers for the request\nheaders = {\n 'Authorization': f'Basic {credentials}',\n 'Content-Type': 'application/x-www-form-urlencoded'\n}\n\n# Set the payload for the request\npayload = {\n 'grant_type': 'client_credentials'\n}\n\n# Send the request to obtain the Bearer Token\nresponse = requests.post(token_url, headers=headers, data=payload)\n\n# Check if the request was successful\nif response.status_code == 200:\n # Extract the Bearer Token from the response\n bearer_token = response.json()['access_token']\n print(f'Bearer Token: {bearer_token}')\nelse:\n print(f'Error: {response.status_code} - {response.text}')\n```\n\nReplace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**. \n\n3. Run the script, and if successful, it will print the Bearer Token. You can then use this Bearer Token for subsequent API calls to m3ter.\n\n## Submitting Personally Identifiable Information (PII)\n**IMPORTANT!** Under the [Data Processing Agreement](https://www.m3ter.com/docs/legal/dpa), the only fields permissible for use in submitting any of your end-customer PII data in m3ter are the ``name``, ``address``, and ``emailAddress`` fields on the **Account** entity - see the details for [Create Account](https://www.m3ter.com/docs/api#operation/PostAccount). See also section 4.2 of the [Terms of Service](https://www.m3ter.com/docs/legal/terms-of-service).\n\n## Rate and Payload Limits\n### Config API Request Rate Limits\nSee [Config API Limits](https://www.m3ter.com/docs/guides/m3ter-apis/config-api-limits).\n\n### Data Explorer API Request Rate Limits\nSee [Data Explorer Request Rate Limits](https://www.m3ter.com/docs/guides/m3ter-apis/config-api-limits#date-explorer-request-rate-limits).\n\n### Ingest API Request Rate and Payload Limits\nSee [Ingest API Limits](https://www.m3ter.com/docs/guides/m3ter-apis/ingest-api-limits) for more information.\n\n## Pagination\n**List Endpoints**\nAPI endpoints that have a List resources request support cursor-based pagination - for example, the `List Accounts` request. These List calls support pagination by taking the two parameters `pageSize` and `nextToken`. \n\nThe response of a List API call is a single page list. If the `nextToken` parameter is not supplied, the first page returned contains the newest objects chronologically. Specify a `nextToken` to retrieve the page of older objects that occur immediately after the last object on the previous page.\n\nUse `pageSize` to limit the list results per page, typically this allows up to a maximum of 100 or 200 per page.\n\n**Search Endpoints**\nAPI endpoints that have a Search resources request support cursor-based pagination - for example, the `Search Accounts` request. These Search calls support pagination by taking the two parameters `pageSize` and `fromDocument`.\n\nThe response of a Search API call is a single page list. If the `fromDocument` parameter is not supplied, the first page returned contains the newest objects chronologically. Specify a `fromDocument` to retrieve the page of older objects that occur immediately after the last object on the previous page.\n\nUse `pageSize` to limit the list results per page, typically this allows up to a maximum of 100 or 200 per page. Default is 10.\n\n## API Quick Start\nSee [Getting Started with API Calls](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls) for detailed guidance on how to use our API to:\n* Create a Service User and add permissions.\n* Generate access keys for the Service User.\n* Use basic authentication to obtain a Bearer Token.\n\nFor further guidance, also see [Creating and Configuring Service Users](https://www.m3ter.com/docs/guides/organization-and-access-management/managing-users/creating-and-configuring-service-users).\n\n## Other Languages\nIf you want to work with the m3ter REST APIs using other languages such as:\n* Python\n* JavaScript\n* C++\n\nPlease see the [Developer Tools](https://www.m3ter.com/docs/guides/developer-tools) topic in our main documentation for information about available SDKs.\n\n\n# Authentication\n<!-- ReDoc-Inject: <security-definitions> -->"
version: '1.0'
x-logo:
url: https://console.m3ter.com/m3ter-logo-black.svg
servers:
- url: https://api.m3ter.com
security:
- OAuth2: []
tags:
- name: StatementJob
description: "Endpoints for creating, retrieving, listing, and cancelling statement jobs.\n\nStatementJobs are tasks to asynchronously calculate and generate a bill statement. \n\nBill statements are informative backing sheets to invoices. They provide a breakdown of the usage charges that appear on the bill, helping your end customers better understand those charges, and gain a clearer picture of their usage over the billing period.\n\n"
paths:
/organizations/{orgId}/statementjobs/{id}/cancel:
post:
tags:
- StatementJob
summary: Cancel StatementJob
description: 'Cancel the StatementJob with the given UUID.
Use this endpoint to halt the execution of a specific StatementJob identified by its UUID. This operation may be useful if you need to stop a StatementJob due to unforeseen issues or changes.'
operationId: CancelStatementJob
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
- name: id
in: path
description: The unique identifier (UUID) of the StatementJob to cancel.
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: Returns the cancelled StatementJob
content:
application/json:
schema:
$ref: '#/components/schemas/StatementJobResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
/organizations/{orgId}/statementjobs/{id}:
get:
tags:
- StatementJob
summary: Get StatementJob
description: 'Retrieves the details of a specific StatementJob using its UUID.
Use this call to obtain the time-bound pre-signed download URL for the generated Bill Statement if the initial [Create StatementJob](https://www.m3ter.com/docs/api#tag/StatementJob/operation/CreateStatementJob) returned a response showing the `statementJobStatus` not yet complete and as `PENDING` or `RUNNING`.
**Note:** When you have submitted a StatementJob and a Bill Statement has been generated, you can also download the Statement directly from a Bill Details page in the Console. See [Working with Bill Statements](https://www.m3ter.com/docs/guides/billing-and-usage-data/running-viewing-and-managing-bills/working-with-bill-statements) in our user Documentation.'
operationId: GetStatementJob
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
- name: id
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: Returns the StatementJob
content:
application/json:
schema:
$ref: '#/components/schemas/StatementJobResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
/organizations/{orgId}/statementjobs/batch:
post:
tags:
- StatementJob
summary: Create Batch StatementJobs
description: 'Create a batch of StatementJobs for multiple bills.
Initiate the creation of multiple StatementJobs asynchronously for the list of bills with the given UUIDs:
* The default format for generating Bill Statements is in JSON format and according to the Bill Statement Definition you''ve specified at either Organization level or Account level.
* If you also want to generate the Statements in CSV format, use the `includeCsvFormat` request body parameter.
* The response body provides a time-bound pre-signed URL, which you can use to download the JSON format Statement.
* When you have generated a Statement for a Bill, you can also obtain a time-bound pre-signed download URL using either the [Retrieve Bill Statement in JSON Format](https://www.m3ter.com/docs/api#tag/Bill/operation/GetBillJsonStatement) and [Retrieve Bill Statement in CSV Format](https://www.m3ter.com/docs/api#tag/Bill/operation/GetBillCsvStatement) calls found in the [Bill](https://www.m3ter.com/docs/api#tag/Bill) section of this API Reference.
**Notes:**
* If the response to the Create StatementJob call shows the `statementJobStatus` as `PENDING` or `RUNNING`, you will not receive the pre-signed URL in the response. Wait a few minutes to allow the StatementJob to complete and then use the [Get StatmentJob](https://www.m3ter.com/docs/api#tag/StatementJob/operation/GetStatementJob) call in this section to obtain the pre-signed download URL for the generated Bill Statement.
* When you have submitted a StatementJob and a Bill Statement has been generated, you can also download the Statement directly from a Bill Details page in the Console. See [Working with Bill Statements](https://www.m3ter.com/docs/guides/billing-and-usage-data/running-viewing-and-managing-bills/working-with-bill-statements) in our user Documentation.'
operationId: CreateStatementJobBatch
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StatementsBatchJobRequest'
required: true
responses:
'200':
description: Returns a list of the created StatementJobs
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StatementJobResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
/organizations/{orgId}/statementjobs:
get:
tags:
- StatementJob
summary: List Statement Jobs
description: 'Retrieve a list of StatementJobs.
Retrieves a list of all StatementJobs for a specific Organization. You can filter the results based on:
* StatementJob status.
* Whether StatementJob is neither completed nor cancelled but remains active.
* The ID of the Bill the StatementJob is associated with.
You can also paginate the results for easier management.
**WARNING!**
* You can use only one of the valid Query parameters: `active`, `status`, or `billId` in any call. If you use more than one of these Query parameters in the same call, then a 400 Bad Request is returned with an error message.'
operationId: ListStatementJobs
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
- name: pageSize
in: query
description: Specifies the maximum number of StatementJobs to retrieve per page.
required: false
allowEmptyValue: true
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
format: int32
- name: nextToken
in: query
description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of StatementJobs in a paginated list.
required: false
allowEmptyValue: true
style: form
explode: true
schema:
type: string
- name: active
in: query
description: 'Boolean filter on whether to only retrieve active *(i.e. not completed/cancelled)* StatementJobs.
* TRUE - only active StatementJobs retrieved.
* FALSE - all StatementJobs retrieved.
'
required: false
allowEmptyValue: true
style: form
explode: true
schema:
type: string
- name: status
in: query
description: 'Filter using the StatementJobs status. Possible values:
* `PENDING`
* `RUNNING`
* `COMPLETE`
* `CANCELLED`
* `FAILED`'
required: false
allowEmptyValue: true
style: form
explode: true
schema:
type: string
- name: billId
in: query
description: Filter Statement Jobs by billId
required: false
allowEmptyValue: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Returns list of StatementJobs
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedStatementJobResponseData'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
post:
tags:
- StatementJob
summary: Create a StatementJob
description: "This endpoint creates a StatementJob for a single bill within an Organization using the Bill UUID. \n\nThe Bill Statement is generated asynchronously:\n* The default format for generating the Statement is in JSON format and according to the Bill Statement Definition you've specified at either Organization level or Account level.\n* If you also want to generate the Statement in CSV format, use the `includeCsvFormat` request body parameter.\n* The response body provides a time-bound pre-signed URL, which you can use to download the JSON format Statement.\n* When you have generated a Statement for a Bill, you can also obtain a time-bound pre-signed download URL using either the [Retrieve Bill Statement in JSON Format](https://www.m3ter.com/docs/api#tag/Bill/operation/GetBillJsonStatement) and [Retrieve Bill Statement in CSV Format](https://www.m3ter.com/docs/api#tag/Bill/operation/GetBillCsvStatement) calls found in the [Bill](https://www.m3ter.com/docs/api#tag/Bill) section of this API Reference.\n\n**Notes:**\n* If the response to the Create StatementJob call shows the `statementJobStatus` as `PENDING` or `RUNNING`, you will not receive the pre-signed URL in the response. Wait a few minutes to allow the StatementJob to complete and then use the [Get StatmentJob](https://www.m3ter.com/docs/api#tag/StatementJob/operation/GetStatementJob) call in this section to obtain the pre-signed download URL for the generated Bill Statement.\n* When you have submitted a StatementJob and a Bill Statement has been generated, you can also download the Statement directly from a Bill Details page in the Console. See [Working with Bill Statements](https://www.m3ter.com/docs/guides/billing-and-usage-data/running-viewing-and-managing-bills/working-with-bill-statements) in our user Documentation."
operationId: CreateStatementJob
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StatementJobRequest'
required: true
responses:
'200':
description: Returns the created StatementJob
content:
application/json:
schema:
$ref: '#/components/schemas/StatementJobResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
schemas:
StatementJobStatus:
type: string
description: The current status of the StatementJob. The status helps track the progress and outcome of a StatementJob.
enum:
- PENDING
- RUNNING
- COMPLETE
- CANCELLED
- FAILED
StatementJobResponse:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractResponse'
- properties:
statementJobStatus:
description: The current status of the StatementJob. The status helps track the progress and outcome of a StatementJob.
$ref: '#/components/schemas/StatementJobStatus'
billId:
type: string
description: The unique identifier (UUID) of the bill associated with the StatementJob.
orgId:
type: string
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
includeCsvFormat:
type: boolean
description: 'A Boolean value indicating whether the generated statement includes a CSV format.
* TRUE - includes the statement in CSV format.
* FALSE - no CSV format statement.'
filters:
description: ''
allOf:
- $ref: '#/components/schemas/StatementJobFilters'
- description: Optional filters to generate a statement for specific usage only.
presignedJsonStatementUrl:
type: string
description: The URL to access the generated statement in JSON format. This URL is temporary and has a limited lifetime.
jsonStatementStatus:
description: ''
$ref: '#/components/schemas/StatementStatus'
presignedCsvStatementUrl:
type: string
description: ''
csvStatementStatus:
description: ''
$ref: '#/components/schemas/StatementStatus'
dtCreated:
type: string
description: The date and time *(in ISO-8601 format)* when the StatementJob was created.
format: date-time
x-stainless-skip:
- terraform
dtLastModified:
type: string
description: The date and time *(in ISO-8601 format)* when the StatementJob was last modified.
format: date-time
x-stainless-skip:
- terraform
createdBy:
type: string
description: The unique identifier (UUID) of the user who created this StatementJob.
x-stainless-skip:
- terraform
lastModifiedBy:
type: string
description: The unique identifier (UUID) of the user who last modified this StatementJob.
x-stainless-skip:
- terraform
StatementsBatchJobRequest:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractRequest'
- required:
- billIds
properties:
billIds:
maxItems: 10
minItems: 1
type: array
description: The list of unique identifiers (UUIDs) of the bills associated with the StatementJob.
items:
type: string
includeCsvFormat:
type: boolean
description: 'A Boolean value indicating whether the generated statement includes a CSV format.
* TRUE - includes the statement in CSV format.
* FALSE - no CSV format statement.'
filters:
description: ''
allOf:
- $ref: '#/components/schemas/StatementJobFilters'
- description: Optional filters to generate a statement for specific usage only.
PaginatedStatementJobResponseData:
type: object
properties:
data:
type: array
description: ''
items:
$ref: '#/components/schemas/StatementJobResponse'
nextToken:
type: string
description: ''
description: ''
StatementStatus:
type: string
description: ''
enum:
- LATEST
- STALE
- INVALIDATED
StatementJobRequest:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractRequest'
- required:
- billId
properties:
billId:
minLength: 1
type: string
description: The unique identifier (UUID) of the bill associated with the StatementJob.
includeCsvFormat:
type: boolean
description: 'A Boolean value indicating whether the generated statement includes a CSV format.
* TRUE - includes the statement in CSV format.
* FALSE - no CSV format statement.'
filters:
description: ''
allOf:
- $ref: '#/components/schemas/StatementJobFilters'
- description: Optional filters to generate a statement for specific usage only.
AbstractResponse:
required:
- id
type: object
properties:
id:
type: string
description: 'The UUID of the entity. '
version:
type: integer
description: 'The version number:
- **Create:** On initial Create to insert a new entity, the version is set at 1 in the response.
- **Update:** On successful Update, the version is incremented by 1 in the response.'
format: int64
x-stainless-terraform-configurability: computed
x-stainless-terraform-always-send: true
description: ''
StatementJobFilters:
type: object
properties:
meterIds:
maxItems: 10
type: array
description: Include usage line items whose meterId matches one of these values.
items:
type: string
description: ''
AbstractRequest:
type: object
properties:
version:
type: integer
description: 'The version number of the entity:
- **Create entity:** Not valid for initial insertion of new entity - *do not use for Create*. On initial Create, version is set at 1 and listed in the response.
- **Update Entity:** On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.'
format: int64
x-stainless-terraform-configurability: computed
x-stainless-terraform-always-send: true
description: ''
responses:
Error:
description: Error message
content:
application/json:
schema:
type: object
properties:
message:
type: string
securitySchemes:
OAuth2:
type: oauth2
description: "m3ter supports machine to machine authentication using the `clientCredentials` OAuth2 flow.\n\nThe `authorizationCode` flow controls access for human users via the m3ter Console application. \n"
flows:
clientCredentials:
tokenUrl: /oauth/token
scopes:
m3ter-resources/m3ter-scope: m3ter resources
measurements:upload: Upload measurements
measurements:fileUpload: Upload file
measurements:retrieve: Retrieve measurements
authorizationCode:
authorizationUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize
tokenUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
scopes:
m3ter-resources/m3ter-scope: m3ter resources
openid: OpenID
email: email
measurements:upload: Upload measurements
measurements:fileUpload: Upload file
measurements:retrieve: Retrieve measurements