getReceipt
(NOWA) Metoda umożliwia pobranie pojedynczego paragonu z managera zamówień BaseLinker. Do pobierania listy nowych paragonów (przy integracji drukarki fiskalnej), należy wykorzystać metodę getNewReceipts.
Parametry wejściowe
Dane wyjściowe:
Przykładowe wywołanie w php:
| receipt_id | int | Identyfikator paragonu. Niewymagane w przypadku podania order_id. |
| order_id | int | Identyfikator zamówienia. Niewymagane w przypadku podania receipt_id. |
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 |
| 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. |
| year | int | Rok - element numeru paragonu |
| month | int | Miesiąc - element numeru faktury (0 jeśli stosowana jest numeracja roczna) |
| sub_id | int | Numer w miesiącu/roku - element numeru paragonu |
| 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. |
| currency | char(3) | Waluta (np. PLN, EUR) |
| total_price_brutto | float | Łączna wartość paragonu brutto |
| external_receipt_number | varchar(30) | Numer paragonu z kasy fiskalnej lub z zewnętrznego systemu |
| exchange_currency | char(3) | Tylko w przypadku przewalutowanych paragonów. Waluta na którą dodatkowo przeliczona została wartośc paragonu. |
| exchange_rate | decimal(10,4) | Tylko w przypadku przewalutowanych paragonów. Kurs waluty (przeliczenie z waluty z pola "currency" na walutę z pola "exchange_currency". |
| exchange_date | varchar(10) | Tylko w przypadku przewalutowanych paragonów. Data kursu waluty. |
| exchange_info | varchar(10) | Tylko w przypadku przewalutowanych paragonów. Informacja o źródle kursu (numer tabeli NBP). |
| items | array | Tablica zawierająca pozycje paragonu. Każdy element tablicy to również tablica, zawierająca pola: name (varchar) - nazwa pozycji sku (varchar) - numer SKU produktu ean (varchar) - numer EAN produktu price_brutto (float) - cena brutto pojedynczej sztuki tax_rate (int) - stawka VAT quantity (int) - ilość sztuk |
Przykład
Dane wejściowe:Dane wyjściowe:
Przykładowe wywołanie w php:
Dokumentacja API