Adres API
| Środowisko | Adres URL | Metoda |
|---|---|---|
| Produkcyjne | https://app.nextbuy24.com/api/pr/ | POST |
| Demo | https://demo.nextbuy24.com/api/pr | POST |
Zakres danych
Przesyłane żądanie w formacie json przez API Rest musi posiadać poniższą strukturę danych
NAZWA POLA | NAZWA POLA W APLIKACJI | TYP POLA | WYMAGANE | OPIS |
|---|---|---|---|---|
Nazwa zamówienia | requestName | varchar(300) | TAK | |
Numer zamówienia | ordernumber | varchar(30) | NIE | Kolejny numer zamówienia. |
| Kod zamówienia | id | bigint | TAK | |
Status | orderstatus | varchar(50) | TAK | Dostępne statusy: w przygotowaniu, w trakcie zatwierdzania, zatwierdzone, odrzucone, wysłane do dostawcy, zrealizowane, anulowane, w realizacji |
Szablon | ordertemplate_id | bigint | TAK | Pole wyboru ze słownika szablonów zamówień |
Wysyłający zamówienie | sendingoperator_id | bigint | NIE | Osoba tworząca zamówienie |
Przypisany kupiec | assignedbuyer_id | bigint | NIE | Pozwala przypisać kupca do danego zamówienia. Dana osoba zostanie poinformowana o zaakceptowaniu zamówienia. |
Dostawca | supplier_id | bigint | TAK | Pole wymagane. Pozwala wybrać dostawcę z bazy firm. |
NIP dostawcy | suppliervatid | varchar(20) | NIE | Pole uzupełnia się po wyborze dostawcy. |
Incoterm | incoterm_code | varchar(3) | NIE | Pozwala na wskazanie warunków dostawy z listy rozwijanej. |
Umowa | agreement_id | bigint | NIE | Pozwala powiązać umowę do zamówienia. Dzięki temu istnieje możliwość śledzenia poziomu wykorzystania umowy. |
Osoba kontaktowa | contactperson_id | bigint | NIE | Pozwala wybrać osobę do kontaktu w sprawie zamówienia. Osobę można przypisać na strukturze organizacyjnej. |
Termin dostawy | supplydate | date | NIE | Pole uzupełniane ręcznie. Możliwość wskazania daty za pomocą opcji kalendarza. Z polem powiązana jest notyfikacja informująca osobę wysyłającą zamówienie o zbliżającej się dostawie. Notyfikacja wysyłana 24 h przed datą dostawy. |
Rzeczywisty czas dostawy | actualsupplydate | date | NIE | Pole uzupełniane ręcznie. Możliwość wskazania daty za pomocą opcji kalendarza. 2 dni przed terminem „rzeczywistej daty dostawy” kolor daty rzeczywistej dostawy w tabeli z zamówieniami zmieni się na „pomarańczowy”. Dzień po terminie „rzeczywistej daty dostawy” kolor zmieni się na czerwony. |
Warunki dostawy | supplyterms | varchar(300) | NIE | Pole uzupełniana ręcznie. Pozwala wskazać dodatkowe warunki dostawy. |
Waluta | company_id | bigint | TAK | Możliwość wyboru z listy: PLN, USD, GBP, EUR, CHF. |
Warunki płatności | paymentterms | varchar(300) | NIE | Pole uzupełniane ręcznie. Pozwala wskazać dodatkowe warunki płatności. |
Metoda płatności (prawa strona) | paymentmethod_name | varchar(40) | NIE | Pozwala wybrać rodzaj płatności z listy rozwijanej. |
Data wysłania (prawa strona) | sendingtosupplierfirstdate | timestamp | NIE | Pole uzupełniane automatycznie po wysłaniu zamówienia do dostawcy. |
Pokaż ceny (prawa strona) | showprices | boolean | NIE | Pozwala wybrać czy ceny będą widoczne na dokumencie pdf, który zostanie wysłany do Dostawcy. |
Kategorie zakupowe | buyer_category_id | bigint | TAK | Konieczność przekazania kodu kategorii |
Jednostka organizacyjna | company_organisation_unit_id | bigint | TAK | Możliwość wskazania jednostki organizacyjnej w imieniu, której tworzone jest zamówienie. |
| Adres dostawy | ||||
Nazwa firmy | supplyaddress_companyname | varchar(512) | NIE | Automatycznie przypisywany jest adres dostawy podany w jednostkach organizacyjnych. Można dodać inny/wybrać z listy dostępnych adresów. |
| Kraj | supplyaddress_country_id | bigint | TAK | |
| Numer budynku | supplyaddress_number | varchar(20) | TAK | |
| Numer mieszkania | supplyaddress_officenumber | varchar(20) | NIE | |
| Miejscowość | supplyaddress_place | varchar(512) | TAK | |
| Województwo | supplyaddress_province_id | bigint | NIE | |
| Ulica | supplyaddress_street | varchar(512) | TAK | |
| Kod pocztowy | supplyaddress_zipcode | varchar(30) | TAK | |
| Adres faktury | ||||
Nazwa firmy | invoiceaddress_companyname | varchar(512) | NIE | Automatycznie przypisywany jest adres faktury podany w jednostkach organizacyjnych. Można wskazać inny/wybrać z listy dostępnych adresów. |
| Kraj | invoiceaddress_country_id | bigint | NIE | |
| Numer budynku | invoiceaddress_number | varchar(20) | NIE | |
| Numer mieszkania | invoiceaddress_officenumber | varchar(20) | NIE | |
| Miejscowość | invoiceaddress_place | varchar(512) | NIE | |
| Województwo | invoiceaddress_province_id | bigint | NIE | |
| Ulica | invoiceaddress_street | varchar(512) | NIE | |
| Kod pocztowy | invoiceaddress_zipcode | varchar(30) | NIE | |
| Przedmiot zamówienia | ||||
Możliwość uszczegółowienia przedmiotu zamówienia. W tabeli istnieje możliwość wprowadzenia danych: Indeks Kupca, Indeks Dostawcy, Nazwa, Ilość, Jednostka miary, Cena netto, VAT, Wartość netto, Adres dostawy, Komentarz, Kategorie Zakupowe, Temat oraz Dodatkowe. | ||||
TABELA Z POZYCJAMI | ||||
Liczba porządkowa | lp | Integer | TAK | Liczba porządkowa |
Indeks dostawcy | supplierIndex | Integer | NIE | Indeks produktu, z którego korzysta dostawca |
Indeks kupca | buyerIndex | String | NIE | Indeks produktu, z którego korzysta dostawca |
Nazwa | name | String | TAK | Nazwa produktu na linii |
Ilość | quantity | Double | TAK | Ilość produktu na linii |
Jednostka | measureunit_id | TAK | Słownik jednostek miar | |
Cena jednostkowa netto | netUnitPrice | Double | NIE | Liczba dziesiętna (2 miejsca po przecinku) |
Wartość netto | netValue | Double | NIE | Liczba walutowa (2 miejsca po przecinku) |
Stawka VAT | vatRate | NIE | Słownik stawek VAT. Pole nie wymagane. | |
Komentarz | comment | String | NIE | Informacja o adresie dostawy |
Kategorie zakupowe | shoppingCategory | TAK | ||
| Temat* | TAK | |||
TABELA ALOKACJI DLA POZYCJI | allocations | |||
Jednostka organizacyjna | organizationalUnit | TAK | Domyślnie uzupełniana jednostka zdefiniowana dla zapotrzebowania | |
Podział (ilość) | Double | TAK | Domyślnie pobierana wartość z pola ilość | |
Podział (%) | Integer | NIE | Domyślnie wartość 100% | |
Wartość | Double | NIE | Domyślnie pobierana wartość z pola wartość netto | |
uwagi | String | NIE |
| |
LISTA PÓL DODATKOWYCH | ||||
Uwagi | comments | String | NIE |
|
| Możliwość dodania załączników, które zostaną wysłane dostawcy razem z zamówieniem | |||
Kody błędówStatusu odpowiedzi
Nazwa statusu |
OK |
ERROR |
Kod Błędu | Nazwa | Opis |
101 | Nie wszystkie wymagane pola są uzupełnione. | Występuje kiedy pola wymagane nie zostały wysłane w żądaniu. |
102 | Uzupełnione pola są wypełnione nieprawidłowo. | Występuje kiedy dane słownikowe wysłane w żądaniu nie zgadzają się ze słownikiem. |
201 | Błąd autoryzacji | Występuje kiedy dane autoryzacyjne są nieprawidłowe. |
202 | Błąd podczas deserializacji json | Występuje kiedy w żądaniu występują nieprawidłowe dane. |
203 | Błąd json. Uszkodzenie całego pliku | Występuje kiedy całe żądanie jest nieprawidłowe błędy podczas transmisji danych. |
UWAGA
Jeżeli nie posiadasz danej funkcji, skontaktuj się z nami w celu uzyskania szczegółów.