Dokumentacja APIgetNewReceipts
Metoda umożliwia pobranie paragonów oczekujących na wystawienie. Metoda ta powinna być wykorzystywana przy tworzeniu integracji z drukarką fiskalną. Co np. 10 sekund metodę odpytywać można o nowe paragony. Jeśli jakieś paragony pojawią się w odpowiedzi, po wydrukowaniu należy potwierdzić je metodą setOrderReceipt, aby zniknęły z listy oczekujących.
Parametry wejściowe
Dane wyjściowe:
Przykładowe wywołanie w php:
| series_id | int | (nieobowiązkowe) ID serii numeracji umożliwia filtrowanie po serii numeracji paragonu. Stosowanie wielu serii numeracji dla paragonów jest zalecane, kiedy użytkowik posiada wiele drukarek fiskalnych. Dla każdej drukarki fiskalnej powinien ustawić oddzielną serię. |
Dane wyjściowe
Metoda zwraca dane w formacie JSON.
| status | varchar(30) | SUCCESS - poprawnie wykonano zapytanie ERROR - wystąpił bład podczas zapytania API. Szczegóły błedu opisane będą w 2 dodatkowych zwracanych polach: error_message i error_code |
| orders | array | Tablica z informacjami o znalezionych paragonach. Każde zamówienie opisane jest polami wymienionymi poniżej. |
| receipt_id | int | ID paragonu, wykorzystywane w metodzie setOrderReceipt do zwrotnego oznaczenia paragonu jako wydrukowany |
| series_id | int | Identyfikator serii numeracji paragonu |
| receipt_full_nr | varchar(30) | Numer nadany przez BaseLinkera podczas tworzenia paragonu. Przykład numeru: "123/10/2018/P". Format zależy jest od ustawień - numeracja może być miesięczna, roczna lub ciągła (wtedy numerem jest kolejna liczba). Numer może zostać pominięty, drukarka fiskalna może wygenerować własny numer paragonu i zapisać go w metodzie setOrderReceipt. |
| order_id | int | Identyfikator zamówienia z managera zamówień BaseLinker |
| date_add | int | Data utworzenia zamówienia (format unix time) |
| payment_method | varchar(30) | Nazwa rodzaju płatności |
| nip | varchar(30) | Dane płatnika - NIP. Może zawierać znaki specjalne: litery (prefiks), myślniki i spacje. Należy samodzielnie oczyścić NIP z tych znaków wg uznania. |
| products | array | Tablica zawierająca produktu zamówienia. Każdy element tablicy to również tablica, zawierająca pola: name (varchar) - nazwa produktu price_brutto (float) - cena brutto pojedynczej sztuki tax_rate (int) - stawka VAT quantity (int) - ilość sztuk sku (varchar) - numer SKU produktu ean (varchar) - numer EAN produktu |
Przykład
Dane wejściowe:Dane wyjściowe:
Przykładowe wywołanie w php: