Ügyviteli rendszer

Módosítás összefoglaló #

Ezen rész áttekintést nyújt a dokumentumban történt változtatásokról.

Eljárások #

GetCustomer – Ügyfél adatok lekérése #

Azon ügyfelek adatait adja vissza, ahol a kapcsolattartónál be van pipálva a 1. honlap mező.

A rendszer csak azokat az ügyfeleket adja vissza és be van pipálva a Webshop szerződés mező.

Az eljárásnak három hívási módja van:

• Nincs paraméter megadva
• CustomerId van megadva
• Email van megadva

Nincs paraméter megadva #

Ilyenkor visszaadja az összes ügyfelet.

{
  "result": "ok",
  "customer": [
    {
      "id": "azonosító",
      "name": "név",
      "tax_number": "adószám",
      "direction": "irány",
      "currency": "pénznem",
      "payment_method": "fizetési mód",
      "post_payment": "Nem",
      "status": "ügyfél státusza",
      "discount_category": "kedvezmény kategória",
      "contacts": [
        {
          "name": "Terhes Sándor",
          "email": "gyarmatiterhes@gmail.com"
        }
      ]
    }
  ]
}

CustomerId van megadva #

Visszaadja az ügyfél egyéb adatait.

Ha nincs ilyen azonosítóval ügyfél, akkor hibát ad:

