Cancel StatementJob - m3ter Documentation

Cancel StatementJob

cURL

curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/statementjobs/{id}/cancel \
  --header 'Authorization: Bearer <token>'

Python

import requests

url = "https://api.m3ter.com/organizations/{orgId}/statementjobs/{id}/cancel"

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

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

print(response.text)

JavaScript (Fetch)

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

fetch('https://api.m3ter.com/organizations/{orgId}/statementjobs/{id}/cancel', 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}/statementjobs/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/statementjobs/{id}/cancel"

req, _ := http.NewRequest("POST", 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.post("https://api.m3ter.com/organizations/{orgId}/statementjobs/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/statementjobs/{id}/cancel")

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

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

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

Response Codes

• 200: Successful cancellation of StatementJob.
• 4XX: Client error (e.g., unauthorized, not found).
• 5XX: Server error.

Example Response (200)

{
  "id": "<string>",
  "version": 123,
  "billId": "<string>",
  "orgId": "<string>",
  "includeCsvFormat": true,
  "filters": {
    "meterIds": [
      "<string>"
    ]
  },
  "presignedJsonStatementUrl": "<string>",
  "presignedCsvStatementUrl": "<string>",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Example Response (Error Message)

{
  "message": "<string>"
}

Authorizations

• Authorization: string in header, required.

Path Parameters

• orgId: string, required. The unique identifier (UUID) of your Organization.
• id: string, required. The unique identifier (UUID) of the StatementJob to cancel.

Response

Returns the cancelled StatementJob in application/json format.