Create TransactionType - m3ter Documentation

Create TransactionType

cURL

curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/picklists/transactiontypes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "version": 123,
  "code": "code",
  "archived": true
}
'```

### Python

```python
import requests

url = "https://api.m3ter.com/organizations/{orgId}/picklists/transactiontypes"

payload = {
    "name": "<string>",
    "version": 123,
    "code": "code",
    "archived": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', version: 123, code: 'code', archived: true})
};

fetch('https://api.m3ter.com/organizations/{orgId}/picklists/transactiontypes', 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}/picklists/transactiontypes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'version' => 123,
    'code' => 'code',
    'archived' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api.m3ter.com/organizations/{orgId}/picklists/transactiontypes"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"version\": 123,\n  \"code\": \"code\",\n  \"archived\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Content-Type", "application/json")

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}/picklists/transactiontypes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"version\": 123,\n  \"code\": \"code\",\n  \"archived\": true\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/picklists/transactiontypes")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"version\": 123,\n  \"code\": \"code\",\n  \"archived\": true\n}"

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

Response

Success Response 200

{
  "id": "<string>",
  "version": 123,
  "code": "<string>",
  "name": "<string>",
  "archived": true,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Error Response 4XX

{
  "message": "<string>"
}

Error Response 5XX

{
  "message": "<string>"
}

Authorizations

Authorization

string
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

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Body

application/json

name

string
required

The name of the entity.

Required string length: 1 - 200

version

integer<int64>

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.

code

string

The short code for the entity.

Maximum string length: 80

Pattern: ^[\p{L}_$][\p{L}_$0-9]*$

Example:
"code"

archived

boolean

A Boolean TRUE / FALSE flag indicating whether the entity is archived. An entity can be archived if it is obsolete.

TRUE - the entity is in the archived state.
FALSE - the entity is not in the archived state.

Response

200

application/json

Return the created TransactionType

id

string
required

The UUID of the entity.

version

integer<int64>

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.

code

string

The short code of the data entity.

name

string

The name of the data entity.

archived

boolean

TRUE / FALSE flag indicating whether the data entity is archived. An entity can be archived if it is obsolete.

dtCreated

string<date-time>

The date and time (in ISO-8601 format) when the TransactionType was created.

dtLastModified

string<date-time>

The date and time (in ISO-8601 format) when the TransactionType was last modified.

createdBy

string

The unique identifier (UUID) of the user who created this TransactionType.

lastModifiedBy

string

The unique identifier (UUID) of the user who last modified this TransactionType.