{
  "result": "error", 
  "message": "Az azonosító (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha talált ügyfelet, akkor az alábbi választ adja:

{
  "result": "ok", 
  "CustomerId": "azonosító",
  "contact": "felelős",
  "limit": "váráslási limit",
  "outstand": "tartozás",
  "overdue": "lejárt tartozás",
  "status": "státusz"
}

Email van megadva #

Kikeresi az ügyfelek kapcsolattartói közül az e-mail címet tartalmazókat (ugyanaz az email cím több ügyfélhez is kapcsolódhat).

Az ügyfélnek be kell pipálva lennie a Webshop szerződésnek.
A kapcsolattartónál be kell pipálni az 1. honlap mezőt

Ha nem talál megfelelő kapcsolattartót és ezen keresztül ügyfelet, akkor hibát ad:

{
  "result": "error", 
  "message": "Az e-mail cím (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha csak egyet talál, akkor az eredmény ugyanaz, mintha az ügyfél CustomerId-jével lett volna meghívva az eljárás.

Ha több ügyfél is tartozik a megadott e-mail címhez, akkor az alábbi választ adja:

{
  "result": "ok", 
  "customers": [
    {
      "id": "azonosító",
      "name": "név",
      "status": "státusz"
    }, ...
  ]
}

GetCustomer2 – Ügyfél adatok lekérése #

Azon ügyfelek adatait adja vissza, ahol a kapcsolattartónál be van pipálva a 2. honlap mező.

Ha nem talál megfelelő kapcsolattartót és ezen keresztül ügyfelet, akkor hibát ad:

{
  "result": "error", 
  "message": "Az e-mail cím (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Ha tartozik ügyfél a megadott e-mail címhez, akkor az alábbi választ adja:

{
  "result": "ok", 
  "customers": [
    {
      "id": "azonosító",
      "name": "név"
    } ...
  ]
} 

GetAddress – Ügyfél címek lekérése #

Visszaadja az ügyfél számlázási és szállítási címeit.

Ha megvan adva a CustomerId paraméter, akkor az adott ügyfél címeit adja vissza. Ha a timestamp paraméter van megadva, akkor az időpont után létrejött, módosult címeket adja vissza.

Válasz:

{
  "result": "ok", 
  "CustomerId": "azonosító",
  "Addresses": [
    {
      "id": "belső azon",
      "default": "alapértelmezett",
      "city": "település",
      "zipcode": "irányítószám",
      "country": "ország",
      "kozterulet": "közterület neve",
      "kozteruletjelleg": "közterület jellege",
      "hazszam": "házszám",
      "epulet": "épület",
      "lepcsohaz": "lépcsőház",
      "emelet": "emelet",
      "ajto": "ajtó",
      "street": "teljes cím",
      "email": "e-mail cím",
      "phone": "telefonszám",
      "recipment": "értesítendő személy",
      "billing": "true",
      "shipping": "true"
    }
  ]
} 

SetAddress – Ügyfél cím módosítása #

Meglévő címet lehet vele módosítani. Csak számlázási cím módosítható.

Ha olyan címet módosít, ami egyben számlázási cím is, akkor létre hoz egy új címet szállítási címként és vissza adja az új ID-t. Ha csak az email, phone és recipment paraméterek változnak, akkor nem csinál új címet  hozzá.

Amelyik paraméter hiányzik a hívásból, azt üríti a rendszer a címben.

Válasz:

{
  "result": "ok", 
  "newid": "új azonosító"
}

DeleteAddress – Ügyfél cím törlése #

Meglévő címet lehet vele törölni.

Nem tényleges törlés.
Az ügyfél cím pipálható paramétereit Hamis-ra (false) állítja.

Válasz:

{
  "result": "ok"
}

GetProduct – Termékek lekérése #

Visszaadja az összes olyan terméket, ahol be van pipálva az 1. Honlap mező.

Bemenő paraméter nincs.

Ha meg van adva kapcsolódó és ajánlott termék, akkor azokat is visszaadja a termékek alatt. Visszaadja továbbá a termék csoport besorolásait is. Ha használva van a honlap altábla, akkor az ott bepipált honlapokat is visszaadja egy tömbben (A honlap kódját adja vissza, ennek hiányában a nevét).

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "id": "cikkszám",
      "name": "megnevezés",
      "name2": "rövid név",
      "status": "státusz",
      "mainstatus": "termék státusz",
      "discount_category": "kedvezmény kategória",
      "promo_discount_category": "akciós kedvezmény kategória",
      "warranty": "garanica",
      "forbidpublicprice": "false",
      "onlyrequest": "true",
      "package1": "csomag méret",
      "package2": "karton méret",
      "website2": "true",
      "net1": "nettó súly",
      "gross1": "bruttó súly",
      "net2": "csomag nettó súly",
      "gross2": "csomag bruttó súly",
      "net3": "karton nettó súly",
      "gross3": "karton bruttó súly",
      "sizedcategory": "méret kategória",
      "forbidlistprice": "listaár tiltása a weboldalon",
      "description": "leírás",
      "recommended": [
        {
          "id": "cikkszám", 
          "priority": "prioritás", 
          ... 
        }
      ], 
      "related": [
        {
          "id": "cikkszám", 
          "priority": "prioritás", 
          ... 
        }
      ],
      "itemof": [
        {
          "id": "cikkszám", 
          "quantity": "mennyiség", 
          ... 
        }
      ],
      "group": [
        {
          "path": ["szint1", "szint2", ...], 

      "website": ["1", "2", ...]

    },...
  ]
} 

GetProduct2 – Termékek lekérése #

Visszaadja az összes olyan terméket, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetProduct eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetProduct3 – Termékek lekérése (készlet, ár) #

Visszaadja termékeket, a készletüket és az árukat.

Ha nincs megadva szűrés, akkor az összes termet, az összes raktár készletet és kedvezmény kategóriás árakat visszaadja.

A cikkszam, cikkszam2 és penznem mezőknél csak egyet lehet megadni.
A raktar és kategoria mezőket pontosvesszővel elválasztva kell megadni (példa raktárakra: ‘A-H;A-N;L’)

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "cikkszam": "KJH23456",
      "cikkszam2": "1",
      "pn": "HUF",
      "keszlet": {
        "A-H": 4
      },
      "arak": {
        "listaar": 56400,
        "telepítő": 39480,
        "viszonteladó": 35532,
        "VIP": 35532,
      },
    },...
  ]
}

GetPrice – Árak lekérése #

Visszaadja azon termékek árait, ahol be van pipálva az 1. Honlap mező.

Ha a lekérés típusa Full, akkor visszaadja az összes terméket a szűrésnek megfelelően.
Ha a típus Change, akkor csak azokat adja vissza, amelyeknek legalább az egyik értéke megváltozott az utolsó lekérés óta.

Ha Email és CustomerId paraméterek nélkül hívjuk meg, akkor a cégektől független listaárakat adja vissza.

{
  "result": "ok", 
  "type": "lekérdezés típusa",
  "products": [
    {
      "id": "C1",
      "price": "listaar",
      "installer": "telepítői százalék",
      "currency": "HUF",
      "action": [
        {
          "type": "price", 
          "end_date": "akció vége dátum", 
          "end_time": "akció vége idő", 
          "stock_sweeping": "Igen", 
          "price": "akciós ár", 
          "currency": "HUF"            
        }, ...
      ], 
      "discount: [
        {
          "quantity: "mennyiség, 
          "price: "ár"
        }, ...
      ]
    }, ...
  ]
} 

