M3ter Integration Transformations API

openapi: 3.2.0
info:
  title: m3ter Integration Transformations API
  description: 'If you are using Postman, you can:

    - 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 in our main user Documentation for details. - Copy this link: m3ter-Template API Collection and use it to import the **m3ter-Template API Collection** into your Workspace. See Importing the m3ter Template API Collection in our main user Documentation for details. ---


    # Introduction

    The m3ter platform supports two HTTP-based REST APIs returning JSON encoded responses:

    - The **Ingest API**, which you can use for submitting raw data measurements. *(See the Submit Measurements endpoint in this API Reference.)*

    - The **Config API**, which you can use for configuration and management. *(All other endpoints in this API Reference.)*


    ## Authentication and Authorization

    Our APIs use an industry-standard authorization protocol known as the OAuth 2.0 specification. OAuth2 supports several grant types, each designed for a specific use case. m3ter uses the following two grant types:

    - **Authorization Code**: Used for human login access via the m3ter Console. - **Client Credentials**: Used for machine-to-machine communication and API access. Complete the following flow for API access:


    1. **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. 2. **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. See Service Authentication for detailed instructions and an example. 3. **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.*


    4. **Bearer Token Usage**: Use the HTTP ''Authorization'' header with the bearer token to authorise all subsequent API requests. > Warning: The Bearer Token is valid for 18,000 seconds or 5 hours. When the token has expired, you must obtain a new one. Below are two examples for obtaining a Bearer Token using Basic Auth: the first in cURL and the second as a Python script. ### cURL Example

    1. Open your terminal or command prompt. 2. Use the following `cURL` command to obtain a Bearer Token:


    ```bash

    curl -X POST https://api.m3ter.com/oauth/token \

    -H ''Content-Type: application/x-www-form-urlencoded'' \

    -u your_access_key_id:your_api_secret \

    -d ''grant_type=client_credentials''

    ```


    Replace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**. 3. Run the command, and if successful, it will return a JSON response containing the Bearer Token. The response will look like this:


    ```json

    {

    "access_token": "your_bearer_token",

    "token_type": "Bearer",

    "expires_in": 18000

    }

    ```


    You can then use the Bearer Token *(the value of `"access_token"`)* for subsequent API calls to m3ter. ### Python Example

    1. Install the `requests` library if you haven''t already:


    ```bash

    pip install requests

    ```


    2.'
  version: '1.0'
  x-logo:
    url: https://console.m3ter.com/m3ter-logo-black.svg
servers:
- url: https://api.m3ter.com
security:
- OAuth2: []
tags:
- name: IntegrationTransformations
  description: Endpoints for configuring transformations
