Interfejs API

Wstęp


Interfejs API umożliwia integrację zewnętrznych aplikacji z systemem fakturowania i księgowości Intaxo. Komunikacja odbywa się za pomocą formatu wymiany danych JSON więc wspierany jest przez większość obecnie stosowanych języków programowania w tym C, C++, C#, PHP, Java, JavaScript, Python, Ruby.

Ścieżka dostępu


Ścieżka dostępu do interfejsu API jest następująca:

https://intaxo.pl/api.json

Sposób użycia


Za każdym razem w celu wymiany danych z intaxo należy podać: dane autoryzacji (CURLOPT_USERPWD) oraz metodą POST (CURLOPT_POSTFIELDS) parametry typ zasobu r i dane w formacie JSON q. Najprostszym sposobem odwołania się do zasobów API intaxo.pl jest użycie biblioteki CURL (przykład w PHP).

Przykład:

$curl_ = curl_init();
curl_setopt($curl_, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($curl_, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl_, CURLOPT_USERPWD, "login:hasło");
curl_setopt($curl_, CURLOPT_URL, "https://intaxo.pl/api.json");
curl_setopt($curl_, CURLOPT_POSTFIELDS, "r=login&q={}");
curl_exec($curl_);
curl_close($curl_);

Wywołanie powyższych poleceń wyśle zapytanie o autoryzację do konta Intaxo i zwróci:

{"cid":nr, "uid":uu} jeśli autoryzacja będzie pozytywna
 nr to ID konta, zawsze >= 1, UU to ID użytkownika (subkonta) >= 0

{"error":1,"message":"authentication error"} w przypadku błędu autoryzacji

Zasoby


nazwaopisprzykładowe zapytania
loginsłuży tylko do sprawdzenia logowania{ }
dictionariessłowniki (stawki VAT, jednostki etc.){ "action":"list", "what":"taxrates" }
invoicesfaktury sprzedażowe i kosztowe{ "action":"list", "search":"Drutex s.c." }
itemspozycje wybranej faktury{ "action":"list", "did":32501 }
customerskontrahenci{ "action":"list", "search":"kowalski" }
productstowary/usługi{ "action":"list", "search":"drukarka" }
bookkeepingksięgowość{ "action":"list", "what":"zus" }
filesoperacje na plikach{ "action":"get", "id":301345 }
reportsraporty

Akcje


nazwaopiswyjaśnienie / przykłady
adddodanie faktury / kontrahenta / produktuID należy pominąć lub ustawić na 0
editedycja faktury / kontrahenta / produktuwymaga podania ID zasobu
zmienia tylko podane, zgodne z dokumentacją, wartości
listwyświetlanie faktur / kontrahentów / produktówwyniki wyszukiwania można zawęzić do konkretnego rekordu podając ID lub do właściwości (np. numer faktury, nazwa kontrahenta)
można użyć także atrybutu search aby wyszukać frazę/wartość jednocześnie w kilku atrybutach (w przypadku faktur wyszukiwanie odbywa się po atrybutach nagłówka i po pozycjach faktury)

Sortowanie, stronicowanie i ustawienie limitu


Dane zapytań listujących można sortować, stronicować i ograniczyć ich ilość.

Sortowanie stosuje za pomocą atrybutu sortby np.:

{ "action":"list", "sortby":"nazwa kolumny" }
W celu użycia stronicowania należy użyć atrybutów page i cpp np.:

{ "action":"list", "page":3, "cpp":10 }
Powyższe zapytanie listujące faktury zwróci zawartość trzeciej strony - wiersze 21-30 (o ile faktur jest minimum 30, jeśli nie lista może być krótsza lub pusta).

Aby ograniczyć ilość danych (wierszy) bez stronicowania można użyć atrybutu limit np.:

{ "action":"list", "limit":10 }

Kody błędów


W przypadku wystąpienia błędu serwer zwróci jeden z poniższych komunikatów:

{"error":1,"message":"authentication error"} - błąd autoryzacji
{"error":2,"message":"incorrect resource"} - błędnie podana nazwa zasobu
{"error":3,"message":"invalid JSON format"} - błędna składnia JSON
{"error":4,"message":"incorrect dictionary"} - błędnie podany słownik
{"error":5,"message":"incorrect action"} - nieznana akcja
{"error":6,"message":"incorrect ID"} - błędny ID
{"error":7,"message":"account is not activated"}

Faktury


Pola opisujące fakturę:

nazwaopiswyjaśnienie / przykłady
idID dokumentuliczba całkowita
0 - jeśli dodajemy nową fakturę, 1+ - przy edycji/selekcji faktur
langjęzykPL - polski
EN - angielski
DE - niemiecki
kidID faktury korygowanej, tylko dla faktur korygujących (+KOR)liczba całkowita
buyczy faktura kosztowa0 - dla faktur sprzedaży (domyślnie), 1 - faktura kosztowa
defczy faktura zdefiniowana0 - nie, 1 - tak, faktura zdefiniowana
placemiejsce wystawienia dokumentujeśli brak, używane jest miejsce wystawienia podane w konfiguracji programu
cdescopis kosztu
cost2typ kosztu+KF - koszt firmy (domyślnie)
+MD - media
+ZT - zakup towarów i usług
+PA - zakup paliwa
+PO - zakup pojazdu
+LE - leasing
+IN - inny koszt
car2
type2
titletytuł fakturyzapisany na stałe dla każdej faktury, może się zmienić dla nowo wystawianych faktur np. faktury wystawiane od 01.01.2014 mają tytuł "Faktura" a wystawione przed 2014 r. Faktura VAT.
c1idID (nabywca i płatnik)ID kontrahenta - można je otrzymać wykonując polecenie selekcji kontrahentów np. {"name":"%jan kowalski%", "icase":1}
c1namenazwa firmydane podawane tylko przy selekcji
c1streetulica, numer
c1codekod pocztowy
c1citymiasto
c1taxidNIP
c1tueidNIP UE
c1traidREGON
c1krsidKRS
c2idID (odbiorca)ID kontrahenta (j.w.)
c2namenazwa firmydane podawane tylko przy selekcji
c2streetulica, numer
c2codekod pocztowy
c2citymiasto
c2taxidNIP
c2tueidNIP UE
c2traidREGON
c2krsidKRS
mdatedata wystawieniaYYYY-MM-DD
sdatedata sprzedażyYYYY-MM-DD
sdchk
sdate2
tdatetermin zapłatyYYYY-MM-DD
pdatedata płatnościYYYY-MM-DD
currdtdata kursu walutyYYYY-MM-DD
bank_idID bankumożna je otrzymać wykonując polecenie selekcji rachunków np. {"action":"list", "what":"accounts"}
bank_namenazwa banku sprzedawcydostępne tylko w trybie listowania
bank_accountnumer rachunku
bank_swiftkod SWIFT banku
ptidID formy/terminu płatnościmożna je otrzymać poleceniem selekcji form i terminów płatności np. {"action":"list", "what":"paytypes"}
issuingwystawiający fakturę
receivingodbierający fakturę
paidzapłacono
vnettowartosć nettopodawany zawsze w walucie faktury
w celu uzyskania wartości w PLN należy wartość pomnożyć przez kurs waluty currval
vbruttowartość brutto
currencywalutanp. PLN (domyślnie), EUR, USD
currtabtabela NBPnp. 135/A/NBP/2014
currvalwartość kursunp. 4.1520
bruttoceny jednostkowe netto/brutto0 - netto (domyślnie)
1 - brutto
nrdocnumer faktury (drukowany)
nrxnumer kolejny dokumentupowinien być zgodny z numerem faktury np. dla 123/03/2014 powinien wynosić 123
noticesuwagi na fakturze
notices_privUwagi dla sprzedawcy (niedrukowane)
statusstatus faktury / kosztu0 - szkic
1 - wysłano
2 - wydrukowano
3 - zapłacono
4 - nie zapłacono
5 - anulowano
dwks
nupt
qucart
quofpcs
netweight
grossweight
container
delivery
accschID schematu księgowego
accpowID powodu opodatkowania
aufc
aufq
auem
aumsg
itemsdołączane są dodatkowo pozycje faktury

dostępne tylko w trybie listowania (action "list")

działa tylko dla wyniku zawężonego do ID faktury
0 - nie (domyślnie)
1 - tak
oprócz kolumn "c1", "c2"..."cN" (określonych w atrybucie "columns") do wierszy ("rows") dołączana jest tablica "items", zawierająca pozycje faktury

kolejność kolumn: id, kid, product, pkwiu, discount, unitid, unitsm, count, vatid, vatsm, vatname, vatrate, pnetto, pbrutto, vnetto, vbrutto, cartons, orgin, ub
wystawienia/edycja faktury
(action "add" lub "edit")
pozycje faktury/rachunku: zawierać może jedną lub więcej pozycji item - wartości pozycji opisane w kolejnej tabeli
befdla faktur korygujących zawęża wynik do pozycji korygujących (0) lub korygowanych (1)stosować gdy użyto "items"

nie jest atrybutem opisującym pozycje faktury - stosować tylko do listowania

Pola opisujące pozycje na fakturze/rachunku

nazwaopiswyjaśnienie / przykłady
idID pozycji fakturynie jest to numer l.p. widoczny na fakturach - nie mogą istnieć dwie pozycję o tym samym ID nawet jeśli dotyczą różnych faktur
didID dokumentu (faktury)do użycia tylko przy listowaniu pozycji (zasoby "items")
kidID pozycji korygowanejużywać tylko przy listowaniu
występuje tylko w fakturach korygujących
nigdy nie wskazuje pozycji z innej faktury
productnazwa towaru/usługi
cncode{io.page.api.invoices.items.cncode.desc}
discountrabatokreślany w procentach
unitidID jednostki (np. 1034)
unitsmsymbol jednostki (np. "szt.")
countilość
vatidID podatku VAT (np. 5){io.page.api.invoices.items.xxxx.ex}
vatsmsymbol podatku VAT (np. "23%")
vatnamenazwa podatku (np. "podstawowy 23%"){io.page.api.invoices.items.xxxx.ex}
pnettocena jednostkowa netto{io.page.api.invoices.items.xxxx.ex}
pbruttocena jednostkowa brutto
vnettowartość netto
vbruttowartość brutto
cartonsilość opakowańdotyczy tylko faktury eksportowej
orginpochodzeniej.w.
ubczy produkt uboczny, tylko dla kosztów typu +ZT1 - tak, 0 - nie
befdla faktur korygujących zawęża wynik do pozycji korygujących (0) lub korygowanych (1)nie jest atrybutem opisującym pozycje faktury - stosować tylko do listowania

Przykłady użycia:

Pobieranie danych o fakturach

{ "action":"list", "type2":"+FV", "mdate":"2014-10-01|2014-10-27" }
{ "action":"list", "type2":"+FV", "id":320450, "items":1 }
Wyświetlenie faktur kontrahenta oraz faktur z produktem (w obydwu przypadkach podajemy ID kontrahenta/produktu z katalogu)

{ "action":"list", "include_customer":123 }
{ "action":"list", "include_product":456 }
Dodawanie nowej faktury

{ "action":"add", "type2":"+FV", "nrdoc":"FV/15/10/2014", "nrx":15, "c1id":2063,
"items":[ {"product":"cos tam", "cncode":"72/20", "count":4, "unit":"szt.", "pnetto":100.00, "vatsm":"23%"} ] }

Dodawanie nowej faktury korygującej

{ "action":"add", "type2":"+KOR", "nrdoc":"KOR/7/10/2014", "nrx":7, "kid":6167, "c1id":2063,
"items":[ {"product":"cos tam", "cncode":"72/20", "count":4, "unit":"szt.", "pnetto":100.00, "vatsm":"23%", "before":{"product":"cos tam", "cncode":"72/20", "count":3, "unit":"szt.", "pnetto":100.00, "vatsm":"23%"} } ] }

Wartości domyślne dla nowej faktury

{ "action":"default", "type2":"+FV", "nrx":100, "mdate":"2015-03-25", "sdate":"2015-03-25", "currency":"EUR", "emt":52319 }

Przykładowa odpowiedź:{ "pvat":1, "nrdoc":"0100\/02\/2015", "nrx":100, "type2s":"+FV", "title2s":"Faktura", "type2c":"+FV", "title2c":"Faktura", "currency":"EUR", "currval":4.1783, "currtab":"030\/A\/NBP\/2015", "currdt":"2015-02-13", "unitid":39879, "taxid":2, "dtpid":50293 }


Zmiana statusu

{ "action":"status", "id":345, "value":0-5 }

Usunięcie faktury

{ "action":"delete", "id":345 }

Kontrahenci


Pola opisujące kontrahenta:

nazwaopiswyjaśnienie / przykłady
groupID grupy kontrahentów (opcjonalnie)
symbolsymbol / nazwa skrócona
namepełna nazwa firmy / imię i nazwisko
streetulica, numer
codekod pocztowy
citymiasto
countrykraj
regionwojewództwo
taxidNIP
tueidNIP EU
traidREGON
krsidKRS
bnamenazwa banku
baccountnumer rachunku
bswiftkod SWIFT
sphonetelefon
mphonetel. kom.
faxnrnumer faksu
websitestrona www
emailadres e-mail
dptypeID domyślnej formy płatności
c1
c2
typ kontrahentac1=1 - klient (domyślnie)
c2=1 - sprzedawca

Przykłady użycia:

Pobieranie kontrahentów

{ "action":"list", "name":"%kowalski%", "icase":1 }
Dodawanie kontrahenta

{ "action":"add", "symbol":"K1", "name":"Jan Kowalski", "street":"Korfantego 100", "code":"40-154", "city":"Katowice", "taxid":"645-123-45-67", "bname":"mBank", "baccount":"00 1111 2222 3333 4444 5555" }
Zmiana danych kontrahenta

{ "action":"edit", "id":99, "symbol":"K2", "name":"Jan Iksiński", "street":"Korfantego 101" }
Usunięcie kontrahenta

{ "action":"delete", "id":345 }

Produkty


Pola opisujące produkt:

nazwaopiswyjaśnienie / przykłady
typetyp produktu0 - towar
1 - usługa
groupgrupa towarów i usług
symbolsymbol / nazwa skrócona
namepełna nazwa produktu
descopis / specyfikacja produktu
cncode{io.page.api.products.fields.cncode.desc}
swwkod SWW
vatidID stawki VAT
vatsmsymbol stawki VAT
unitidID jednostki
unitsmsymbol jednostki
pnettocena netto
pbruttocena brutto
currencywaluta
noticesuwagi
websiteadres URL strony produktu

Przykłady użycia:

Pobieranie produktów

{ "action":"list", "name":"%laptop dell%", "icase":1 }
Dodawanie produktu

{ "action":"add", "type":0, "symbol":"Dell 3531", "name":"Laptop Dell Inspiron 3531", "desc":"Ekran 15.6'' HD, Intel Celeron N2830, 4GB RAM/500GB HDD, Bateria 6.25 h", "cncode":"26.20.11", "vatsm":"23%", "unitsm":"szt.", "brutto":1500.00 }
Zmiana danych produktu

{ "action":"edit", "id":99, "symbol":"D3531", "name":"Dell Inspiron 3531", "brutto":1249.00 }
Usunięcie produktu

{ "action":"delete", "id":345 }

Słowniki


Pobieranie danych słownikowych:

Stawki VAT

Pytanie: { "action":"list", "what":"taxrates" }
Odpowiedź: { "count":8,"rows":[
{ "c1":1,"c2":0,"c3":"Podatek VAT 23%","c4":"23%","c5":0.2300 },
{ "c1":2,"c2":0,"c3":"Podatek VAT 7%","c4":"7%","c5":0.0700 },
{ "c1":3,"c2":0,"c3":"Stawka VAT 5%","c4":"5%","c5":0.0500 },
{ "c1":4,"c2":0,"c3":"Podatek VAT 3%","c4":"3%","c5":0.0300 },
{ "c1":5,"c2":0,"c3":"Podatek VAT 0%","c4":"0%","c5":0.0000 },
{ "c1":6,"c2":0,"c3":"Zwolnienie z podatku VAT","c4":"zw","c5":0.0000 },
{ "c1":7,"c2":0,"c3":"Podatek eksportowy","c4":"ex","c5":0.0000 },
{ "c1":8,"c2":0,"c3":"Nie podlega","c4":"np","c5":0.0000 }
] }

Rachunki bankowe

Pytanie: { "action":"list", "what":"accounts" }
Odpowiedź: { "count":2,"rows":[
{ "c1":1,"c2":0,"c3":"mBank","c4":"00 1111 1111 1111 1111 1111","c5":"MBANK" },
{ "c1":2,"c2":0,"c3":"ING Bank Śląski","c4":"22 2222 2222 2222 2222","c5":"ING" } ] }

Pracownicy (wystawiający faktury)

Pytanie: { "action":"list", "what":"employees" }
Odpowiedź: { "count":2,"rows":[
{ "c1":1,"c2":0,"c3":"Jan","c4":"Kowalski" },
{ "c1":2,"c2":0,"c3":"Kazimierz","c4":"Iksiński" } ] }

Grupy kontrahentów

Pytanie: { "action":"list", "what":"groupcu" }
Odpowiedź: { "count":2,"rows":[
{ "c1":1,"c2":0,"c3":"Lokalni","c4":"klienci stali, z miasta i okolicy" },
{ "c1":2,"c2":0,"c3":"Zamiejscowi","c4":"klienci przejezdni" } ] }

Grupy produktów

Pytanie: { "action":"list", "what":"groupgs" }
Odpowiedź: { "count":2,"rows":[
{ "c1":1,"c2":0,"c3":"Komputery","c4":"komputery, monitory, urządzenia peryferyjne" },
{ "c1":2,"c2":0,"c3":"Sprzęt AGD","c4":"pralki, lodówki, inny sprzęt AGD" } ] }

Formy i terminy płatności

Pytanie: { "action":"list", "what":"paytypes" }
Odpowiedź: { "count":3,"rows":[
{ "c1":1,"c2":0,"c3":"Gotówka","c4":0,"c5":100,"c6":0,"c7":0 },
{ "c1":2,"c2":0,"c3":"Przelew 14 dni","c4":14,"c5":0,"c6":1,"c7":0 },
{ "c1":3,"c2":0,"c3":"Przelew 7 dni","c4":7,"c5":0,"c6":1,"c7":0 } ] }

Jednostki

Pytanie: { "action":"list", "what":"units" }
Odpowiedź: { "count":3,"rows":[
{ "c1":1,"c2":0,"c3":"Sztuka","c4":"szt.","c5": },
{ "c1":2,"c2":0,"c3":"Godzina","c4":"h","c5":#1 },
{ "c1":3,"c2":0,"c3":"Metr kw.","c4":"m2","c5":#2 } ] }

Kursy walut

Pytanie: { "action":"list", "what":"currencies", "columns":"date,curr_eur,curr_usd", "sortby":"date desc", "limit":3 }
Odpowiedź: {"count":3,"rows":[
{"c1":"2015-06-05","c2":4.16,"c3":3.6949},
{"c1":"2015-06-03","c2":4.1307,"c3":3.7108},
{"c1":"2015-06-02","c2":4.1374,"c3":3.7676}
]}

Księgowość


Pobieranie danych księgowych:

KPiR

nazwaopiswyjaśnienie / przykłady
ididentyfikator
ymmiesiąc w formacie YYYY/MM
yqkwartał w formacie YYYY/KK
inc_stdprzychody sprzedaż towarów i usług
inc_othprzychody pozostałe
inc_sumprzychody razem
cst_pbpzakupy towarów wg cen zakupu
cst_ubkoszty uboczne zakupu
cst_paykoszty wynagrodzenia
cst_othkoszty pozostałe
cst_sumwynagrodzenia + pozostałe
statusstatus
pola wyświetlane domyślne, jeśli nie sprecyzowanoid, ym, yq, inc_sum, cst_pbp, cst_ub, cst_sum, status
refresh0 - domyślnie
1 - przed wyświetleniem danych wymusza wygenerowanie KPiR

Pytanie: { "action":"list", "what":"kpir" }
Odpowiedź: {"count":12,"rows":[
{"c1":121,"c2":"2014/01","c3":"2014/01","c4":0.00,"c5":0.00,"c6":0.00,"c7":0.00,"c8":0},
{"c1":122,"c2":"2014/02","c3":"2014/01","c4":0.00,"c5":0.00,"c6":0.00,"c7":0.00,"c8":0},
{"c1":131,"c2":"2014/11","c3":"2014/04","c4":802.30,"c5":0.00,"c6":0.00,"c7":201.70,
"c8":0},
...
]}

Zmiana statusu: { "action":"status", "what":"kpir", "id":121, "value":0 lub 1 }

Rejestr VAT

nazwaopiswyjaśnienie / przykłady
ididentyfikator
ymmiesiąc w formacie YYYY/MM
yqkwartał w formacie YYYY/KK
svatsprzedaż VAT
snetsprzedaż netto
sgrssprzedaż brutto
cvatkoszty VAT
cnetkoszty netto
cgrskoszty brutto
sstatusstatus dla rejestru sprzedaży
cstatusstatus dla rejestru zakupów
pola wyświetlane domyślne, jeśli nie sprecyzowanoid,ym,yq,svat,snet,sgrs,cvat,cnet,cgrs
refresh0 - domyślnie
1 - przed wyświetleniem danych wymusza wygenerowanie rejestru VAT

Pytanie: { "action":"list", "what":"rvat" }
Odpowiedź: {"count":4,"rows":[
{"c1":352,"c2":"2014/01","c3":"2014/01","c4":0.00,"c5":0.00,"c6":0.00,"c7":0.00,"c8":0.00,
"c9":0.00},
{"c1":355,"c2":"2014/10","c3":"2014/04","c4":1840.55,"c5":8023.00,"c6":9863.55,"c7":461.36,
"c8":2017.00,"c9":2478.36},
...
]}

Zmiana statusu: { "action":"status", "what":"rvat", "id":352, "value":0 lub 1 }

Podatek dochodowy

nazwaopiswyjaśnienie / przykłady
ididentyfikator
ymmiesiąc w formacie YYYY/MM
yqkwartał w formacie YYYY/KK
periodokres0 - miesiąc
1 - kwartał
incprzychody za okresza miesiąc lub kwartał (zgodnie z atrybutem period)
inc2przychody narastającood początku roku
cstkoszty za okresanalogicznie jak dla inc i inc2
cst2koszty narastająco
sumrazem za okres
sum2razem narastająco
zussskładki na ubezpieczenie społecznenarastająco od początku roku
zuszskładki na ubezpieczenie zdrowotne
advsuma zaliczek
taxpodatek
topaydo zapłaty
statusstatus podatku
pdatedata płatnościYYYY-MM-DD
txnamenazwa urzędu skarbowego
txaccountrachunek US, na który należy przelać zaliczkę
pola wyświetlane domyślne, jeśli nie sprecyzowanoid,ym,yq,inc,cst,sum,adv,tax,topay
refresh0 - domyślnie
1 - przed wyświetleniem danych wymusza przeliczenie podatku dochodowego

Pytanie: { "action":"list", "what":"pit" }
Odpowiedź: {"count":12,"rows":[{"c1":25,"c2":"2014/01","c3":"2014/01",
"c4":0.00,"c5":0.00,"c6":0.00,"c7":0.00,"c8":0.00,"c9":0.00},
{"c1":26,"c2":"2014/02","c3":"2014/01","c4":0.00,"c5":0.00,"c6":0.00,
"c7":0.00,"c8":0.00,"c9":0.00},
{"c1":27,"c2":"2014/03","c3":"2014/01","c4":0.00,"c5":0.00,"c6":0.00,
"c7":0.00,"c8":0.00,"c9":0.00},
...
]}

Zmiana statusu: { "action":"status", "what":"pit", "id":25, "value":0 lub 2-4 }

Podatek VAT

nazwaopiswyjaśnienie / przykłady
ididentyfikator
ymmiesiąc w formacie YYYY/MM
yqkwartał w formacie YYYY/KK
periodokres0 - miesiąc
1 - kwartał
s_plsprzedaż towarów i usług w Polsce
s_sosprzedaż usług za granicę
s_uesprzedaż towarów do UE
s_exsprzedaż towarów poza UE
c_stzakup środków trwałych
c_otzakup towarów i usług pozostałych
sum_sVAT od sprzedaży
sum_cVAT od zakupów
to_paydo zapłaty
ex_paynadpłata
to_retdo zwrotu
statusstatus podatku VAT
pdatedata płatnościYYYY-MM-DD
txnamenazwa urzędu skarbowego
txaccountrachunek US, na który należy przelać podatek VAT
pola wyświetlane domyślne, jeśli nie sprecyzowanoid,ym,yq,s_pl,s_so,s_ue,s_ex,c_st,c_ot,sum_s,sum_c,to_pay,ex_pay,to_ret,status
refresh0 - domyślnie
1 - przed wyświetleniem danych wymusza przeliczenie podatku VAT

Pytanie: { "action":"list", "what":"vat" }

Zmiana statusu: { "action":"status", "what":"vat", "id":1, "value":0 lub 2-4 }

Składki ZUS

nazwaopiswyjaśnienie / przykłady
ididentyfikator
ymmiesiąc w formacie YYYY/MM
socubezpieczenie społeczne
hltubezpieczenie zdrowotne
fpfskładki na FP i FGŚP
sumsuma składek
statusstatus składek
pdatedata płatnościYYYY-MM-DD
zsaccountrachunek dla składek na ubezpieczenie społeczne
zhaccountrachunek dla składek na ubezpieczenie zdrowotne
zfaccountrachunek dla składek na Fundusz Pracy
pola wyświetlane domyślne, jeśli nie sprecyzowanoid,ym,soc,hlt,fpf,sum,status
refresh0 - domyślnie
1 - przed wyświetleniem danych wymusza przeliczenie składek

Pytanie: { "action":"list", "what":"zus" }

Zmiana statusu: { "action":"status", "what":"zus", "id":1, "value":0 lub 1 }

Poczta i skany


Poniżej opisane polecenia umożliwiają pobieranie faktur w formacie PDF i wysyłanie ich e-mailem oraz dołączanie zdjęć (skanów) i załączników.

Pola opisujące operacje na fakturach sprzedaży:


nazwaopiswyjaśnienie / przykłady
actionoperacjamożliwe operacje:
get - pobranie pliku
send - wysłanie pliku w załączniku
idID dokumentu
whattyp dokumentu0 - faktura (domyślnie)
emailemail adresatatylko dla operacji send

Przykłady użycia:

Pobranie faktury

{ "action":"get", "id":301345 }
Wysłanie faktury w załączniku

{ "action":"send", "id":301345, "email":"biuro@mojklient.pl", "subject":"tytuł wiadomości", "message":"to jest wiadomość" }

Pola opisujące operacje na skanach i załącznikach:


nazwaopiswyjaśnienie / przykłady
actionoperacjamożliwe operacje:
cost - załączenie zdjęcia (skanu) / załącznika
list - wyświetla listę skanów/załączników
idID dokumentu (opcjonalnie)skan zostanie dołączony do faktury kosztowej (jeśli podano ID) lub dodany luźnie
idatedata dołączenia skanuw formacie YYYY-MM-DD
fnamenazwa (tytuł) załącznika
ftypetyp plikunp. .jpg, .png, .pdf
filezawartość pliku kodowana w base64

Przykłady użycia:

Dołączenie skanu

{ "action":"cost", "id":301347, "fname":"FV/50/04/2015", "ftype":".jpg", "file":"/9j/4AAQSkZJRgABAQEASABIAAD/4TIraHR..." }
Lista skanów

{ "action":"list", "id":301345 }

{ "action":"list", "idate":"2015-03-01|2015-04-30", }

Raporty


W przygotowaniu