API - https://moj.minimax.si/SI/API/Home/ModuleDetails/Order
Vmesnik omogoča rokovanje z naročili.
Preko vmesnika so omogočene naslednje funkcionalnosti:
- Branje seznama in posameznih zapisov naročil
- Dodajanje in urejanje naročil
- Brisanje naročil
- Akcije na naročilih:
- izstavitev in preklic izstavitve
- zaključitev in preklic zaključitve
- razveljavitev in preklic razveljavitve
- kopiranje naročila v izdan račun
Order - podatki naročila
Order | |
Podatek | Opis |
ReceivedIssued | Podatek označuje ali je naročilo prejeto ali izdano. Obvezen podatek. Izbira iz:
|
Year | Leto naročila, samo za branje. |
Number | Številka naročila, samo za branje. |
Date | Datum naročila - obvezen podatek. |
DueDate | Rok. |
Customer | Stranka - obvezen podatek. Vnese se ID stranke – stranko izberemo iz šifranta strank, ki ga izpišemo s klicem metode GetCustomers. |
CustomerName | Naziv stranke. |
CustomerAddress | Naslov stranke. |
CustomerPostalCode | Poštna številka stranke. |
CustomerCity | Pošta stranke. |
CustomerCounty | Država stranke. Vnese se ID države – državo izberemo iz šifranta držav, ki ga izpišemo s klicem metode GetCountries. |
CustomerCountryName | Naziv države, ki ga vnesemo, če država stranke ni domača država. Ta naziv države se prikazuje na izpisih, kjer se tiska naslov stranke. |
| RecipientName | Naziv prejemnika |
| RecipientAddress | Naslov prejemnika |
| RecipientPostalCode | Poštna številka prejemnika |
| RecipientCity | Pošta prejemnika |
| RecipientCountry | Država prejemnika. Vnese se ID države – državo izberemo iz šifranta držav, ki ga izpišemo s klicem metode GetCountries. |
| RecipientCountryName | Naziv države, ki ga vnesemo, če država stranke ni domača država. |
Analytic | Analitika. Vnese se ID analitike – analitiko izberemo iz šifranta analitik, ki ga izpišemo s klicem metode GetAnalytics. |
Reference | Veza |
Currency | Denarna enota, obvezen podatek. Vnese se ID denarne enote - denarno enoto izberemo iz šifranta denarnih enot, ki ga izpišemo s klicem metode GetCurrencies. |
Notes | Opomba |
Document | Dokument Vnese se ID dokumenta – dokument izberemo iz šifranta dokumentov, ki ga izpišemo s klicem metode GetDocuments. |
DateConfirmed | Datum potrditve naročila. Podatek je samo za branje, spreminjati ga je mogoče preko akcij v PutCustomActionOrder (actionName: confirm). |
DateCompleted | Datum zaključitve naročila. Podatek je samo za branje, spreminjati ga je mogoče preko akcij v PutCustomActionOrder (actionName: complete) |
DateCanceled | Datum razveljavitve naročila. Podatek je samo za branje, spreminjati ga je mogoče preko akcij v PutCustomActionOrder (actionName: invalidate) |
Status | Status naročila, podatek je samo za branje.
|
DescriptionAbove | Besedilo, ki se bo tiskalo kot opis zgoraj na listini naročila, ki se pripravi. |
DescriptionBelow | Besedilo, ki se bo tiskalo kot opis spodaj na listini naročila, ki se pripravi. |
ReportTemplate | Nastavitev izpisa za tiskanje naročila. Vnese se ID nastavitve izpisa – nastavitev izpisa izberemo iz šifranta nastavitev izpisa, ki ga izpišemo s klicem metode GetReportTemplates. Za izdana naročila se izbere nastavitev izpisa, kjer je DisplayType = IN. Za prejeta naročila se izbere nastavitev izpisa, kjer je DisplayType = PN. |
OrderRows | Seznam vrstic naročila. |
OrderRow - podatki vrstic naročila
OrderRow | |
Podatek | Opis |
Item | Artikel, obvezen podatek. Vnese se ID artikla – artikel izberemo iz šifranta artiklov, ki ga izpišemo s klicem metode GetItems. |
ItemName | Naziv artikla, ki se bo izpisal pri tiskanju naročila. |
ItemCode | Šifra artikla, ki se bo izpisala pri tiskanju naročila. |
Description | Opis artikla, ki se bo izpisal pri artiklu pri tiskanju naročila. |
Quantity | Količina. |
Price | Cena. |
Primeri
Pri zgradbi objekta za pošiljanje si lahko pomagamo s testnimi podatki objekta, ki jih prikažemo s klikom na gumb Test API na pogledu posamezne metode.
Pomembno:
Med podatki v JSON zapisih v nadaljevanju so navedeni vzorčni ID-ji, ki jih je pred klicem potrebno zamenjati s pravilnimi ID-ji, ki pripadajo organizaciji in jih dobimo s klicem ustreznih metod.
Vzorčni podatki v primerih:
- Customer.ID = 111111
- Item.ID = 222222
- Currency.ID = 888888
Vnos novega prejetega naročila z minimalnim naborom podatkov
{
"ReceivedIssued": "P",
"Customer": {
"ID": 111111
},
"Currency": {
"ID": 888888
},
"OrderRows": [{
"Item": {
"ID": 222222
},
"Quantity": 1
}]
}
