Dokumentacja API
Lista metod
Testowanie wywołań


getInvoices
Metoda umożliwia pobranie wystawionych faktur z managera zamówień BaseLinker. Listę faktur można ograniczyć przy użyciu filtrów opisanych w parametrach metody. Maksymalnie zwracane jest 100 faktur jednocześnie.


Parametry wejściowe
invoice_idint(nieobowiązkowe) Identyfikator faktury. Uzupełnienie tego pola spowoduje pobranie informacji tylko o jednej konkretnej fakturze.
order_idint(nieobowiązkowe) Identyfikator zamówienia. Uzupełnienie tego pola spowoduje pobranie informacji tylko o fakturze powiązanej z tym zamówieniem (jeśli zamówienie ma utworzoną fakturę).
date_fromint(nieobowiązkowe) Data od której mają zostać pobrane faktury. Format unix time stamp.
id_fromint(nieobowiązkowe) Numer ID faktury od którego mają zostać pobrane kolejne faktury.



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
invoicesarrayTablica z informacjami o znalezionych fakturach. Każda faktura opisana jest polami wymienionymi poniżej.
invoice_idintIdentyfikator faktury
order_idintIdentyfikator zamówienia do którego wystawiona jest faktura
typevarchar(10)Rodzaj faktury. Występujące wartości:
normal - zwykła faktura
correcting - faktura korygująca
numbervarchar(30)Pełny numer faktury. Format zależny od ustawień konta. Zazwyczaj [lp]/[miesiąc]/[rok]
sub_idintNumer w miesiącu/roku - element numeru faktury
monthintMiesiąc - element numeru faktury (0 jeśli stosowana jest numeracja roczna)
yearintRok - element numeru faktury
postfixvarchar(1)Zarostek - element numeru faktury
date_addintData utworzenia faktury (format unix time)
date_sellintData sprzedaży (format unix time)
date_pay_tointTermin płatności (format unix time). Domyślnie nieuzupełnione (wartość 0)
currencychar(3)Waluta (np. PLN, EUR)
total_price_bruttofloatŁączna wartość faktury brutto
total_price_nettofloatŁączna wartość faktury netto
paymentvarchar(30)Nazwa sposobu płatności
additional_infovarchar(250)Dodatkowe informacje/uwagi na fakturze
invoice_fullnamevarchar(100)Dane płatnika - imię i nazwisko
invoice_companyvarchar(100)Dane płatnika - firma
invoice_nipvarchar(100)Dane płatnika - NIP
invoice_addressvarchar(100)Dane płatnika - ulica i numer domu
invoice_postcodevarchar(100)Dane płatnika - kod pocztowy
invoice_cityvarchar(100)Dane płatnika - miasto
invoice_countryvarchar(20)Dane płatnika - kraj
invoice_country_codechar(2)Dane płatnika - kod kraju (dwuliterowy, np PL)
sellervarchar(250)Dane sprzedawcy (wszystkie w jednym polu)
correcting_to_invoice_idintTylko w przypadku faktury korygującej. Identyfikator faktury która jest korygowana.
correcting_reasonvarchar(100)Tylko w przypadku faktury korygującej. Powód korekty faktury.
correcting_itemsboolTylko w przypadku faktury korygującej. Flaga informująca o tym czy korekta zmienia pozycje faktury.
correcting_databoolTylko w przypadku faktury korygującej. Flaga informująca o tym czy korekta zmienia dane nabywcy.
exchange_currencychar(3)Tylko w przypadku przewalutowanych faktur. Waluta na którą dodatkowo przeliczona została wartośc faktury.
exchange_ratedecimal(10,4)Tylko w przypadku przewalutowanych faktur. Kurs waluty (przeliczenie z waluty z pola "currency" na walutę z pola "exchange_currency".
exchange_datevarchar(10)Tylko w przypadku przewalutowanych faktur. Data kursu waluty.
exchange_infovarchar(10)Tylko w przypadku przewalutowanych faktur. Informacja o źródle kursu (numer tabeli NBP).
itemsarrayTablica zawierająca pozycje faktury. 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
price_netto (float) - cena netto 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: