- Pobieranie danych faktury
- Wystawianie faktury
- Pobieranie faktury w pdf
- Wysłanie faktury do klienta e-mailem
- Usuwanie faktury
- Wysyłanie faktury do KSeF
- Pobranie nadanego numeru KSeF
- Pobieranie listy działów
- Lista dokumentów
- Pobieranie listy magazynów
- Pobieranie listy produktów
- Pobieranie ilości produktów w magazynie
- Pobieranie listy klientów
- Zmiana statusu dokumentu
- Dodawanie tagów
- Usuwanie tagów
- Zwracane kody
- Słowniki
API
API token:
1. Pobieranie danych faktury:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne odczytanie dokumentu: |
2. Wystawianie faktury:
Prosimy w XML używać kodowania znaków w formacie utf-8
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne dodanie dokumentu:Dla dokumentów typu marża prosimy o podanie dodatkowo:
Dla dokumentów typu: Faktura VAT Faktura korekta Faktura marża Faktura bez vat (rachunek) - tylko koszty Faktura zaliczkowa Paragon PZ - Przyjęcie Zewnętrzne PW - Przyjęcie Wewnętrzne Faktura WDT Eksport Towarów Eksport Usług Eksport Usług VAT-UE 28b Import usług VAT-UE 28b W sekcji <dokument> można dodać pole data_wplywu:
Dla dokumentów przychodowych typu: Faktura VAT Faktura marża Faktura bez vat (rachunek) Faktura zaliczkowa Jeżeli została dodana integracja z przelewy24 lub PayU to w sekcji <dokument> można dodać pole platnosci_elektroniczne dzięki temu na dokumencie zostanie zaznaczona opcja "Pokaż płatności elektroniczne na fakturach"
W sekcji <dokument> można dodać pole rodzaj_faktury_koszty które określa rodzaj faktury: 1 - przychodowa ( wartość domyślna ) 2 - kosztowa
W sekcji <dokument> można dodać pole dokument_rel_id które daje możliwość dodania relacji z innymi dokumentami. Dla faktury końcowej, możliwość dodania relacji z dokumentami: - faktury zaliczkowe
|
Wystawianie faktury OSS:
Dla typu sprzedaży ( towar ):
Dla typu sprzedaży ( usługa ):
Prosimy w XML używać kodowania znaków w formacie utf-8
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne dodanie dokumentu: |
Wystawianie faktury korygującej
Prosimy w XML używać kodowania znaków w formacie utf-8
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne dodanie dokumentu:Przydatne informacje: - Sekcja <faktura_pozycje_bylo>...</faktura_pozycje_bylo> nie jest wymagana. W przypadku braku dane zostaną automatycznie pobrana z dokumentu korygowanego. - Sekcja <faktura_pozycje_powinno_byc>...</faktura_pozycje_powinno_byc> nie jest wymagana. W przypadku braku dane zostaną automatycznie pobrana z dokumentu korygowanego. - Sekcja <sprzedawca>...</sprzedawca> można podać wszystkie dane lub tylko te które zostały zaktualizowane. - Sekcja <nabywca>...</nabywca> można podać wszystkie dane lub tylko te które zostały zaktualizowane. - Sekcja <odbiorca>...</odbiorca> można podać wszystkie dane lub tylko te które zostały zaktualizowane. * w powyższym przykładzie dla testu zostały podane wszystkie możliwe informacje w sekcjach: sprzedawca, nabywca, odbiorca, faktura_pozycje_bylo, faktura_pozycje_powinno_byc * pozycje <faktura_pozycje_bylo> oraz <faktura_pozycje_powinno_byc> będą wstawiane w takiej samej kolejności w jakiej znajdują się w przesłanym pliku XML |
Wystawianie faktury korygującej do paragonu
Prosimy w XML używać kodowania znaków w formacie utf-8
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne dodanie dokumentu:Przydatne informacje: - Sekcja <faktura_pozycje_bylo>...</faktura_pozycje_bylo> nie jest wymagana. W przypadku braku dane zostaną automatycznie pobrana z dokumentu korygowanego. - Sekcja <faktura_pozycje_powinno_byc>...</faktura_pozycje_powinno_byc> nie jest wymagana. W przypadku braku dane zostaną automatycznie pobrana z dokumentu korygowanego. - Sekcja <sprzedawca>...</sprzedawca> można podać wszystkie dane lub tylko te które zostały zaktualizowane. - Sekcja <nabywca>...</nabywca> można podać wszystkie dane lub tylko te które zostały zaktualizowane. - Sekcja <odbiorca>...</odbiorca> można podać wszystkie dane lub tylko te które zostały zaktualizowane. * w powyższym przykładzie dla testu zostały podane wszystkie możliwe informacje w sekcjach: sprzedawca, nabywca, odbiorca, faktura_pozycje_bylo, faktura_pozycje_powinno_byc * pozycje <faktura_pozycje_bylo> oraz <faktura_pozycje_powinno_byc> będą wstawiane w takiej samej kolejności w jakiej znajdują się w przesłanym pliku XML |
3. Pobieranie faktury w PDF:
Pobieranie pliku PDF:
Przykładowe dane które zwraca API:
Błędne pobranie:
Otwieranie pliku PDF
Przykładowe dane które zwraca API:
Błędne otwarcie:
|
4. Wysłanie faktury do klienta e-mailem:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawnie wysłany e-mail: |
5. Usuwanie faktury:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne usunięty dokument: |
6. Wysyłanie faktury do KSeF:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne wysyłanie faktury do KSeF: |
7. Pobranie nadanego numeru KSeF:
Czas na nadanie numeru KSeF przez Krajowy System e-Faktur po wysłaniu dokumentu ( w punkcie 7 ) to przeważnie od 0.5 do 3 sekund
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne nadanie numeru KSeF: |
8. Pobieranie listy działów:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne odczytanie listy działów |
9. Lista dokumentów:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne odczytanie listy dokumentów
|
10. Pobieranie listy magazynów:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne odczytanie listy magazynów: |
11. Pobieranie listy produktów:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne odczytanie listy produktów: |
12. Pobieranie ilości produktów w magazynie:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne odczytanie listy produktów: |
13. Pobieranie listy klientów:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne odczytanie listy klientów: |
14. Zmiana statusu dokumentu:
Istnieją trzy sposoby zmiany statusu dokumentu: 1. Poprzez dodanie pojedynczej wpłaty lub wpłat: $input_xml = "Przykładowe dane, które zwraca API: Poprawna zmiana statusu: |
15. Dodawanie tagów:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne dodanie tagów:
|
16. Usuwanie tagów:
$input_xml = "
Przykładowe dane, które zwraca API:
Poprawne usunięcie tagów:
|
Zwracane kody:
1 - Dokument został poprawnie dodany |
typ_faktury - typy dokumentów:
0 - Faktura VAT |
typ_faktur_podtyp - podtyp dokumentu używany w paragonach:
0 - Niefiskalny |
obliczaj_sume_wartosci_faktury_wg - parametr używany w paragonach:
0 - sumy netto, vat i brutto pozycji (domyślnie) |
rodzaj_platnosci:
Przelew |
Rodzaj dokumentu ( rodzaj_faktury_koszty ) parametr opcjonalny:
1 - przychody ( domyślna ) 2 - koszty |
status:
0 - Nieopłacona |
jezyk:
1 - Angielski |
Szablon wydruku ( szablon ):
0 - Podstawowy 1 - Prosty 2 - Ekonomiczny |
automatyczne_tworzenie_dokumentu_magazynowego
Do dodawanej faktury zostanie automatycznie wystawiony dokument magazynowy WZ lub PZw zależności od tego, czy wystawiana faktura była fakturą kosztową czy przychodową.
W celu aktywowania tej opcji konieczne jest również podanie parametru magazyn_id:
0 - nie wystawiaj 1 - wystawiaj |
waluta:
PLN |
id_dzialy_firmy:
21 - Główny |
symbol_gtu:
1 - GTU_01 |
firma_lub_osoba_prywatna:
0 - Firma 1 - Osoba prywatna |
obliczaj_wartosc_faktury_od:
0 - Ceny jednostkowej netto (domyślna) 1 - Ceny jednostkowej brutto - zgodne z kasą fiskalną |
oss_dowod_potwierdzajacy_1:
1 - Adres IP |
oss_dowod_potwierdzajacy_2:
1 - Adres IP |
oss_typ_sprzedazy:
0 - Usługi |
wybrany_typ_dokumentu - pokaż wybrany typy dokumentów:
0 - Faktura VAT |
typ_marzy:
1 - Procedura marży dla biur podróży |
Jak często można odpytać API:
1. POBIERANIE DANYCH FAKTURY: co 1 sekundę 2. WYSTAWIANIE FAKTURY: co 1 sekundę 5. WYSŁANIE FAKTURY DO KLIENTA E-MAILEM: co 1 sekundę 6. USUWANIE FAKTURY: co 1 sekundę 7. POBIERANIE LISTY DZIAŁÓW: co 1 sekundę 8. LISTA DOKUMENTÓW: co 5 sekund 9. POBIERANIE LISTY MAGAZYNÓW: co 1 sekundę 10. POBIERANIE LISTY PRODUKTÓW: co 60 sekund 11. POBIERANIE ILOŚCI PRODUKTÓW W MAGAZYNIE: co 60 sekund 12. ZMIANA STATUSU DOKUMENTU: co 1 sekund |