Vevői rendelés API

Az eVIR rendszer lehetőséget biztosít külső rendszer számára számla készítésére.

Az általános API leírásban szerepelnek az alapok, ezért itt már csak a specifikus részek szerepelnek.

A kommunikáció JSON alapkon zajlik, a követező módon:

https://evir.hu/cegnev/cgi-bin/index.cgi?json={"token":"jMuPFcKJdyKYqMZ7iGiLpxF/32k","dok":"api_rendeles_vevoi",...........}

a JSON adat egy hash, melynek kulcsai az alábbi jelentésekkel bírnak

API hívás paraméterei

• *1 Rendelés létrehozásakor hogyan készüljön bizonylat: bizonylat művelet
  • 0 Csak a bizonylatszámot adja oda
  • M1 A bizonylatot email-ben elküldi, és odaadja a bizonylatszámot
  • P1 P1M0 A bizonylatból PDF-et készít.
  • M1P2 P1M2 A bizonylatból PDF-et készít és a bizonylatot email-ben el is küldi

Partner adatai

A vevő partner adatai. partner adatok

• *1 Lehet új partner adatokat megadni vagy meglévő partnerrel dolgozni
  • Ha a partner már rögzítve van az eVIR-ben, akkor elegendő az azonosítóját, a partner_id-t megadni. Semmilyen más partner adatot nem kell megadni.
  • Ha új partnernek készül a rendelés, akkor a partner_id mezőt ki kell hagyni, és minden egyéb partner adatot megfelelően ki kell tölteni.

• M kötelezően Meg kell adni (mandatory)
• *1 Amennyiben az ország még nem szerepel az eVIR-ben, akkor kötelező megadni
• *2 Bontott cím esetén a közterület jellege mezőt ki kell tölteni, és minden egyéb cím adatot a megfelelő mezőben kell szerepeltetni.
• C Csak cég esetén adható meg

Szállítási cím

A szállítási címet NEM kötelező megadni. Ha megadja, akkor a szállítási cím adatait az alábbi módon kell megadni.

• M kötelezően Meg kell adni (mandatory)
• *1 Amennyiben az ország még nem szerepel az eVIR-ben, akkor kötelező megadni
• *2 Bontott cím esetén a közterület jellege mezőt ki kell tölteni, és minden egyéb cím adatot a megfelelő mezőben kell szerepeltetni.

Számlázásiási cím

A számlázási címet NEM kötelező megadni. Ha megadja, akkor a számlázási cím adatait az alábbi módon kell megadni.

• M kötelezően Meg kell adni (mandatory)
• *1 Amennyiben az ország még nem szerepel az eVIR-ben, akkor kötelező megadni
• *2 Bontott cím esetén a közterület jellege mezőt ki kell tölteni, és minden egyéb cím adatot a megfelelő mezőben kell szerepeltetni.

Rendelés általános paraméterei

Rendelés adatai

• *1 Az árkategória arkat és pénznem penznem mezők feldolgozásakor:
  • Ha az árkategória meg van adva, akkor abból számolja ki a pénznemet is
  • Ha az árkategória nincs megadva, akkor a pénznem alapján próbál egy árkategóriát meghatározni.

Rendelés tétel mezői

A következő mezők a tetel_mezok tömbön belül többszörösen is megadható hashek adatszerkezete

Részletes dokumentáció: tétel adatok

• M kötelezően Meg kell adni (mandatory)
• O Opcionális
• *1 tétel tipusa, További részletek: tétel adatok oldalon
  • termék: termék katalógusból (raktárkészlet foglalás nélkül)
  • raktár: termék raktárkészlet foglalással
  • szolgáltatás: szolgáltatás
  • vegosszegi_engedmeny: rendelés végösszegéből adandó engedmény egy összegben
  • raktar_cikktorzs: termék raktárkészlet foglalással a lehetőségek szerint
• *2 tetel_forrasraktar megadása termék és raktar_cikktorzs tételtipus esetén kötelező megadni. Egyébként nincs használatban.

A következő adatokat akkor kell megadni, ha a szolgáltatás cikkszám még nem szerepel a cikktörzsben. termék esetén nem használható

• *3 tetel_cikk_rogzites ha meg van adva, akkor az 'R' jelű rögzítendő mezőket ki kell tölteni
• R tetel_cikk_rogzites esetén megadandó adatok.

API hívás visszatérési értéke

Az api hívás paraméterétől, és a működés sikerességétől függően a visszatérési érték az alábbiak lehetnek.

API válaszok

• Sikeres PDF dokumentum
• JSON válaszüzenet
• Egyéb HTTP válaszüzenet

Példa JSON adatok

Minimális példa

Partner törzsadatból, bizonylatot nem nyomtatja, nem küldi email-ben

{
   "token":"...",
   "dok":"rendeles_api_felvesz",
   "muvelet":"0",
   "penznem":"HUF",
   "partner_id":"4",
   "tetel_mezok":[
      {
         "tetel_tipusa":"termék",
         "tetel_menny":"1",
         "tetel_netto":"1000",
         "tetel_cikkszam":"c1"
      }
   ]
}

Példa válaszüzenet JSON formátumban

[
   {
      "status":"OK",
      "rendelesszam":"RE2021000012",
      "message":[
         {
            "time":"2021.09.27 19:22:31.51",
            "message":"Rendelés rögzítve.",
            "level":"Info"
         },
         {
            "message":"status=OK",
            "level":"SysInfo",
            "time":"2021.09.27 19:22:31.58"
         },
         {
            "level":"SysInfo",
            "message":"rendelesszam=RE2021000012",
            "time":"2021.09.27 19:22:31.58"
         }
      ],
      "choice":{
         "back":{
            "session":{
               "proc":"back",
               "cid":"cZ9cvPgKHU",
               "lid":"zTsqM0LBHU",
               "sid":"QKYYSPhvHU"
            },
            "data":{}
         }
      },
      "framename":"main",
      "result":null
   }
]