Create Currency - m3ter Documentation

Create Currency

cURL

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

Python

import requests

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

payload = {
    "name": "<string>",
    "version": 123,
    "code": "code",
    "archived": True,
    "maxDecimalPlaces": 2
}
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,
    maxDecimalPlaces: 2
  })
};

fetch('https://api.m3ter.com/organizations/{orgId}/picklists/currency', 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/currency",
  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,
    'maxDecimalPlaces' => 2
  ]),
  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/currency"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"version\": 123,\n  \"code\": \"code\",\n  \"archived\": true,\n  \"maxDecimalPlaces\": 2\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))
}

Java

HttpResponse<String> response = Unirest.post("https://api.m3ter.com/organizations/{orgId}/picklists/currency")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"version\": 123,\n  \"code\": \"code\",\n  \"archived\": true,\n  \"maxDecimalPlaces\": 2\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

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

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  \"maxDecimalPlaces\": 2\n}"

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

Response

Success Response (200)

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

Error Responses

  1. 4XX
{
  "message": "<string>"
}
  1. 5XX
{
  "message": "<string>"
}

Authorizations

Authorization

Path Parameters

Parameter Type Description
orgId string Required; The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

Body

Field Type Description
name string Required; The name of the entity. Required string length: 1 - 200
version integer The version number of the entity. Do not use for Create.
code string The short code for the entity. Maximum string length: 80. Pattern: ^[\p{L}$_][\p{L}$_0-9]*$
archived boolean TRUE/FALSE indicating whether the entity is archived.
maxDecimalPlaces integer Indicates the maximum number of decimal places to use for this Currency. Required range: 0 <= x <= 5

Response Fields

Field Type Description
id string The UUID of the entity.
version integer The version number: set at 1 for new entity.
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.
maxDecimalPlaces integer Maximum number of decimal places.
dtCreated string The date and time when the Currency was created.
dtLastModified string When the Currency was last modified.
createdBy string The unique identifier (UUID) of the user who created this Currency.
lastModifiedBy string The unique identifier (UUID) of the user who last modified this Currency.