addCompany
Dodanie nowego kontrahenta
Wymagane parametry
token, nazwa, miejscowosc, kod, ulica
Opcjonalne parametry
nip, nazwa_skrot, id_wojewodztwa, panstwo,
miejscowosc_dostawy, nazwa_dostawy, kod_dostawy, id_wojewodztwa_dostawy, panstwo_dostawy,
regon,uwagi,email,www,telefon,fax,id_ratingu,symbol_kontrahenta
id_grupy_cenowej - domyślnie 1
nipeu - jeśli jest to firma o ID = 1 (czyli właściciel programu) to pole to przyjmuje wartość będącą numerem NIP EU.
Jeśli jest to inna firma (kontrahent) to w tym polu podajemy numer państwa EU w którym siedzibę ma dany kontrahent.
termin_platnosci (int) - domyślny termin płatności (w dniach) na fakturach dla tego kontrahenta (termin_platnosci = 0 - zapłacono)
zaplanowany_kontakt - data w formacie YYYY-MM-DD
id_handlowca - id użytkownika przypisanego do danego kontrahenta. Jeśli nie podano to id użytkownika logującego się do API
konto_kontrahenta,bank_kontrahenta - pola dotyczą wyłącznie kontrahentów
Wartości zwracane
Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną
id dodanego parametru
W przypadku niepowodzenia:
$dane['error']['code']>0
Uwagi
Aby został dodany adres dostawy należy wypełnić co najmniej jedno z pól:
miejscowosc_dostawy, nazwa_dostawy, ulica_dostawy, kod_dostawy
Przykład wywołania w PHP
$c = curl_init();
curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
curl_setopt($c, CURLOPT_POSTFIELDS, 'act=addCompany'.
'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
'&nazwa=Enadis'.
'&miejscowosc=Gdynia'.
'&ulica=al. Zwycięstwa 96/98'.
'&kod=81-451'.
'&nip=5862120928'.
'&termin_platnosci=14'.
'&zaplanowany_kontakt=2013-06-21'.
'&email=kontakt@enadis.pl');
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
$wynik = curl_exec($c);
curl_close($c);
$dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd,
//jeśli tak, wyświetlamy go
echo 'Id nowego kontrahenta: ' . $dane['result'];
delCompany
Usunięcie istniejącego kontrahenta
Wymagane parametry
token, id
Opcjonalne parametry
brak
Wartości zwracane
Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną
id usuniętego kontrahenta
W przypadku niepowodzenia:
$dane['error']['code']>0
Przykład wywołania w PHP
$c = curl_init();
curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
curl_setopt($c, CURLOPT_POSTFIELDS, 'act=delCompany'.
'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
'&id=17');
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
$wynik = curl_exec($c);
curl_close($c);
$dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd,
//jeśli tak, wyświetlamy go
echo 'Id usuniętego kontrahenta: ' . $dane['result'];
updCompany
Edycja istniejącego kontrahenta
Wymagane parametry
token, id, nazwa, miejscowosc, kod, ulica
Opcjonalne parametry
nip, nazwa_skrot, id_wojewodztwa, panstwo, miejscowosc_dostawy, nazwa_dostawy, kod_dostawy, id_wojewodztwa_dostawy, panstwo_dostawy,
regon, uwagi, email, www, telefon, fax, id_ratingu, symbol_kontrahenta
id_grupy_cenowej - domyślnie 1
nipeu - jeśli jest to firma o ID = 1 (czyli właściciel programu) to pole to przyjmuje wartość będącą numerem NIP EU.
Jeśli jest to inna firma (kontrahent) to w tym polu podajemy numer państwa EU w którym siedzibę ma dany kontrahent.
termin_platnosci (int) - domyślny termin płatności (w dniach) na fakturach dla tego kontrahenta (termin_platnosci = 0 - zapłacono)
zaplanowany_kontakt - data w formacie YYYY-MM-DD
id_handlowca - id użytkownika przypisanego do danego kontrahenta. Jeśli nie podano to id użytkownika logującego się do API
konto_kontrahenta,bank_kontrahenta - pola dotyczą wyłącznie kontrahentów
Wartości zwracane
Zwracane wartości w przypadku powodzenia:
$dane['result'] - zawiera zmienną
id edytowanego kontrahenta
W przypadku niepowodzenia:
$dane['error']['code']>0
Uwagi
Uwagi:
Aby został dodany adres dostawy należy wypełnić co najmniej jedno z pól:
miejscowosc_dostawy, nazwa_dostawy, ulica_dostawy, kod_dostawy
Jeśli żadne z tych pól nie zostanie podane to adres dostawy jest usuwany!!
Przykład wywołania w PHP
$c = curl_init();
curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
curl_setopt($c, CURLOPT_POSTFIELDS, 'act=updCompany'.
'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
'&id=18'.
'&nazwa=Enadis'.
'&miejscowosc=Gdynia'.
'&ulica=al. Zwycięstwa 96/98'.
'&kod=81-451'.
'&nip=5862120928'.
'&termin_platnosci=14'.
'&zaplanowany_kontakt=2013-06-21'.
'&email=kontakt@enadis.pl');
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
$wynik = curl_exec($c);
curl_close($c);
$dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd,
//jeśli tak, wyświetlamy go
echo 'Id edytowanego kontrahenta: ' . $dane['result'];
getCompany
Pobranie informacji o kontrahencie
Wymagane parametry
token,
id - id kontrahenta
Opcjonalne parametry
brak
Wartości zwracane
Zwracane wartości w przypadku powodzenia:
$dane['result'] - jest tablicą asocjacyjną zawierającą:
nazwa,
id,
nip,
nazwa_skrot,
nipeu,
id_grupy_cenowej,
regon,
uwagi,
email,
www,
telefon,
fax,
id_ratingu,
naliczanie_odsetek,
termin_platnosci
,
zaplanowany_kontakt,
id_handlowca,
konto_kontrahenta,
bank_kontrahenta,
symbol_kontrahenta,
miejscowosc,
ulica,
id_wojewodztwa,
kod,
panstwo,
nazwa_dostawy,
miejscowosc_dostawy,
ulica_dostawy,
id_wojewodztwa_dostawy,
kod_dostawy,
panstwo_dostawy
danego kontrahenta
W przypadku niepowodzenia:
$dane['error']['code']>0
Przykład wywołania w PHP
$c = curl_init();
curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
curl_setopt($c, CURLOPT_POSTFIELDS, 'act=getCompany'.
'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
'&id=4');
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
$wynik = curl_exec($c);
curl_close($c);
$dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd,
//jeśli tak, wyświetlamy go
echo 'Id kontrahenta: ' . $dane['result']['id'] . ' Nazwa: ' . $dane['result']['nazwa'] .
' Miejscowość: ' . $dane['result']['miejscowosc'] . ' Ulica: ' . $dane['result']['ulica'] .
' Kod: ' . $dane['result']['kod'] . ' Nip: ' . $dane['result']['nip'];
listCompanies
Lista wszystkich kontrahentów
Wymagane parametry
token
Opcjonalne parametry
ids - zmienna zawierająca ID do wyświetlenia w postaci stringu, gdzie separatorem jest "," np. (1,2,4,12,23,45)
name – zmienna zawierająca nazwę kontrahenta. Możemy również użyć maski (nieznane znaki) znaku '*' jeśli chcemy znaleźć wszystkich kontrahentów o podobnej nazwie np. &name=*an-Kowalsk*
nip – zmienna zawierająca numer nip kontrahenta. Możemy również użyć maski (nieznane znaki) znaku '*' jeśli chcemy znaleźć wszystkich kontrahentów o podobnym nipie np. *3456789*
Wartości zwracane
Zwracane wartości w przypadku powodzenia:
$dane['result'] - jest tablicą asocjacyjną zawierającą,
nazwa,
id,
nip,
nazwa_skrot,
nipeu,
id_grupy_cenowej,
email,
miejscowosc,
ulica,
id_wojewodztwa,
kod,
panstwo,
nazwa_dostawy,
miejscowosc_dostawy,
ulica_dostawy,
id_wojewodztwa_dostawy ,
kod_dostawy,
panstwo_dostawy
W przypadku niepowodzenia:
$dane['error']['code']>0
Przykład wywołania w PHP
$c = curl_init();
curl_setopt($c, CURLOPT_URL, 'https://abcd.systim.pl/jsonAPI.php');
curl_setopt($c, CURLOPT_POST, true); //sposób przesyłania - (true metoda POST)
curl_setopt($c, CURLOPT_POSTFIELDS, 'act=listCompanies'.
'&token=6aed003dc54951c043f8d1ad4b4804a2a8a40f' .
'&ids=3,5);
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
$wynik = curl_exec($c);
curl_close($c);
$dane = json_decode($wynik,true); // wartości w postaci tablicy asocjacyjnej
if($dane['error']['code']>0) die($dane['error']['message']); //sprawdzamy czy wystąpił jakiś błąd,
//jeśli tak, wyświetlamy go
foreach($dane['result'] as $id=>$dane)
{
echo 'Id: ' . $id . ' Nip: ' . $dane['nip'] . ' Nazwa: ' . $dane['nazwa'] .
' Miejscowość: ' . $dane['miejscowosc'] . ' Ulica: ' . $dane['ulica'] .
' Kod: ' . $dane['kod'] . '
';
}