{
  "opencollection": "1.0.0",
  "info": {
    "name": "m3ter Account Balances API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Balances",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.m3ter.com/organizations/:orgId/balances/:balanceId/transactions",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service."
              },
              {
                "name": "balanceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for the Balance whose Transactions you want to retrieve."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The maximum number of transactions to return per page."
              },
              {
                "name": "nextToken",
                "value": "",
                "type": "query",
                "description": "`nextToken` for multi page retrievals. A token for retrieving the next page of transactions. You'll get this from the response to your request. "
              },
              {
                "name": "transactionTypeId",
                "value": "",
                "type": "query"
              },
              {
                "name": "entityType",
                "value": "",
                "type": "query"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve all Transactions for a specific Balance.\n\nThis endpoint returns a list of all Transactions associated with a specific Balance. You can paginate through the Transactions by using the `pageSize` and `nextToken` parameters."
        },
        {
          "info": {
            "name": "Create Balance Transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.m3ter.com/organizations/:orgId/balances/:balanceId/transactions",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service."
              },
              {
                "name": "balanceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for the Balance to which you want to add a transaction."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a Transaction to a Balance. This endpoint allows you to create a new Transaction amount for a Balance. This amount then becomes available at billing for draw-down to cover charges due. The Transaction details should be provided in the request body.\n\nBefore you can add a Transaction amount, you must first set up Transaction Types at the Organization Level - see the [Transaction Type](https://www.m3ter.com/docs/api#tag/TransactionType) section in this API Reference for more details. You can th"
        },
        {
          "info": {
            "name": "Get Balance Transactions Summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.m3ter.com/organizations/:orgId/balances/:balanceId/transactions/summary",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "UUID of the organization"
              },
              {
                "name": "balanceId",
                "value": "",
                "type": "path",
                "description": "The UUID of the Balance"
              }
            ]
          },
          "docs": "Retrieves the Balance Transactions Summary for a given Balance.\n\nThe response contains useful recorded and calculated Transaction amounts created for a Balance during the time it is active for the Account, including amounts relevant to any rollover amount configured for a Balance:\n* `totalCreditAmount`. The sum of all credits amounts created for the Balance.\n* `totalDebitAmount`. The sum of all debit amounts created for the Balance.\n* `initialCreditAmount`. The initial credit amount created for "
        },
        {
          "info": {
            "name": "List Balances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.m3ter.com/organizations/:orgId/balances",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for your organization. The Organization represents your company as a direct customer of our service. "
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The maximum number of Balances to return per page."
              },
              {
                "name": "nextToken",
                "value": "",
                "type": "query",
                "description": "The `nextToken` for retrieving the next page of Balances. It is used to fetch the next page of Balances in a paginated list."
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "The unique identifier (UUID) for the end customer's account."
              },
              {
                "name": "endDateStart",
                "value": "",
                "type": "query",
                "description": "Only include Balances with end dates equal to or later than this date. If a Balance has a rollover amount configured, then the `rolloverEndDate` will be used as the end date."
              },
              {
                "name": "endDateEnd",
                "value": "",
                "type": "query",
                "description": "Only include Balances with end dates earlier than this date. If a Balance has a rollover amount configured, then the `rolloverEndDate` will be used as the end date."
              },
              {
                "name": "contract",
                "value": "",
                "type": "query"
              },
              {
                "name": "contractId",
                "value": "",
                "type": "query",
                "description": "Filter Balances by contract id. Use '' with accountId to fetch unlinked balances."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "A list of unique identifiers (UUIDs) for specific Balances to retrieve."
              }
            ]
          },
          "docs": "Retrieve a list of all Balances for your Organization.\n\nThis endpoint returns a list of all Balances associated with your organization. You can filter the Balances by the end customer's Account UUID and end dates, and paginate through them using the `pageSize` and `nextToken` parameters.\n\n**NOTE:** If a Balance has a rollover amount configured and you want to use the `endDateStart` or `endDateEnd` query parameters, the `rolloverEndDate` is used as the end date for the Balance."
        },
        {
          "info": {
            "name": "Create Balance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.m3ter.com/organizations/:orgId/balances",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Balance for the given end customer Account. \n\nThis endpoint allows you to create a new Balance for a specific end customer Account. The Balance details should be provided in the request body."
        },
        {
          "info": {
            "name": "Retrieve Balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.m3ter.com/organizations/:orgId/balances/:id",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) of the Balance to retrieve."
              }
            ]
          },
          "docs": "Retrieve a specific Balance.\n\nThis endpoint returns the details of the specified Balance."
        },
        {
          "info": {
            "name": "Update Balance",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.m3ter.com/organizations/:orgId/balances/:id",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) of the Balance to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a specific Balance.\n\nThis endpoint allows you to update the details of a specific Balance. The updated Balance details should be provided in the request body."
        },
        {
          "info": {
            "name": "Delete Balance",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.m3ter.com/organizations/:orgId/balances/:id",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier (UUID) of the Balance to delete."
              }
            ]
          },
          "docs": "Delete a specific Balance.\n\nThis endpoint allows you to delete a specific Balance with the given UUID."
        }
      ]
    }
  ],
  "bundled": true
}