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
Dane wyjściowe:
Przykładowe wywołanie w php:
| invoice_id | int | (nieobowiązkowe) Identyfikator faktury. Uzupełnienie tego pola spowoduje pobranie informacji tylko o jednej konkretnej fakturze. |
| order_id | int | (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_from | int | (nieobowiązkowe) Data od której mają zostać pobrane faktury. Format unix time stamp. |
| id_from | int | (nieobowiązkowe) Numer ID faktury od którego mają zostać pobrane kolejne faktury. |
| series_id | int | (nieobowiązkowe) ID serii numeracji umożliwia filtrowanie po serii numeracji faktury. |
| get_external_invoices | bool | (nieobowiązkowe, domyślnie true) Pobieraj także zewnętrzne faktury. |
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 |
| invoices | array | Tablica z informacjami o znalezionych fakturach. Każda faktura opisana jest polami wymienionymi poniżej. |
| invoice_id | int | Identyfikator faktury |
| order_id | int | Identyfikator zamówienia do którego wystawiona jest faktura |
| series_id | int | Identyfikator serii numeracji faktury |
| type | varchar(10) | Rodzaj faktury. Występujące wartości: normal - zwykła faktura correcting - faktura korygująca |
| number | varchar(30) | Pełny numer faktury. Format zależny od ustawień konta. Zazwyczaj [lp]/[miesiąc]/[rok] |
| sub_id | int | Numer w miesiącu/roku - element numeru faktury |
| month | int | Miesiąc - element numeru faktury (0 jeśli stosowana jest numeracja roczna) |
| year | int | Rok - element numeru faktury |
| postfix | varchar(1) | Zarostek - element numeru faktury |
| date_add | int | Data utworzenia faktury (format unix time) |
| date_sell | int | Data sprzedaży (format unix time) |
| date_pay_to | int | Termin płatności (format unix time). Domyślnie nieuzupełnione (wartość 0) |
| currency | char(3) | Waluta (np. PLN, EUR) |
| total_price_brutto | float | Łączna wartość faktury brutto |
| total_price_netto | float | Łączna wartość faktury netto |
| payment | varchar(30) | Nazwa sposobu płatności |
| additional_info | varchar(250) | Dodatkowe informacje/uwagi na fakturze |
| invoice_fullname | varchar(100) | Dane płatnika - imię i nazwisko |
| invoice_company | varchar(100) | Dane płatnika - firma |
| invoice_nip | varchar(100) | Dane płatnika - NIP |
| invoice_address | varchar(100) | Dane płatnika - ulica i numer domu |
| invoice_postcode | varchar(100) | Dane płatnika - kod pocztowy |
| invoice_city | varchar(100) | Dane płatnika - miasto |
| invoice_country | varchar(20) | Dane płatnika - kraj |
| invoice_country_code | char(2) | Dane płatnika - kod kraju (dwuliterowy, np PL) |
| seller | varchar(250) | Dane sprzedawcy (wszystkie w jednym polu) |
| correcting_to_invoice_id | int | Tylko w przypadku faktury korygującej. Identyfikator faktury która jest korygowana. |
| correcting_reason | varchar(100) | Tylko w przypadku faktury korygującej. Powód korekty faktury. |
| correcting_items | bool | Tylko w przypadku faktury korygującej. Flaga informująca o tym czy korekta zmienia pozycje faktury. |
| correcting_data | bool | Tylko w przypadku faktury korygującej. Flaga informująca o tym czy korekta zmienia dane nabywcy. |
| external_invoice_number | varchar(30) | Numer faktury z zewnętrznego systemu |
| exchange_currency | char(3) | Tylko w przypadku przewalutowanych faktur. Waluta na którą dodatkowo przeliczona została wartośc faktury. |
| exchange_rate | decimal(10,4) | Tylko w przypadku przewalutowanych faktur. Kurs waluty (przeliczenie z waluty z pola "currency" na walutę z pola "exchange_currency". |
| exchange_date | varchar(10) | Tylko w przypadku przewalutowanych faktur. Data kursu waluty. |
| exchange_info | varchar(10) | Tylko w przypadku przewalutowanych faktur. Informacja o źródle kursu (numer tabeli NBP). |
| external_id | int(11) | Indetyfikator faktury w zewnętrznym systemie księgowym. |
| items | array | Tablica 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:
Dokumentacja API