paths:
  /organizations/{orgId}/integrationtransformations:
    get:
      tags:
      - IntegrationTransformations
      summary: Retrieve IntegrationTransformations
      description: Retrieve the integration transformations
      operationId: GetIntegrationTransformations
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: pageSize
        in: query
        description: Number of transformations 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: NextToken for multi page retrievals
        required: false
        allowEmptyValue: true
        style: form
        explode: true
        schema:
          type: string
      - name: destinationSystem
        in: query
        description: Destination system to retrieve transformation for
        required: false
        allowEmptyValue: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Return a list of transformations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedData_Object_'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    post:
      tags:
      - IntegrationTransformations
      summary: Create a new transformation
      operationId: CreateIntegrationTransformation
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: transformation details to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationTransformationRequest'
        required: true
      responses:
        '200':
          description: Return the IntegrationTransformation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationTransformationResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
  /organizations/{orgId}/integrationtransformations/preview:
    post:
      tags:
      - IntegrationTransformations
      summary: Preview a transformation against an existing entity
      description: Create a new transformation
      operationId: PreviewIntegrationTransformation
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: transformation details to preview
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationTransformationPreviewRequest'
        required: true
      responses:
        '200':
          description: Return the IntegrationTransformationPreviewResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationTransformationPreviewResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
  /organizations/{orgId}/integrationtransformations/systems:
    get:
      tags:
      - IntegrationTransformations
      summary: Preview a transformation against an existing entity
      description: Create a new transformation
      operationId: ListSupportedSystems
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Return the list of supported systems
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedSystemsResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
  /organizations/{orgId}/integrationtransformations/{id}:
    get:
      tags:
      - IntegrationTransformations
      summary: Get IntegrationTransformation for the UUID
      description: Retrieve the integration transformation for the id
      operationId: GetIntegrationTransformationForId
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: The UUID of the entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Return the IntegrationTransformation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationTransformationResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    put:
      tags:
      - IntegrationTransformations
      summary: Update the IntegrationTransformation for the UUID
      description: Update the integration transformation for the id
      operationId: PutIntegrationTransformationForId
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: The UUID of the entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationTransformationRequest'
        required: true
      responses:
        '200':
          description: Return the IntegrationTransformation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationTransformationResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    delete:
      tags:
      - IntegrationTransformations
      summary: Delete IntegrationTransformation for the UUID
      description: Deletes the integration transformation for the id
      operationId: DeleteIntegrationTransformationForId
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: The UUID of the entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Return the deleted IntegrationTransformation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationTransformationResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  schemas:
    AbstractLookupResponse:
      required:
      - destinationField
      - type
      type: object
      properties:
        destinationField:
          type: string
          description: ''
        type:
          description: ''
          $ref: '#/components/schemas/LookupType'
      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: ''
    TypeValidationErrorResponse:
      required:
      - field
      - message
      - severity
      type: object
      properties:
        message:
          type: string
          description: ''
        field:
          type: string
          description: ''
        severity:
          description: ''
          $ref: '#/components/schemas/TypeValidationSeverity'
      description: ''
    TypeValidationSeverity:
      type: string
      description: ''
      enum:
      - ERROR
      - WARNING
      - INFO
    SupportedSystemsResponse:
      required:
      - systems
      type: object
      properties:
        systems:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/SystemResponse'
      description: List of supported systems
    SystemResponse:
      type: object
      properties:
        identifier:
          type: string
          description: System name
        displayName:
          type: string
          description: User friendly display name
        validationSupported:
          type: boolean
          description: Whether or not m3ter supports validation of requests for this system. Requests will need to made without validation
        supportedAuthTypes:
          type: array
          description: List of supported auth types
          items:
            $ref: '#/components/schemas/AuthType'
      description: Response containing information about a system that m3ter can integrate with
    IntegrationTransformationPreviewRequest:
      required:
      - entity
      - entityId
      - entitySchema
      - rawData
      - system
      - transformations
      type: object
      properties:
        entity:
          type: string
          description: ''
        entityId:
          type: string
          description: ''
        system:
          type: string
          description: ''
        entitySchema:
          type: string
          description: ''
        transformations:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/AbstractLookupRequest'
        rawData:
          type: object
          additionalProperties: true
          description: ''
      description: ''
    LookupType:
      type: string
      description: ''
      enum:
      - CALCULATION
      - STATIC
      - LOOKUP
    IntegrationTransformationPreviewResponse:
      type: object
      properties:
        transformedObject:
          type: object
          additionalProperties: true
          description: ''
        validationErrors:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/TypeValidationErrorResponse'
      description: Response containing a preview of a transformation
    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: ''
    PaginatedData_Object_:
      type: object
      properties:
        data:
          type: array
          description: An array containing the list of requested external entities.
          items:
            type: object
        nextToken:
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of external entities in a paginated list.
      description: ''
    AbstractResponseWithAuditFields:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractResponse'
      - type: object
        properties:
          dtCreated:
            type: string
            description: The DateTime when this item was created *(in ISO-8601 format)*.
            format: date-time
            x-stainless-skip: terraform
          dtLastModified:
            type: string
            description: The DateTime when this item was last modified *(in ISO-8601 format)*.
            format: date-time
            x-stainless-skip: terraform
          createdBy:
            type: string
            description: The ID of the user who created this item.
            x-stainless-skip: terraform
          lastModifiedBy:
            type: string
            description: The ID of the user who last modified this item.
            x-stainless-skip: terraform
    IntegrationTransformationRequest:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractRequest'
      - required:
        - description
        - destinationSystem
        - destinationTable
        - name
        - sourceSystem
        - sourceTable
        - transformations
        type: object
        properties:
          name:
            minLength: 1
            type: string
            description: ''
            example: m3ter Bill to Netsuite Invoice
          description:
            minLength: 1
            type: string
            description: ''
            example: Transforms a m3ter Bill into a Netsuite Invoice
          sourceSystem:
            minLength: 1
            type: string
            description: ''
            example: m3ter
          destinationSystem:
            minLength: 1
            type: string
            description: ''
            example: Netsuite
          sourceTable:
            minLength: 1
            type: string
            description: ''
            example: Bill
          destinationTable:
            minLength: 1
            type: string
            description: ''
            example: customrecord_invoice
          transformations:
            minItems: 1
            type: array
            description: ''
            example:
            - destinationField: m3terId
              type: LOOKUP
              sourceField: id
            discriminator:
              propertyName: type
              mapping:
                CALCULATION: '#/components/schemas/CalculationLookupRequest'
                LOOKUP: '#/components/schemas/FieldLookupRequest'
                STATIC: '#/components/schemas/StaticValueRequest'
            items:
              $ref: '#/components/schemas/AbstractLookupRequest'
    AbstractLookupRequest:
      required:
      - destinationField
      - type
      type: object
      properties:
        destinationField:
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]*$
          type: string
          description: ''
        type:
          description: ''
          $ref: '#/components/schemas/LookupType'
      description: ''
    AuthType:
      type: string
      description: ''
      enum:
      - OAUTH_CODE
      - OAUTH_CLIENT_CREDENTIALS
      - HTTP_BASIC
      - M3TER_SIGNED_REQUEST
      - AWS_INTEGRATION
      - PADDLE
      - NETSUITE
      - CHARGEBEE
      - M3TER_APP_SIGNATURE
      - M3TER_SERVICE_USER
      - STRIPE_SIGNED_REQUEST
      - OPSGENIE_KEY
      - SAP_BYD
      - HUBSPOT_ACCESS_TOKEN
      - HUBSPOT_CLIENT_SECRET
      - SLACK_WEBHOOK
      - SAGE_INTACCT_CLIENT_CREDENTIALS
      - SAGE_INTACCT_CLIENT_SECRET
      - STATIC_API_KEY
      - GCP_WIF
      - SNS_REQUEST
    IntegrationTransformationResponse:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractResponseWithAuditFields'
      - $ref: '#/components/schemas/AbstractResponse'
      - type: object
        properties:
          name:
            type: string
            description: ''
            example: m3ter Bill to Netsuite Invoice
          description:
            type: string
            description: ''
            example: Transforms a m3ter Bill into a Netsuite Invoice
          sourceSystem:
            type: string
            description: ''
            example: m3ter
          destinationSystem:
            type: string
            description: ''
            example: Netsuite
          sourceTable:
            type: string
            description: ''
            example: Bill
          destinationTable:
            type: string
            description: ''
            example: customrecord_invoice
          transformations:
            type: array
            description: ''
            example:
            - destinationField: m3terId
              type: LOOKUP
              sourceField: id
            discriminator:
              propertyName: type
              mapping:
                CALCULATION: '#/components/schemas/CalculationLookupResponse'
                LOOKUP: '#/components/schemas/FieldLookupResponse'
                STATIC: '#/components/schemas/StaticValueResponse'
            items:
              $ref: '#/components/schemas/AbstractLookupResponse'
        description: Response containing a IntegrationRun entity
  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
        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
x-provenance:
  method: harvested
  publisher: M3ter
  source: https://docs.m3ter.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)