*** Az akció típusától függ, hogy kötelező-e.

Ha az Email paraméter meg van adva, akkor az ION kikeresi a kapcsolattartók között az e-mail címet és társítja egy céghez.

Ha egyetlen céghez sem tartozik az e-mail cím, akkor hibát ad:
A e-mail cím (…) nem tartozik egyetlen aktív vevőhöz sem!

Ha több céghez is hozzá van rendelve az e-mail cím, akkor visszaadja a választható cégeket.

{
  "result": "ok", 
  "customers": [
    {
      "id": "U1",
      "name": "Cég1",
      "notpricelisteligible": "True"
    },
    {
      "id": "U2",
      "name": "Cég2",
      "notpricelisteligible": "False"
    },
    ...
  ]
} 

Ilyenkor újra meg kell hívni az eljárást, de már a kiválasztott cég azonosítójával (az e­mail címet nem kell megadni).

Visszaadja a cég azonosítóját és nevét és minden aktív illetve kifutó termékhez vissza adja az ügyfélhez tartozó árat.

{
  "result": "ok", 
  "type": "lekérdezés típusa", 
  "customers": 
    {
      "id": "U1",
      "name": "Cég1",
      "notpricelisteligible": "True"
    },
  "products":[termékek]
} 

GetPrice2 – Árak lekérése #

Visszaadja azon termékek árait, ahol be van pipálva az 1. Honlap mező.

Megegyezik a GetPrice eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetPrice3 – Árak lekérése (Viszonteladó saját ár) #

Visszaadja az aktív termékek árait és az API-hoz rendelt ügyfél árát.
Bemenő paraméter nincs.

Ha az API-nál nincs megadva ügyfél kód, akkor hibát ad:

{
  "result": "error", 
  "message": "Az API nincs ügyfélhez rendelve!"
}

Ha a megadott ügyfél kód nem tartozik egy aktív ügyfélhez sem, akkor hibát ad:

{
  "result": "error", 
  "message": "Az azonosító (...) nem tartozik egyetlen aktív vevőhöz sem!"
}

Válasz:

{
  "result": "ok", 
  "products": [ 
    {
      "id": "C1",
      "price": "listaár",
      "ownprice": "ügyfél ár",
      "installerprice": "telepítői ár"
    }, ...
  ]
} 

GetCustomPrice – Egyedi árak és kedvezmények #

Visszaadja az ügyfelekhez tartozó egyedi kedvezményeket és egyedi árakat.

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "categories": [ 
    {
      "id": "kategória azonosító",
      "name": "kategória név"
    }, ...
  ],
  "customers": [ 
    {
      "id": "ügyfél azonosító"
      "discount": [
        { 
          "discount": "kedvezmény",
          "categories": [
            56,
            57,
            ...
          ],
          "product": "termék azonosító",
          "payment_method": "fizetési mód",
          "end_date": "vége dátum",
          "end_time": "vége idő"
        }, 
        ...     
     ],
     "price": [
       {
         "price": "listaár",
         "currency": "pénznem",
         "product": "termék azonosító",
         "group": ["szint1", "szint2", ...],
         "work": "munkaszám",
         "workquantity": "munkaszám mennyiség",
         "unit": "mértékegység",
         "end_date": "vége dátum",
         "end_time": "vége idő"
       },
       ...
      ]         
    },...
  ],
} 

A discount-on és a price-on belül a *** mezők közül az egyik mindig ki van töltve.

Ha az end_date paraméter üres, akkor nincs lejárata az egyedi kedvezménynek illetve árnak.

CreateOffer – Ajánlat létrehozása #

Rögzít egy vevői rendelés a rendszerben webshop munkaszámmal.

Az így létrehozott bizonylatok kapnak egy webshop munkaszámot és az Értékesítés/1. webshop menüpont alatt találhatók meg.

Ha olyan szállítási címet kap, ami még nem létezik, akkor azt létrehozza.

Az ügyfél rendszeren belüli felelősének küld egy e-malit Új rendelés érkezett – bizonylatszám tárggyal.

Az alábbi adatok a bizonylat megjegyzésébe kerülnek:

