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 | KOMENTARZ | |
|---|---|---|---|---|---|
Nazwa zapotrzebowania | requestname | varchar(300) | TAK |
| |
Szacunkowa wartość | estimatedVaulue | numeric(19,6) | TAK | Minimalna dopuszczalna wartość 0,01 | |
Waluta | currency | varchar(3) | TAK | Pole wyboru waluty ze słownika walut | |
Rodzaj zakupu | purchaseType | bigint | TAK | Pole wyboru typu zapotrzebowania ze słownika szablonów zapotrzebowań | |
Oczekiwana data dostawy | expecteddeliverydate | date | NIE | Pole Daty | |
Priorytet | prioritytype | varchar(20) | TAK | Pole wybory, możliwa wartość: normalny, wysoki, awaryjny | |
Adres dostawy (deliveryAddress) | deliveryAddress | NIE | Pole wyboru, wybór adresu dostawy z listy adresów zdefiniowanych dla jednostki organizacyjnej | ||
| deliveryAddress | Ulica | street | varchar(512) | NIE | |
| Nr domu | houseNumber | varchar(20) | NIE | ||
| Nr lokalu | apartmentNumber | varchar(20) | NIE | ||
| Kod pocztowy | code | varchar(30) | NIE | ||
| Miasto | city | varchar(512) | NIE | ||
| Kraj | country | NIE | |||
| Typ adresu | addresTypoe | NIE | |||
| Firma | company | NIE | |||
Data wysłania | requestsendingdate | timestamp | NIE | Data wysłania zapotrzebowania do akceptacji | |
Typ wartości | pricetype | varchar(10) | TAK | Pole wybory, możliwa wartość:: Netto lub Brutto | |
Zgłaszający | String | TAK | Adres e-mail użytkownika zgłaszającego zapotrzebowanie (posiadającego konto w systemie) | ||
Status | status | TAK | Możliwa wartość: w przygotowaniu, w trakcie zatwierdzania, zaakceptowane, odrzucony, zmodyfikowany, przetarg, zrealizowany, anulowany | ||
Przypisany kupiec | NIE | Słownik osób posiadających uprawnieni Kupca. Lista rozwijana – imię i nazwisko osoby | |||
Osoba kontaktowa | String | NIE | Słownik osób zdefiniowanych jako osoby kontaktowe. Lista rozwijana – imię i nazwisko osoby | ||
KOD | requestcode | varchar(30) | TAK | Kolejny numer zapotrzebowania | |
Budżet | budget | Boolean | TAK | Pole typu checkbox | |
Kategorie zakupowe | shoppingCategory | TAK | Słownik kategorii zakupowych. Konieczność przekazania kodu kategorii | ||
Jednostka organizacyjna | organizationalUnit | TAK | Słownik jednostek organizacyjnych. Konieczność przekazania kodu jednostki organizacyjnej | ||
Potencjalni dostawcy (provider) | Dane potencjalnych dostawcó | ||||
| Provider | NIP | nip | NIE | ||
| NIE | |||||
| Nazwa | name | NIE | |||
TABELA Z POZYCJAMI (itemList) | |||||
| itemList | Liczba porządkowa | lp | Integer | TAK | Liczba porządkowa |
Indeks dostawcy | supplierIndex | Integer | NIE | ||
Indeks kupca | buyerIndex | String | NIE |
| |
Nazwa | name | String | TAK |
| |
Ilość | quantity | Double | TAK |
| |
Jednostka | unit | Słownik | TAK | Możliwa wartość ze słownika 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 | Słownik | NIE | Możliwa wartość ze słownika stawek VAT. | |
Komentarz | comment | String | NIE | ||
Kategorie zakupowe | shoppingCategory | Słownik | TAK | Słownik kategorii zakupowych. Konieczność przekazania kodu kategorii | |
TABELA ALOKACJI DLA POZYCJI (allocations) | |||||
| allocations | Jednostka organizacyjna | organisationalUnit | bigint | 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 |
| |
Statusu odpowiedzi
Nazwa statusu |
OK |
ERROR |
Kody błędów
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. |