Dokumentacja API
Lista metod
Testowanie wywołań
Changelog


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
receipt_idintIdentyfikator paragonu. Niewymagane w przypadku podania order_id.
order_idintIdentyfikator zamówienia. Niewymagane w przypadku podania receipt_id.



Dane wyjściowe
Metoda zwraca dane w formacie JSON.
statusvarchar(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_idintID paragonu, wykorzystywane w metodzie setOrderReceipt do zwrotnego oznaczenia paragonu jako wydrukowany
series_idintIdentyfikator serii numeracji paragonu
receipt_full_nrvarchar(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.
yearintRok - element numeru paragonu
monthintMiesiąc - element numeru faktury (0 jeśli stosowana jest numeracja roczna)
sub_idintNumer w miesiącu/roku - element numeru paragonu
order_idintIdentyfikator zamówienia z managera zamówień BaseLinker
date_addintData utworzenia zamówienia (format unix time)
payment_methodvarchar(30)Nazwa rodzaju płatności
nipvarchar(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.
currencychar(3)Waluta (np. PLN, EUR)
total_price_bruttofloatŁączna wartość paragonu brutto
external_receipt_numbervarchar(30)Numer paragonu z kasy fiskalnej lub z zewnętrznego systemu
exchange_currencychar(3)Tylko w przypadku przewalutowanych paragonów. Waluta na którą dodatkowo przeliczona została wartośc paragonu.
exchange_ratedecimal(10,4)Tylko w przypadku przewalutowanych paragonów. Kurs waluty (przeliczenie z waluty z pola "currency" na walutę z pola "exchange_currency".
exchange_datevarchar(10)Tylko w przypadku przewalutowanych paragonów. Data kursu waluty.
exchange_infovarchar(10)Tylko w przypadku przewalutowanych paragonów. Informacja o źródle kursu (numer tabeli NBP).
itemsarrayTablica 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: