Dodaj firmę
Informacje
Za pomocą tej metody api dodasz firmę do systemu qcadoo.
Moduł integracyjny: urcBasic
URL: /integration/rest/company.html
Metoda http: POST
Zawartość żądania
{
"number" : "number",
"name" : "name",
"externalID" : "externalID",
"tax" : "tax",
"street" : "street",
"house" : "house",
"flat" : "flat",
"zipCode" : "zipCode",
"city" : "city",
"state" : "state",
"country" : "country",
"email" : "email",
"website" : "website",
"phone" : "phone",
"isSupplier" : true,
"isReceiver" : false
}
Nazwa | Typ | Wymagalność | Unikalność | Zawartość |
---|---|---|---|---|
name | tekst(255) | T | N | nazwa |
number | tekst(255) | T | T | numer |
externalID | tekst | N | T | id/numer w systemie zewnętrznym |
tax | tekst | N | N | NIP |
street | tekst | N | N | ulica |
house | tekst(30) | N | N | nr domu |
flat | tekst(30) | N | N | nr mieszkania |
zipCode | tekst | N | N | kod pocztowy |
city | tekst | N | N | miasto |
state | tekst | N | N | województwo |
country | tekst | N | N | kraj lub jego kod |
tekst | N | N | ||
website | tekst | N | N | adres www |
phone | tekst | N | N | telefon |
isSupplier | true/false | N | N | dostawca |
isReceiver | true/false | N | N | odbiorca |
Zawartość odpowiedzi
{
"status": "OK",
"message": null // Gdy status ERROR - informacja z przyczyną błędu
}
Działanie
Metoda tworzy w systemie qcadoo firmę o podanych danych. Podczas dodawania, prowadzone są wszystkie walidacje dla tego obiektu (analogiczne, jak przy ręcznym dodawaniu wprost do systemu).
Aktualizuj firmę
Informacje
Za pomocą tej metody api zaktualizujesz firmę o wskazanym ID.
Moduł integracyjny: urcBasic
URL: /integration/rest/company/{id}.html
Metoda http: PUT
Zawartość żądania
{
"number" : "number",
"name" : "name",
"externalID" : "externalID",
"tax" : "tax",
"street" : "street",
"house" : "house",
"flat" : "flat",
"zipCode" : "zipCode",
"city" : "city",
"state" : "state",
"country" : "country",
"email" : "email",
"website" : "website",
"phone" : "phone",
"isSupplier" : false,
"isReceiver" : true
}
Nazwa | Typ | Wymagalność | Unikalność | Zawartość |
---|---|---|---|---|
name | tekst(255) | T | N | nazwa |
number | tekst(255) | T | T | numer |
externalID | tekst | N | T | id/numer w systemie zewnętrznym |
tax | tekst | N | N | NIP |
street | tekst | N | N | ulica |
house | tekst(30) | N | N | nr domu |
flat | tekst(30) | N | N | nr mieszkania |
zipCode | tekst | N | N | kod pocztowy |
city | tekst | N | N | miasto |
state | tekst | N | N | województwo |
country | tekst | N | N | kraj lub jego kod |
tekst | N | N | ||
website | tekst | N | N | adres www |
phone | tekst | N | N | telefon |
isSupplier | true/false | N | N | dostawca |
isReceiver | true/false | N | N | odbiorca |
Zawartość odpowiedzi
{
"status": "OK",
"message": null // Gdy status ERROR - informacja z przyczyną błędu
}
Działanie
Metoda powoduje zaktualizowanie danych firmy o podanym id. Wszystkie dane kontrahenta w systemie, zostaną nadpisane danymi z kominikatu. Podczas aktualizacji przeprowadzane są wszystkie systemowe walidacje.