Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP PUT

PUT companies/:id

Ostatnia modyfikacja 2024-11-26 14:06:56

Edycja firmy.

URL

https://your-system-name.thulium.com/api/companies/:id

Parametry

name

opcjonalny

Nazwa firmy.
nip

opcjonalny

Numer NIP firmy. Jeśli jest podany, ma być unikatowy.
email

opcjonalny

Adres e-mail firmy.
phone_number

opcjonalny

Numer lub numery telefonu firmy.
type

opcjonalny

Tekstowa nazwa typu klienta zdefiniowana w systemie.
group

opcjonalny

Tekstowa nazwa grupy klienta zdefiniowana w systemie.
identifier

opcjonalny

Identyfikator firmy.
note

opcjonalny

Notatka.
custom_fields

opcjonalny

Obiekt z wartościami pól specjalnych. Przykładowa wartość: "custom_fields":{"field_name_1":"value_1","field_name_2":"value_2"}
fill_read_only_custom_fields

opcjonalny

Flaga definiująca czy pola specjalne zostaną wypełnione pomimo posiadania typu READ ONLY. Przykładowa wartość: true
account_manager

opcjonalny

Login opiekuna firmy
vip

opcjonalny

VIP Przykładowa wartość: true
address

opcjonalny

Adres firmy.
   street

   opcjonalny

Nazwa ulicy.
   building

   opcjonalny

Numer budynku.
   flat

   opcjonalny

Numer mieszkania.
   postcode

   opcjonalny

Kod pocztowy.
   city

   opcjonalny

Miasto.
   country

   opcjonalny

Kraj.
invoice_address

opcjonalny

Adres do faktur.
   street

   opcjonalny

Nazwa ulicy.
   building

   opcjonalny

Numer budynku.
   flat

   opcjonalny

Numer mieszkania.
   postcode

   opcjonalny

Kod pocztowy.
   city

   opcjonalny

Miasto.
   country

   opcjonalny

Kraj.
mail_drop_address

opcjonalny

Adres korespondencyjny.
   street

   opcjonalny

Nazwa ulicy.
   building

   opcjonalny

Numer budynku.
   flat

   opcjonalny

Numer mieszkania.
   postcode

   opcjonalny

Kod pocztowy.
   city

   opcjonalny

Miasto.
   country

   opcjonalny

Kraj.

Przykładowy request

PUT https://your-system-name.thulium.com/api/companies/23
Dane {"name":"company","nip":"6783144527","address":{"city":"Krakow","street":"Zlotej Jesieni"}}

Przykładowy response

<!-- pusty -->

Przykładowe wywołanie


PHP

<?php
$data 
'{"name":"company","nip":"6783144527","address":{"city":"Krakow","street":"Zlotej Jesieni"}}';

$request curl_init('https://your-system-name.thulium.com/api/companies/23');
curl_setopt($requestCURLOPT_HTTPHEADER, array(
    
'Content-Type: application/json; charset=utf-8',
    
'Content-Length: ' mb_strlen($data)
));
curl_setopt($requestCURLOPT_USERPWD'api_user:api_pass');
curl_setopt($requestCURLOPT_TIMEOUT30);
curl_setopt($requestCURLOPT_RETURNTRANSFERtrue);
curl_setopt($requestCURLOPT_CUSTOMREQUEST'PUT');
curl_setopt($requestCURLOPT_POSTFIELDS$data);

$response curl_exec($request);
if (
$response) {
    
$httpCode curl_getinfo($requestCURLINFO_HTTP_CODE);
    if (
$httpCode == 200){
        
print_r(json_decode($response));
    } else {
        echo 
$response;
    }
} else {
    
trigger_error(curl_error($request), E_USER_WARNING);
}

curl_close($request);
JAVA

public class Example {
    public static void main(String[] args) throws Exception {
        ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true);

        ThuliumRestClient.ThuliumRestResponse response = restClient.put("https://your-system-name.thulium.com/api/companies/23", "{\"name\":\"company\",\"nip\":\"6783144527\",\"address\":{\"city\":\"Krakow\",\"street\":\"Zlotej Jesieni\"}}");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X PUT -H "Content-type: application/json" -d '{"name":"company","nip":"6783144527","address":{"city":"Krakow","street":"Zlotej Jesieni"}}' "https://your-system-name.thulium.com/api/companies/23"

HTTPie

echo '{"name":"company","nip":"6783144527","address":{"city":"Krakow","street":"Zlotej Jesieni"}}' | http -a api_user:api_pass PUT https://your-system-name.thulium.com/api/companies/23