Skip to main content
POST
/
cleemy-procurement
/
api
/
natures
Create a Nature
curl --request POST \
  --url https://{host}/cleemy-procurement/api/natures \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "costFamilyId": 123,
  "accountingPlans": [
    {
      "id": 123,
      "chargeAccount": "<string>"
    }
  ]
}
'
import requests

url = "https://{host}/cleemy-procurement/api/natures"

payload = {
"name": "<string>",
"costFamilyId": 123,
"accountingPlans": [
{
"id": 123,
"chargeAccount": "<string>"
}
]
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
costFamilyId: 123,
accountingPlans: [{id: 123, chargeAccount: '<string>'}]
})
};

fetch('https://{host}/cleemy-procurement/api/natures', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/cleemy-procurement/api/natures",
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>',
'costFamilyId' => 123,
'accountingPlans' => [
[
'id' => 123,
'chargeAccount' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://{host}/cleemy-procurement/api/natures"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"costFamilyId\": 123,\n \"accountingPlans\": [\n {\n \"id\": 123,\n \"chargeAccount\": \"<string>\"\n }\n ]\n}")

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

req.Header.Add("Authorization", "<authorization>")
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))

}
HttpResponse<String> response = Unirest.post("https://{host}/cleemy-procurement/api/natures")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"costFamilyId\": 123,\n \"accountingPlans\": [\n {\n \"id\": 123,\n \"chargeAccount\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/cleemy-procurement/api/natures")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"costFamilyId\": 123,\n \"accountingPlans\": [\n {\n \"id\": 123,\n \"chargeAccount\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "costFamily": {
    "id": 123,
    "name": "<string>"
  },
  "accountingPlans": [
    {
      "id": 123,
      "chargeAccount": "<string>"
    }
  ]
}

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Body

application/json

Nature to create.

A purchase nature (category).

name
string
costFamilyId
integer<int32> | null
write-only

Write-only. ID of the cost family.

state
enum<string>
Available options:
Enabled,
Disabled
accountingPlans
object[]

Accounting plans for this nature.

Response

201 - application/json

Created

A purchase nature (category).

id
integer<int32>
read-only
name
string
costFamily
object | null
read-only

Read-only. Cost family of this nature.

state
enum<string>
Available options:
Enabled,
Disabled
accountingPlans
object[]

Accounting plans for this nature.