openapi: 3.0.1
info:
title: m3ter Account BalanceTransactionSchedule 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: BalanceTransactionSchedule
description: 'Endpoints for creating/updating/deleting BalanceTransactionSchedules.
**NOTE!** The BalanceTransactionSchedule feature is available in Beta release version. See [Feature Release Stages](https://www.m3ter.com/docs/guides/getting-started/feature-release-stages) for Beta release definition.'
paths:
/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules:
get:
tags:
- BalanceTransactionSchedule
summary: List BalanceTransactionSchedule
description: Retrieve a list of BalanceTransactionSchedule entities.
operationId: ListBalanceTransactionSchedule
parameters:
- name: orgId
in: path
description: UUID of the organization
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: balanceId
in: path
description: UUID of the balance
required: true
style: simple
explode: false
schema:
type: string
- name: pageSize
in: query
description: Number of BalanceTransactionSchedules to retrieve per page
required: false
allowEmptyValue: true
style: form
explode: true
schema:
maximum: 200
minimum: 1
type: integer
format: int32
- name: nextToken
in: query
description: nextToken for multi page retrievals
required: false
allowEmptyValue: true
style: form
explode: true
schema:
type: string
- name: ids
in: query
description: ''
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: ListBalanceTransactionSchedule 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBalanceTransactionScheduleResponseData'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
post:
tags:
- BalanceTransactionSchedule
summary: Create BalanceTransactionSchedule
description: Create a new BalanceTransactionSchedule.
operationId: CreateBalanceTransactionSchedule
parameters:
- name: orgId
in: path
description: UUID of the organization
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: balanceId
in: path
description: UUID of the balance
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleRequest'
required: true
responses:
'200':
description: Return the created BalanceTransactionSchedule
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules/{id}:
get:
tags:
- BalanceTransactionSchedule
summary: Retrieve BalanceTransactionSchedule
description: Retrieve a BalanceTransactionSchedule for the given UUID.
operationId: GetBalanceTransactionSchedule
parameters:
- name: orgId
in: path
description: UUID of the organization
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: balanceId
in: path
description: UUID of the balance
required: true
style: simple
explode: false
schema:
type: string
- name: id
in: path
description: The UUID of the BalanceTransactionSchedule to retrieve.
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: Return the BalanceTransactionSchedule
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
put:
tags:
- BalanceTransactionSchedule
summary: Update BalanceTransactionSchedule
description: Update a BalanceTransactionSchedule for the given UUID.
operationId: UpdateBalanceTransactionSchedule
parameters:
- name: orgId
in: path
description: UUID of the organization
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: balanceId
in: path
description: UUID of the balance
required: true
style: simple
explode: false
schema:
type: string
- name: id
in: path
description: The UUID of the BalanceTransactionSchedule to update.
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleRequest'
required: true
responses:
'200':
description: Return the updated BalanceTransactionSchedule
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
delete:
tags:
- BalanceTransactionSchedule
summary: Delete BalanceTransactionSchedule
description: Delete the BalanceTransactionSchedule for the given UUID.
operationId: DeleteBalanceTransactionSchedule
parameters:
- name: orgId
in: path
description: UUID of the organization
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: balanceId
in: path
description: UUID of the balance
required: true
style: simple
explode: false
schema:
type: string
- name: id
in: path
description: The UUID of the BalanceTransactionSchedule to update.
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: Return the deleted BalanceTransactionSchedule
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules/preview:
post:
tags:
- BalanceTransactionSchedule
summary: Preview ScheduledBalanceTransactions
description: Previews the BalanceTransactions this Schedule would create, without persisting them. You can use this call to obtain a preview of the Transactions a Schedule you plan to create for a Balance would generate.
operationId: PreviewBalanceTransactionSchedule
parameters:
- name: orgId
in: path
description: UUID of the organization
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: balanceId
in: path
description: UUID of the balance
required: true
style: simple
explode: false
schema:
type: string
- name: pageSize
in: query
description: Number of BalanceTransactions to retrieve per page
required: false
allowEmptyValue: true
style: form
explode: true
schema:
maximum: 200
minimum: 1
type: integer
format: int32
- name: nextToken
in: query
description: nextToken for multi page retrievals
required: false
allowEmptyValue: true
style: form
explode: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleRequest'
required: true
responses:
'200':
description: Return the list of BalanceTransactions this request would create
content:
application/json:
schema:
$ref: '#/components/schemas/BalanceTransactionScheduleResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
schemas:
BalanceTransactionScheduleRequest:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractRequestWithCustomFields'
- $ref: '#/components/schemas/AbstractRequest'
- required:
- amount
- code
- endDate
- frequency
- frequencyInterval
- name
- startDate
- transactionDescription
- transactionTypeId
properties:
name:
maxLength: 200
minLength: 1
type: string
description: The name of the Balance Transaction Schedule.
code:
maxLength: 80
minLength: 1
pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$
type: string
description: The unique short code of the Balance Transaction Schedule.
amount:
minimum: 0
type: number
description: The amount of each Balance Transaction created by this Schedule.
transactionDescription:
minLength: 1
type: string
description: The description of each Balance Transaction that will be created by this Schedule.
paid:
type: number
description: 'The payment amount if the payment currency differs from the Balance currency. '
currencyPaid:
type: string
description: 'The currency code of the payment if it differs from the Balance currency. For example: USD, GBP or EUR. '
transactionTypeId:
maxLength: 36
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
description: The unique identifier (UUID) of the transaction type used to create Transactions by this Schedule. You can obtain a list of Transaction Types created for the Organization. See the the [List TransactionTypes](https://www.m3ter.com/docs/api#tag/TransactionType/operation/ListTransactionTypes) endpoint of this API Reference.
startDate:
type: string
description: The start date (*in ISO-8601 format*) of the Balance Transaction Schedule.
format: date-time
endDate:
type: string
description: 'The end date (*in ISO-8601 format*) of the Balance Transaction Schedule.
**NOTE:** End date is exclusive.'
format: date-time
frequency:
description: Specify a daily, weekly, monthly, or yearly interval for when Transactions are generated for the Balance throughout the defined Transaction Schedule time period.
allOf:
- $ref: '#/components/schemas/ScheduleFrequency'
- description: Together with frequencyInterval, defines how often BalanceTransactions are generated.
frequencyInterval:
maximum: 365
minimum: 1
type: integer
description: Used in conjunction with `frequency` to define how often Balance Transactions are generated by the Schedule. For example, if `frequency` is MONTHLY and `frequencyInterval` is 3, then Balance Transactions are generated every three months.
format: int32
PaginatedBalanceTransactionScheduleResponseData:
type: object
properties:
data:
type: array
description: ''
items:
$ref: '#/components/schemas/BalanceTransactionScheduleResponse'
nextToken:
type: string
description: ''
description: ''
BalanceTransactionScheduleResponse:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractResponseWithCustomFields'
- $ref: '#/components/schemas/AbstractResponse'
- properties:
balanceId:
type: string
description: The unique identifier (UUID) for the Balance this Balance Transaction Schedule was created for.
name:
type: string
description: The name of the Balance Transaction Schedule.
code:
type: string
description: Unique short code of the Balance Transaction Schedule.
amount:
type: number
description: The amount of each Balance Transaction created by this Schedule.
transactionDescription:
type: string
description: The description of each Balance Transaction created by this Schedule.
paid:
type: number
description: 'The payment amount if the payment currency differs from the Balance currency. '
currencyPaid:
type: string
description: 'The currency code of the payment if it differs from the Balance currency. For example: USD, GBP or EUR. '
transactionTypeId:
type: string
description: The unique identifier (UUID) of the transaction type used for Transactions created by this Schedule.
startDate:
type: string
description: The start date (*in ISO-8601 format*) of the Balance Transaction Schedule.
format: date-time
endDate:
type: string
description: The end date (*in ISO-8601 format*) of the Balance Transaction Schedule.
format: date-time
frequency:
description: Specifies a daily, weekly, monthly, or yearly interval for when Transactions are generated for the Balance throughout the defined Transaction Schedule time period.
allOf:
- $ref: '#/components/schemas/ScheduleFrequency'
- description: Together with frequencyInterval, defines how often BalanceTransactions are generated.
frequencyInterval:
type: integer
description: Used in conjunction with `frequency` to define how often Balance Transactions are generated. For example, if `frequency` is MONTHLY and `frequencyInterval` is 3, Balance Transactions are generated every three months.
format: int32
dtCreated:
type: string
description: The date and time (*in ISO-8601 format*) when the Balance Transaction Schedule was created.
format: date-time
x-stainless-skip:
- terraform
dtLastModified:
type: string
description: The date and time (*in ISO-8601 format*) when the Balance Transaction Schedule was last modified.
format: date-time
x-stainless-skip:
- terraform
createdBy:
type: string
description: The unique identifier (UUID) of the user who created this Balance Transaction Schedule.
x-stainless-skip:
- terraform
lastModifiedBy:
type: string
description: The unique identifier (UUID) of the user who last modified this Balance Transaction Schedule.
x-stainless-skip:
- terraform
nextRun:
type: string
description: The date and time (*in ISO-8601 format*) when the next Transaction will be generated by the Balance Transaction Schedule.
format: date-time
previousRun:
type: string
description: The date and time (*in ISO-8601 format*) when the previous Transaction was generated by the Balance Transaction Schedule.
format: date-time
AbstractRequestWithCustomFields:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractRequest'
- properties:
customFields:
type: object
description: 'User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.
If `customFields` can also be defined for this entity at the Organizational level, `customField` values defined at individual level override values of `customFields` with the same name defined at Organization level.
See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.'
maxItems: 100
additionalProperties:
anyOf:
- title: StringCustomFieldReq
type: string
- title: IntegerCustomFieldReq
type: integer
- title: NumberCustomFieldReq
type: number
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: ''
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: ''
ScheduleFrequency:
type: string
description: Represents standard scheduling frequencies options for a job.
enum:
- DAILY
- WEEKLY
- MONTHLY
- ANNUALLY
AbstractResponseWithCustomFields:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractResponse'
- properties:
customFields:
type: object
description: 'User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.
If `customFields` can also be defined for this entity at the Organizational level,`customField` values defined at individual level override values of `customFields` with the same name defined at Organization level.
See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.'
additionalProperties:
anyOf:
- title: StringCustomFieldRes
type: string
- title: IntegerCustomFieldRes
type: integer
- title: NumberCustomFieldRes
type: number
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