Skip to main content
POST
/
cleemy-procurement
/
api
/
suppliers
Create a Supplier
curl --request POST \
  --url https://{host}/cleemy-procurement/api/suppliers \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "territory": {
    "id": 123
  },
  "territoryId": "<string>",
  "legalRegistration": {
    "identifier": "<string>",
    "vatNumber": "<string>"
  },
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>"
    }
  ],
  "paymentTerm": {
    "value": 123
  },
  "bankAccount": {
    "iban": "<string>",
    "bic": "<string>"
  },
  "preferredNatureId": 123,
  "preferredCostCenterId": 123
}
'
import requests

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

payload = {
    "name": "<string>",
    "territory": { "id": 123 },
    "territoryId": "<string>",
    "legalRegistration": {
        "identifier": "<string>",
        "vatNumber": "<string>"
    },
    "contacts": [
        {
            "firstName": "<string>",
            "lastName": "<string>",
            "email": "jsmith@example.com",
            "phone": "<string>"
        }
    ],
    "paymentTerm": { "value": 123 },
    "bankAccount": {
        "iban": "<string>",
        "bic": "<string>"
    },
    "preferredNatureId": 123,
    "preferredCostCenterId": 123
}
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>',
    territory: {id: 123},
    territoryId: '<string>',
    legalRegistration: {identifier: '<string>', vatNumber: '<string>'},
    contacts: [
      {
        firstName: '<string>',
        lastName: '<string>',
        email: 'jsmith@example.com',
        phone: '<string>'
      }
    ],
    paymentTerm: {value: 123},
    bankAccount: {iban: '<string>', bic: '<string>'},
    preferredNatureId: 123,
    preferredCostCenterId: 123
  })
};

fetch('https://{host}/cleemy-procurement/api/suppliers', 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/suppliers",
  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>',
    'territory' => [
        'id' => 123
    ],
    'territoryId' => '<string>',
    'legalRegistration' => [
        'identifier' => '<string>',
        'vatNumber' => '<string>'
    ],
    'contacts' => [
        [
                'firstName' => '<string>',
                'lastName' => '<string>',
                'email' => 'jsmith@example.com',
                'phone' => '<string>'
        ]
    ],
    'paymentTerm' => [
        'value' => 123
    ],
    'bankAccount' => [
        'iban' => '<string>',
        'bic' => '<string>'
    ],
    'preferredNatureId' => 123,
    'preferredCostCenterId' => 123
  ]),
  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/suppliers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"territory\": {\n    \"id\": 123\n  },\n  \"territoryId\": \"<string>\",\n  \"legalRegistration\": {\n    \"identifier\": \"<string>\",\n    \"vatNumber\": \"<string>\"\n  },\n  \"contacts\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\"\n    }\n  ],\n  \"paymentTerm\": {\n    \"value\": 123\n  },\n  \"bankAccount\": {\n    \"iban\": \"<string>\",\n    \"bic\": \"<string>\"\n  },\n  \"preferredNatureId\": 123,\n  \"preferredCostCenterId\": 123\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/suppliers")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"territory\": {\n    \"id\": 123\n  },\n  \"territoryId\": \"<string>\",\n  \"legalRegistration\": {\n    \"identifier\": \"<string>\",\n    \"vatNumber\": \"<string>\"\n  },\n  \"contacts\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\"\n    }\n  ],\n  \"paymentTerm\": {\n    \"value\": 123\n  },\n  \"bankAccount\": {\n    \"iban\": \"<string>\",\n    \"bic\": \"<string>\"\n  },\n  \"preferredNatureId\": 123,\n  \"preferredCostCenterId\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"territory\": {\n    \"id\": 123\n  },\n  \"territoryId\": \"<string>\",\n  \"legalRegistration\": {\n    \"identifier\": \"<string>\",\n    \"vatNumber\": \"<string>\"\n  },\n  \"contacts\": [\n    {\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"email\": \"jsmith@example.com\",\n      \"phone\": \"<string>\"\n    }\n  ],\n  \"paymentTerm\": {\n    \"value\": 123\n  },\n  \"bankAccount\": {\n    \"iban\": \"<string>\",\n    \"bic\": \"<string>\"\n  },\n  \"preferredNatureId\": 123,\n  \"preferredCostCenterId\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "territory": {
    "id": 123,
    "name": "<string>",
    "href": "<string>"
  },
  "legalRegistration": {
    "identifier": "<string>",
    "vatNumber": "<string>"
  },
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>"
    }
  ],
  "paymentTerm": {
    "value": 123
  },
  "bankAccount": {
    "iban": "<string>",
    "bic": "<string>"
  },
  "preferredNature": {
    "id": 123,
    "name": "<string>",
    "href": "<string>"
  },
  "preferredCostCenter": {
    "id": 123,
    "name": "<string>",
    "code": "<string>",
    "href": "<string>"
  },
  "establishments": [
    {
      "id": 123,
      "name": "<string>",
      "href": "<string>"
    }
  ]
}

Headers

Authorization
string
required

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

Body

application/json

Supplier to create.

A supplier.

name
string
state
enum<string>
Available options:
Active,
Archived
territory
Reference to a territory · object

Read-only. Territory of the supplier.

territoryId
string
write-only

Write-only. ID of the territory.

contacts
object[]
paymentTerm
object | null

Default payment term for this supplier.

bankAccount
object | null
preferredNatureId
integer<int32> | null
write-only

Write-only. ID of the preferred nature.

preferredPaymentMethod
enum<string> | null

BankTransfer: bank transfer. PhysicalCard: physical card. Check: check. DirectDebit: direct debit. SingleUseCard: single use card.

Available options:
BankTransfer,
PhysicalCard,
Check,
DirectDebit,
SingleUseCard
preferredCostCenterId
integer<int32> | null
write-only

Write-only. ID of the preferred cost-center.

Response

201 - application/json

Created

A supplier.

id
integer<int32>
read-only
name
string
state
enum<string>
Available options:
Active,
Archived
territory
Reference to a territory · object

Read-only. Territory of the supplier.

contacts
object[]
paymentTerm
object | null

Default payment term for this supplier.

bankAccount
object | null
preferredNature
object | null
read-only

Read-only. Preferred nature for this supplier.

preferredPaymentMethod
enum<string> | null

BankTransfer: bank transfer. PhysicalCard: physical card. Check: check. DirectDebit: direct debit. SingleUseCard: single use card.

Available options:
BankTransfer,
PhysicalCard,
Check,
DirectDebit,
SingleUseCard
preferredCostCenter
Reference to a cost-center · object

Read-only. Preferred cost-center for this supplier.

establishments
Reference to an establishment · object[]
read-only

Read-only. Establishments associated with this supplier.

flag
enum<string>
read-only
Available options:
Unflagged,
Flagged