• Comment – Webshop-ban megadott megjegyzés
• ShippingMode – Szállítási mód
• DateOfReceipt – Átvétel időpontja
• Phone – Telefonszám
• Recipment – Értesítendő személy
• Ship… – Szállítási cím

Címek kezelése

Ha a BillAuto illetve ShipAuto mezőkben true szerepel, akkor további cím mező megadására nincs szükség.

Egyébként mindkét cím típusra igaz, hogy vagy az Id-t kötelező megadni vagy az egyéb cím adatokat. Az egyéb adatoknál a kötelezőség értelem szerű. A rendszer az ION-ban megadott címekből kikeresi az Id-t vagy annak hiányában az egyéb adatok alapján a címet.

Számlázási cím csak a rendszerben előzetesen felvitt cím lehet.

Ha eddig ismeretlen szállítási címet adtak meg, akkor azt létrehozza a rendszer egy Webshop-ról megjegyzéssel.

A címben kötelező mezők azok, amik a Nav szerint kötelezőek:

• Magyar cím esetén (tehát, ha a BillCountry, ShipCountry = Magyarország vagy üres) kötelező az irányítószám, település, közterület neve és jellege.
• Külföldi cím esetén kötelező a település és a közterület neve (ilyenkor ide kell az egész cím).

A közterület jellegben elfogadott értékek lekérdezhetők a GetKozterulet függvénnyel.

Válasz:

{
  "result": "ok", 
  "offerid": "bizonylatszam"
}

Hibaüzenetek:

• A CreateOffer eljárás kötelező paraméterei …!
• Az azonosító (…) nem tartozik egyetlen aktív vevőhöz sem!
• Az raktár kód (…) nem tartozik egyetlen raktárhoz sem!
• Legalább egy termék megadása kötelező!
• Hibás számlázási cím!
• Hibás szállítási cím!
• Ismeretlen fizetés típus (…) (1)!
• Termék nem létezik (P01)!
• Mennyiség megadása kötelező (P01)!
• A mennyiségnek pozitívnak kell lennie (P01)!
• A megadott kupon 1) nem létezik, 2) már felhasználták, 3) lejárt!

CreateOffer2 – Rendelés létrehozása #

Rögzít egy vevői rendelést a rendszerben webshop2 munkaszámmal.

Megegyezik a CreateOffer eljárással, csak itt a webshop2 munkaszámot állítja be.

• webshop2 munkaszámot állítja be
• Két plusz bemenő paraméte

CreateDelivery – Szállítólevél létrehozása #

Rögzít egy szállítólevelet a rendszerben webshop munkaszámmal.

Paraméterei megegyeznek a CreateOffer eljárás paramétereivel.

Ha van elég készlet a termékekből, akkor rögtön kiadja a raktárnak szedésre.

Miután a raktár végzett, a rendszer automatikusan számlát állít ki.

GetStock – Készlet lekérése ( webshop 1 ) #

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező.

Csak azokat a termékeket adja vissza, ahol alábbi feltételek közül legalább az egyik teljesül:

• van készlet
• van várható érkezési idő
• van átfutási idő

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "stock": [ 
    {
      "id": "cikkszám",
      "set": "true",
      "location": "telephely",
      "stock": "készlet",
      "arrival": "várható érkezés (YYYY.MM.DD)",
      "transittime": "átfutási idő",
      "unit": "átfutási idő mértékegysége",
      "transittime2": "raktárnál megadott átfutási idő",
      "unit2": "raktárnál megadott átfutási idő mértékegysége",
      "unavailableat": "nem elérhető (YYYY.MM.DD)"
    }, ...
  ]
} 

GetStock2 – Készlet lekérése #

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező.

Megegyezik a GetStock eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

GetStock3 – Készlet lekérése #

Visszaadja a készletet, a várható beérkezést és az átfutási időt azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező.

Megegyezik a GetStock eljárással, csak a készletet az alábbiak szerint adja vissza:
10 alatt átadja a valós készlet értéket,
de ha a készlet >= 10, akkor 10-et ad vissza.

GetStockAvailable – Készlet elérhetőség lekérése ( webshop 1 ) #

Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 1. Honlap mező és van belőle készleten.

Szettek esetén visszadjuk a készlet értékét is

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "stock": [ 
    {
      "id": "cikkszám",
      "set": "true",
      "location": "telephely",
      "stock": "készlet"
    }, 
    {
      "id": "cikkszám", 
      "location": "telephely"
    }...
  ]
} 

