List BalanceTransactionSchedule - m3ter Documentation

List BalanceTransactionSchedule

cURL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules \
  --header 'Authorization: Bearer <token>'

Python

import requests

url = "https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  CURLOPT_HTTPHEADER => [\
    "Authorization: Bearer <token>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.get("https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

API Responses

Success (200)

{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "balanceId": "<string>",
      "name": "<string>",
      "code": "<string>",
      "amount": 123,
      "transactionDescription": "<string>",
      "paid": 123,
      "currencyPaid": "<string>",
      "transactionTypeId": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "frequency": "<unknown>",
      "frequencyInterval": 123,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "nextRun": "2023-11-07T05:31:56Z",
      "previousRun": "2023-11-07T05:31:56Z"
    }
  ],
  "nextToken": "<string>"
}

Client Errors (4XX)

{
  "message": "<string>"
}

Server Errors (5XX)

{
  "message": "<string>"
}

Authorizations

Authorization

Type: string Location: header Required

• m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.
• The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

• orgId (string, required): UUID of the organization
• balanceId (string, required): UUID of the balance

Query Parameters

• pageSize (integer): Number of BalanceTransactionSchedules to retrieve per page
  • Required range: 1 <= x <= 200
• nextToken (string): nextToken for multi-page retrievals
• ids (string[]): Maximum array length: 200

Response

200 application/json

• data (object[]): { ... }
• nextToken (string)