Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET companies

Ostatnia modyfikacja 1970-01-02 01:00:00
Zwraca listę firm zawężoną o podane kryteria wyszukiwania.

URL

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

Parametry

identifier

opcjonalny

Identyfikator firmy. Jeśli zostanie ustawiony pusty zwróci firmy, które nie mają ustawionego identyfikatora. Przykładowa wartość: 3434558
email

opcjonalny

Adres e-mail firmy. Przykładowa wartość: jan.kowalski@foo.bar
phone_number

opcjonalny

Numer telefonu firmy. Przykładowa wartość: 555666777
nip

opcjonalny

Numer NIP firmy. Przykładowa wartość: 6783144527
type

opcjonalny

Tekstowa nazwa typu klienta zdefiniowana w systemie. Przykładowa wartość: custom type name
group

opcjonalny

Tekstowa nazwa grupy klienta zdefiniowana w systemie. Przykładowa wartość: custom group name
custom_fields

opcjonalny

Wyszukiwanie po wartościach pól specjalnych. Można wyszukiwać po wielu polach specjalnych na raz.
Dla każdego pola można podać kilka alternatywnych wartości.
Pole typu lista wielokrotnego wyboru pasuje, gdy zawiera którąkolwiek z podanych opcji.
Na przykład:
["custom_fields" => [
    "Kraj" => ["POLSKA", "NORWEGIA"],
    "Miasto" => "Kraków"
]];
Przykładowa wartość: custom_fields[Kraj][0]=POLSKA&custom_fields[Kraj][1]=NORWEGIA&custom_fields[Miasto]=Krak%C3%B3w
include_custom_fields

opcjonalny

Czy zwracać pola specjalne klienta. Przykładowa wartość: true
include_address

opcjonalny

Czy zwracać adres klienta. Przykładowa wartość: true
include_invoice_address

opcjonalny

Czy zwracać adres do faktur. Przykładowa wartość: true
include_mail_drop_address

opcjonalny

Czy zwracać adres korespondencyjny. Przykładowa wartość: true
limit

opcjonalny

Liczba rekordów, które mają być zwrócone. Domyślnie: 100. Maksymalna wartość: 1000. Przykładowa wartość: 100
offset

opcjonalny

Od którego rekordu należy zwrócić rezultat (używane, gdy rekordów jest więcej, niż limit). Domyślna wartość: 0. Przykładowa wartość: 10
order

opcjonalny

Lista pól, po których będą posortowane rezultaty. Prefiks '-' oznacza sortowanie malejące, brak prefiksu rosnące. Możliwe jest sortowanie po polach: name, nip, company_id, identifier. Przykładowa wartość: name,-customer_id,nip

Przykładowy request

GET https://your-system-name.thulium.com/api/companies?nip=6783144527&include_custom_fields=true&include_address=true

Przykładowy response

[
        {
        "name": "Thulium",
        "company_id": 28,
        "customer_id": 13,
        "identifier": "3434558",
        "phone_number": "123456789",
        "phone_numbers": ["123456789", "987654321"],
        "email": "thulium@example.com",
        "emails": ["thulium@example.com", "thulium.bok@example.com"],
        "type": "internal",
        "group": "partner",
        "nip": "6783144527",
        "account_manager":"",
        "address":
        {
            "street": "Zlotej Jesieni",
            "building": "7",
            "flat": null,
            "postcode": "31-827",
            "city": "Krakow",
            "post_office": "Krakow",
            "borough": null,
            "county": null,
            "voivodship": null,
            "country": "Poland"
        },
       "custom_fields":
       {
          "ID": null,
          "Additional info": "none"
       }
    }
]

Przykładowe wywołanie


PHP
<?php
$request = curl_init('https://your-system-name.thulium.com/api/companies?nip=6783144527&include_custom_fields=true&include_address=true');
curl_setopt($request, CURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($request, CURLOPT_USERPWD, "api_user:api_pass");
curl_setopt($request, CURLOPT_TIMEOUT, 30);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($request);
if ($response) {
    $httpCode = curl_getinfo($request, CURLINFO_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.get("https://your-system-name.thulium.com/api/companies?nip=6783144527&include_custom_fields=true&include_address=true");
        System.out.println(response);
    }
}

CURL
curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://your-system-name.thulium.com/api/companies?nip=6783144527&include_custom_fields=true&include_address=true"

HTTPie
http -a api_user:api_pass GET https://your-system-name.thulium.com/api/companies nip==6783144527 include_custom_fields==true include_address==true Accept:application/json