GetStock2Available – Készlet elérhetőség lekérése ( webshop 2 ) #

Visszaadja a terméket és a készlet telephelyét azoknak a termékeknek, ahol be van pipálva az 2. Honlap mező és van belőle készleten.

Megegyezik a GetStockAvailable eljárással, csak itt a 2. Honlap mezőre szűri a termékeket.

SetWebLink – Termék weblink beállítás #

Beállítja a termék webcímét.

Az ION kikeresi a cikkszám alapján a terméket és beállítja a weblink értékét.

A weblinkeknek meg lehet adni egységesen az elejét a Beállítások/Paraméterek ablakon a Termékek/Weblink mezőben (például http://www.ceg.hu/termekek/).

Ebben az eljárásban csak az előbbi módon megadott url után részt kell átadni.

Válasz:

{
  "result": "ok"
}

GetKozterulet – Közterület jellegek lekérése #

Visszaadja a választható közterület jellegeket (utca, út stb.).

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "kozterulet": [ 
    {
      "name": "akna"
    },
    {
      "name": "akna-alsó"
    }, ...
  ]
} 

GetParam – Termék jellemző típusok #

Visszaadja a jellemzők típusokait.
Nincs bemenő paramétere.

Válasz:

{
  "result": "ok", 
  "params": [ 
    {
      "name": "név",
      "datatype": "típus",
      "unit": "mértékegység",
      "closed": "zárt",
      "hidden": "rejtett",
      "order": "sorrend",
      "shortname": "rövidnév",
      "items": ["egy", "egy", ...]
    }, ...
  ]
} 

GetProductParam – Termék jellemzők #

Visszaadja azon termékek jellemzőit, ahol be van pipálva az 1. Honlap mező.

Nincs bemenő paramétere.

Válasz:

{
  "result": "ok",
  "productparam": [ 
    {
      "id": "ügyfél azonosító"
      "param": [
        { 
          "név1": "érték1",
          "név2": "érték2",
          ...
        }, 
        ...     
      ]       
    }, ...
  ]
} 

GetBarcode – Termék vonalkódok #

Visszaadja a termékekhez tartozó vonalkódokat.
Egy termékhez több vonalkód is tartozhat.
Nincs bemenő paramétere.

Válasz:

{
  "result": "ok", 
  "barcodes": [ 
    {
      "id": "cikkszám",
      "barcode": "vonalkód",
      "quantity": "mennyiség",
      "unit": "mértékegység"
    }, ...
  ]
} 

CreateContact – Ügyfél kapcsolattartó #

Ügyfelekhez tartozó kapcsolattartókat lehet létrehozni illetve módosítani.

Ha a rendszerben az adott ügyfélnek már szerepel a megadott e-mail címmel kapcsolattartója, akkor módosítja az adatait. Egyéb esetben létrehozza azt.

Új kapcsolattartó létrehozáskor kötelező megadni a kapcsolattartó nevét.
Ha valamelyik nem kötelező paraméter nem szerepel a hívásban, akkor azt nem módosítja.

Mind létrehozáskor, mind módosításkor beállítja a kapcsolat Webshop paraméterét igazra.

Válasz:

{
  "result": "ok"
}

DeleteContact – Ügyfél kapcsolattartó törlése #

Ügyfelekhez tartozó kapcsolattartó törlése.

A Name és Email paraméterek közül az egyik megadása kötelező! Elsődlegesen az e-mail címmel keres.

Válasz:

{
  "result": "ok"
}

GetContact – Ügyfél kapcsolattartóinak lekérdezése #

Ügyfelekhez tartozó kapcsolattartó lekérdezése.

Ha csak CustomerId paraméter van átadva, akkor visszaadja az ügyfélhez tartozó összes kapcsolattartó adatait.
Egyéb esetben csak a szűrésnek megfelelő kapcsolattartót adja vissza.

Csak azokat a kapcsolattartókat adja át, akiknél be van pipálva a Webshop paraméter.

Ha nincs megdva a CustomerId paraméter, de a timestamp igen, akkor az időpont után létrejött, módosult és törölt kapcsolattartókat adja vissza.

Törölt rekord esetén visszaadja a CustomerId, Name, Email paramétereket és egy deleted = true paramétert.

Válasz: 

{
  "result": "ok", 
  "CustomerId": "azonosító", 
  "contacts": [ 
    {
      "Name": "név",
      "Mobile": "06301111111",
      "Email": "minta@email.com",
      "EligibleForPurchase": "Igen",
      "Primary": "Nem",
      "InvoiceMail": "Igen",
      "DeliveryMail": "Nem",
      "ServiceMail": "Nem",
      "PurchaseMail": "Nem",
      "AutoQuotationMail": "Igen",
      "OrderConfirMail": "Igen",
      "ItemRecipient": "Igen"
    }, ...
  ]
} 

Válasz 2: 

{
  "result": "ok", 
  "contacts": [ 
    {
      "CustomerId": "azonosító", 
      "Name": "név",
      "Email": "minta@email.com",
      "deleted": "true"
    }, ...
  ]
} 

GetDiscount – Ügyfél kedvezmények lekérése #

Visszaadja az ügyfelekhez és az egyes kedvezményekhez tartozó kedvezmény kategóriákat. Csak azokat a vevőket adja vissza, akiknél be van pipálva az 1. honlap.
Nincs bemenő paraméter.

Először visszaadja a kategóriákat (Categories).
Utána visszaadja az egyes ügyfeleket (Customers), azon belül az egyes kedvezmény százalékokat (value) és a hozzá tartozó kategóriák id-it (categories).

Válasz:

{
  "result": "ok", 
  "categories": [ 
    {
      "id": "kategória azonosító",
      "name": "kategória név"
    }, ...
  ],
  "customers": [ 
    {
      "id": "ügyfél azonosító"
      "discount": [
        { 
          "value": 0,
          "categories": [
            53
          ]
        },
        { 
          "value": 17,
          "categories": [
            56,
            57,
            38,
            44,
            85,
            86,
            95,
            116
          ]
        }, 
        ...     
     ]        
    },...
  ]
} 

GetDocument – Bizonylatok lekérése #

Visszaadja egy ügyfél bizonylatait. Az aktív ajánlatokat (ha végleges) és rendeléseket, továbbá a lezárt szállító leveleket és számlákat.

• quotation: ajánlat
• order: rendelés
• deliverynote: szállítólevél
• invoice: számla

Ha a DateFrom paraméter meg van adva, akkor azokat a bizonylatokat adja vissza, amik a dátumtól kezdve módosítva lettek.
Ha nincs dátum paraméter, akkor az elmúlt 3 hónap bizonylatait adja vissza.
Ha meg van adva, akkor is legfeljebb az elmúlt egy év adatait adja vissza.

Ha nincs megadva a CustomerId, akkor az összes bizonylatot visszaadja, ami a dátum után jött létre vagy módosult.

Válasz: 

{
  "result": "ok", 
  "CustomerId": "azonosító", 
  "documents": [ 
    {
      "id": "azonosító",
      "number": "bizonylatszám",
      "type": "bizonylatok típusa",
      "dated": "kelt",
      ...
    }, ...
  ]
} 

A bizonylat típusok kezdőbetűjével van jelölve (q, o, d, i), hogy melyik paraméter melyik típusnál szerepel. A *-os paraméterek mindegyik típusnál léteznek.

GetDocumentDetail – Bizonylat tételek lekérése #

Visszaadja egy bizonylat tételeit.

Válasz:

{
  "result": "ok", 
  "id": "azonosító", 
  "details": [ 
    {
      "number": "sorszám",
      "id": "cikkszám",
      "name": "megnevezés",
      "quantity": "mennyiség",
      "open": "nyitott mennyiség",
      "reserved": "foglalt mennyiség",
      "unit": "mértékegység",
      "price": "nettó egységár",
      "net": "nettó összesen",
      "status": "státusz",
      "arrival": "várható érkezés"
      "optional": "true"
    }, ...
  ]
} 

GetDocumentPdf – Bizonylathoz tartozó pdf #

Visszaadja egy bizonylat nyomtatványát PDF formátumban.

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "pdf": "base64"
}

GetPackingListPdf – Bizonylathoz tartozó csomagolási lista PDF #

Visszaadja egy bizonylat csomagolási lista nyomtatványát PDF formátumban.

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "pdf": "base64"
}

OfferToOrder – Ajánlat rendeléssé származtatása #

A megadott ajánlatot rendeléssé származtatja és visszaadja annak az azonosítóját.

Válasz:

{
  "result": "ok", 
  "id": "azonosító",
  "newid": "új azonosító"
}

GetProductCategory – Termék kategóriák lekérése #

Visszaadja az összes olyan terméket és kategóriáját, ahol be van pipálva az 1. Honlap mező.

Bemenő paraméter nincs.

Válasz:

{
  "result": "ok", 
  "products": [
    {
      "id": "cikkszám",  
      "name": "megnevezés",
      "name2": "rövid név",
      "status": "státusz",
      "group": [
        {
          "path": ["szint1", "szint2", ...], 
          "main": "true"            
        }...
      ],

    },...
  ]
} 

GetAssignee – Felelősök lekérése #

Visszaadja a felelősöket a szűrésnek megfelelően.
Ha nincs megadva szűrés, akkor az összes felelőst visszaadja.

Válasz, jogkör megadása esetén:

{
  "result": "ok", 
  "Authority": "jogkör",
  "Assignees": [
    {
      "name": "felelős neve",
      "email": "minta@email.hu" 
  ]
}

Válasz, jogkör megadása nélkül:

{
  "result": "ok", 
  "Assignees": [
    {
      "name": "felelős neve",
      "email": "minta@email.hu",
      "authority": "jogkörök"
  ]
}

AddEvent – Ügyfél esemény létrehozása #

Ügyfel eseménynaplójához létrehoz egy új bejegyzést.

Ha a típus nem létezik, akkor létrehozza.

A megadott emailcím alapján azonosítja be a felhasználót.

Válasz:

{
  "result": "ok"
}

GetCoupon – Ügyfél kuponjainak lekérése #

Visszaadja az ügyfél elérhető és lezárt kuponjait.

Ha megvan adva a CustomerId paraméter, akkor az adott ügyfél kuponjait adja vissza. Ha a timestamp paraméter van megadva, akkor az időpont után létrejött, módosult és törölt kuponokat adja vissza.

Törölt rekord esetén visszaadja a code paramétert és egy deleted = true paramétert.

Válasz:

{
  "result": "ok", 
  "CustomerId": "azonosító",
  "Coupon": [
    {
      "name": "Kupon neve",
      "value": "Összeg",
      "created": "Kiadás",
      "code": "Azonosító",
      "limit": "Értékhatár",
      "valid": "Beváltható",
      "used": "Felhasználva",
      "description": "Leírás",
      "condition": "Beváltási feltétel",
      "document": "Bizonylat, amin felhasználták",
    }
  ]
} 

Válasz 2:

{
  "result": "ok", 
  "Coupon": [
    {
      "code": "Azonosító",
      "deleted": "true",
    }
  ]
} 

AddTask – Feladat létrehozása #

Készít egy új feladatot a feladatkezelőben.

A megadott emailcím alapján azonosítja be a felhasználót.

Válasz:

{
  "result": "ok"
}

GetTask – Feladatok lekérése #

A felhasználót az email azonosítja.

Ha tipus = figyelo, akkor visszaadja azokat a feladatokat, amiket ő hozott létre, vagy amiknek a figyelője. Minden aktív feladatot visszaad és a lezártak közül azokat, amiket az elmúlt 2 hétben zártak le.

Ha tipus = elvegzo, akkor visszaadja azokat az aktív feladatokat, ahol a felhasználó a feladat típusa szerint ügyintéző lehet.

Válasz:

{
  "result": "ok", 
  "email": "email cím",
  "task": [
    {
      "id": "ION belső azonosító",
      "azonosito": "Összeg",
      "targy": "Tárgy",
      ...
    }
    ...
  ]
} 

GetEducation – Oktatások lekérése #

Visszaadja az oktatásokat.

Ha nincs megadva a timestamp paraméter, akkor csak azokat az oktatásokat adja vissza, amik aktívak és a weboldal be van pipálva.

Válasz:

{
  "result": "ok", 
  "education": [
    {
      "id": "ION belső azonosító",
      "azonosito": "Publikus azonosító",
      "megnevezes": "Megnevezés",
      ...
    }
    ...
  ]
} 

AddParticipant – Oktatás résztvevő hozzáadása #

Válasz:

{
  "result": "ok", 
  "kod": o232323"
} 

EventEntry – Rendezvény beléptetés #

GetWorksheet – Szerviz munkalapok lekérése #

Visszaadja azokat a munkalapokat, amik nem sajátok és nincsenek lezárva.

Nincsenek bemenő paraméterei.