Erinevused

Siin näed erinevusi valitud versiooni ja hetkel kehtiva lehekülje vahel.

--- et:xml_direct [2025/03/06 08:39] – [Table] toomas
+++ et:xml_direct [2025/05/07 13:39] (Hetkel kehtiv) – [Tutvustus] toomas
@@ Rida 1: / Rida 1: @@
 ======XML Direct ======
 =====Tutvustus =====
-XML Direct on ühispöördumispunkitga liides, mille iga komponent on eraldi valitav. Liidese komponentide väljad on "lukus" ning alati ühesugused kõikides baasides. Arendused toimuvad jagatud lahenduse põhimõttel. Liides on aktiveeritav ning ei vaja Directo poolset arendust. Kokku on vaja leppida vajalikud komponendid.
+XML Direct on standardiseeritud liides, mis töötab ühispöördumispunkti kaudu ning koosneb komponentidest, mida saab vastavalt vajadusele eraldi valida.
+Kõigi komponentide väljad on fikseeritud ehk „lukus“ – see tähendab, et andmevorming ja struktuur on ühtsed kõigis Directo kliendibaasides. Arendused tehakse jagatud lahenduse põhimõttel ja liidese aktiveerimine ei vaja Directo-poolset kohandamist.
+Liides võimaldab luua mitu erinevat API võtit, et pakkuda turvalist ligipääsu mitmele partnerile. Igal API võtmel võib olla ligipääs ainult valitud komponentidele, mis suurendab paindlikkust ja infoturvet.
+Enne kasutuselevõttu tuleb kokku leppida, millised komponendid on vajalikud.
 =====API võti =====
 Et leida liidese XML võti ja edastada see arendajale:
   - Logi Directosse sisse kasutajaga kellel on ''SUPER'' õigused \\
-  - Ava töötaja kaart 'XML' \\ {{:et:toomas20230213-104217.png?300}} \\
+  - Kuna API võtmeid võib olla mitu, siis pead avama töötaja kaardi kellele on võti loodud. Näiteks ava töötaja kaart 'XML' \\ {{:et:toomas20230213-104217.png?300}} \\
   - Liigu ''Admin'' sakile \\ {{:et:toomas20230213-104458.png}} \\
   - Liigu sektsioonini ''XML liidesed'' \\
@@ Rida 29: / Rida 35: @@
 Väljund ja Sisend [[https://www.postman.com/|Postman]] keskkonna jaoks saab alla laadida {{:et:directoxmlcoretest.postman_collection.json|siit }}ning siis importida Collectionina Postmani ning seal testida.
 =====Hind ======
-Hind vastavalt valitud komponentidele. Kustutatud dokumentide väljund on tasuta komplektis kaasas.
+**Hind sõltub valitud komponentidest.** \\
+Kustutatud dokumentide väljund on hinna sees ja tasuta.
+**Lisa API võtme hind on 0 € kuus.** \\
+Kui mitmel API võtmel on samad komponendid, arvestatakse nende eest tasu ainult üks kord.
+**Näide: ** \\
+  * API võti A sisaldab väljundeid: klient ja artikkel
+  * API võti B sisaldab väljundeid: klient ja tellimus
+→ Sellisel juhul on tasu ainult kolme unikaalse komponendi eest: klient, artikkel ja tellimus.
 =====Testimine ======
 XML Direct liidese testimise link
@@ Rida 41: / Rida 56: @@
 =====Komponendid =====
 **Valitavad komponendid**
-^ Komponent (what)                   ^ Sisend \\ (put=1)  ^ Väljund \\ (get=1)  ^
+^ Komponent (what)                           ^  Sisend \\ (put=1)  ^  Väljund \\ (get=1)  ^
-| Tellimused (order)                 |  x      |  x        |
+| Tellimused (order)                         |  x                  |  x                   |
-| Arved (invoice )                   |  x      |  x       |
+| Arved (invoice )                           |  x                  |  x                   |
-| Laekumised (receipt)               |  x      |  x       |
+| Laekumised (receipt)                       |  x                  |  x                   |
-| Kliendid (customer)                |  x      |  x       |
+| Kliendid (customer)                        |  x                  |  x                   |
-| Artiklid (item)                    |  x      |  x       |
+| Hankijad (supplier)                      |  x                   |  x                   |
-| Artikliklassid (itemclass)         |         |  x       |
+| Artiklid (item)                            |  x                  |  x                   |
-| Laoseis (stocklevel)               |         |  x       |
+| Artiklid:Laolimiidid (itemstocklimit)      |                     |  x                   |
-| Hinnavalemi read (priceformularow) |         |  x       |
+| Artiklid:Pakendid (itempackage)            |                     |  x                   |
-| Ostuarved (purchase)               |  x      |  x       |
+| Artiklid:Soetud artiklid (itemrelitem)     |                     |  x                   |
-| Finantskanded (transaction)        |  x      |  x       |
+| Artikliklassid (itemclass)                 |                     |  x                   |
-| Kustutatud dokumendid              |         |  x       |
+| Laoseis (stocklevel)                       |                     |  x                   |
+| Laoseis seerianumbritega (stocklevel_sn)   |                     |  x                   |
+| Laoseis variantidega (stocklevel_variant)  |                     |  x                   |
+| Hinnavalemi read (priceformularow)         |                     |  x                   |
+| Ostuarved (purchase)                       |  x                  |  x                   |
+| Finantskanded (transaction)                |  x                  |  x                   |
+| Ressursid (resource)                       |  x                  |  x                   |
+| Kustutatud dokumendid                      |                     |  x                   |
 ====Sisendid ====
@@ Rida 239: / Rida 261: @@
 == Read: ==
-^XML väli^SQL väli^UI väli^Selgitus^
+^ XML väli      ^ SQL väli      ^ UI väli     ^ Selgitus                                                                      ^
-|item|artikkel|Artikkel| |
+| item          | artikkel      | Artikkel    |                                                                               |
-|description|nimetus|Sisu| ALT.FROM: item |
+| description   | nimetus       | Sisu        | ALT.FROM: item                                                                |
-|price|yhikuhind|Ühikuhind| unit price without vat |
+| price         | yhikuhind     | Ühikuhind   | unit price without vat                                                        |
-|quantity|kogus|Kogus| |
+| quantity      | kogus         | Kogus       |                                                                               |
-|discount|pross|%| |
+| discount      | pross         | %           |                                                                               |
-|account|konto|Konto| ALT.FROM: item > item class (depending on vatregion) |
+| account       | konto         | Konto       | ALT.FROM: item > item class (depending on vatregion)                          |
-|vatcode|kmkood|KMk|  ALT.FROM: customer > item > item class (depending on vatregion)|
+| vatcode       | kmkood        | KMk         |               ALT.FROM: customer > item > item class (depending on vatregion) |
-|unit|yhik|Ühik| ALT.FROM: item |
+| unit          | yhik          | Ühik        | ALT.FROM: item                                                                |
-|comment|r_kommentaar|Kommentaar| |
+| comment       | r_kommentaar  | Kommentaar  |                                                                               |
-|variant|variant|Variant| |
+| variant       | variant       | Variant     |                                                                               |
-|rsum|rsum|RSKM (kui on saadetud price/ühikuhind, siis rskm'i ei kasutata)| |
+| deliverytime  | lahetusaeg    | Lähetusaeg  |                                                                               |
-|deliverytime|lahetusaeg|Lähetusaeg| |
+| stock         | r_ladu        | Ladu        |                                                                               |
-|stock|r_ladu|Ladu| |
+| project       | projekt       | Projekt     | ALT.FROM: item > item class                                                   |
-|project|projekt|Projekt| ALT.FROM: item > item class |
+| ext_sum       | ext_sum       |             |                                                                               |
-|ext_sum|ext_sum| | |
+| ext_id        | ext_id        |             |                                                                               |
-|ext_id|ext_id| | |
+| rn            | rn            | Nr          | row order number in document 1 - N ,  ALT.FROM: random                        |
-|rn|rn|Nr|row order number in document 1 - N ,  ALT.FROM: random |
+| rr            | rv            | Rv          | row reference for grouping, otherwise equals to rn ,  ALT.FROM: equals to rn  |
-|rr|rv|Rv|row reference for grouping, otherwise equals to rn ,  ALT.FROM: equals to rn |
@@ Rida 419: / Rida 440: @@
 ==Kliendi transpordi parameetrid ==
 ^ TÜÜP  ^ KOOD  ^ PARAMEETER 1  ^ PARAMEETER 2  ^ SELGITUS  ^
+===Hankijad ===
+  * Postitamisel ja muutmisel on alati nõutud code! \\
+what=supplier
+[[https://login.directo.ee/xmlcore/cap_xml_direct/xml_IN_hankijad.xsd|Skeem ]]
+==hankijad: ==
+^XML väli^SQL väli^UI väli^Selgitus^
+|session_id|x| | for internal use at Directo side, do not send this field! |
+|code|kood|Kood| document number/ID, mandatory; It must be unique for each document and remain same if more than one transaction of the same document is necessary |
+|name|nimi|Nimi| |
+|contact|kontakt| | |
+|address1|aadress1| | |
+|address2|aadress2| | |
+|address3|aadress3| | |
+|phone|telefon| | |
+|fax|faks| | |
+|comment|kommentaar| | |
+|payment|tasumine| | |
+|vatregion|tasu| | |
+|bankaccount|pangakonto| | |
+|debtaccount|vkonto| | |
+|expenseaccount|kulukonto| | |
+|factoring|arvetasub| | |
+|currency|valuuta| | |
+|country|maa| | |
+|object|objekt| | |
+|language|keel| | |
+|class|klass| | |
+|deliveryterm|lahting| | |
+|deliverymode|lahviis| | |
+|vatregno|kmregnr| | |
+|alert|hoiatus| | |
+|vatcode|kmkood| | |
+|regno|regnr1| | |
+|ppaccount|ekonto| | |
+|bycustomer|klient| | |
+|lskonto|lskonto| | |
+|email|email| | |
+|reference|viide| | |
+|closed|suletud| | |
+|dealtype|tehinguliik| | |
+|origin|saatjariik| | |
+|normtime|norm_aeg| | |
+|trancost|transakulu| | |
+|skype|skype| | |
+|discount|ale| | |
+|proceeders|menetlejad| | |
+|prefilled|eeltaida| | |
+|stock|ladu| | |
+|proceedertempalte|menetlejad_mall| | |
+|referencemandatory|viide_kohustuslik| | |
+|type|hank_tyyp| | |
+|purchasinggroup|ostugrupp| | |
+|county|maakond| | |
+== hankijad lisaväljad: ==
+^XML väli^SQL väli^UI väli^Selgitus^
+|code|kood| | |
+|content|sisu|Sisu| |
+|param|param|Parameeter| |
 ===Artiklid===
@@ Rida 550: / Rida 636: @@
 |maxlevel|max_kogus|MAX| |
-==Kliendi transpordi parameetrid ==
+==Artikli transpordi parameetrid ==
 ^TÜÜP	^KOOD	^PARAMEETER 1	^PARAMEETER 2	^SELGITUS^
-|XML |xd_uniqueid |ribakood |ITEM |Andmebaasi väli, kuhu panna väline unikaalne identifikaator (Nt. kliendi_tellimus, lisa_field7, kliendikaart), kui dokumendi numbrit/koodi ei saadeta, väli "ext_unique_id" peab ka skeemis olema |
 |XML |xd_supplieritemtype |0 |ITEM |0 = hankija artikkel; 1 = müügi artikkel |
 |XML |type |1 |ITEM |1 = laoartikkel |
@@ Rida 655: / Rida 740: @@
 ==Ostuarve transpordi parameetrid ==
-^TÜÜP^KOOD^PARAMEETER 1^PARAMEETER 2^SELGITUS^
+^ TÜÜP  ^ KOOD                      ^ PARAMEETER 1  ^ PARAMEETER 2  ^ SELGITUS                                                                                                                          ^
-|XML|xd_autosupplier|1|PURCHASE|Automaatne seotud hankija loomine, kui hankija koodi ei eksisteeri, unikaalne regnr on eelduseks|
+| XML   | xd_autosupplier           | 1             | PURCHASE      | Automaatne seotud hankija loomine, kui hankija koodi ei eksisteeri, unikaalne regnr on eelduseks                                  |
-|XML|xd_uniqueid|hankija_arve|PURCHASE|Andmebaasi väli, kuhu panna väline unikaalne identifikaator (Nt. kliendi_tellimus, lisa_field7, kliendikaart), kui dokumendi numbrit/koodi ei saadeta, väli "ext_unique_id" peab ka skeemis olema|
+| XML   | xd_autosupplier_autocode  | 0             | PURCHASE      | Seotud hankija loomisel luuakse kood liideses, unikaalne reg.number on vajalik ja hankija koodi süsteemiseadistused on vajalikud  |
-|XML|xd_autosupplier_autocode|0|PURCHASE|Seotud hankija loomisel luuakse kood liideses, unikaalne reg.number on vajalik ja hankija koodi süsteemiseadistused on vajalikud|
+| XML   | xd_update                 | 0             | PURCHASE      | Luba dokumendi update, kui puuduvad seotud dokumendid                                                                             |
-|XML|xd_update|0|PURCHASE|Luba dokumendi update, kui puuduvad seotud dokumendid|
+| XML   | supplier_update           | 0             | PURCHASE      | Hankija andmete osaline update, (email, ... ) väljad on vaja spekis täpsustada                                                    |
-|XML|xd_series|DOK|PURCHASE|Seeria, juhul kui luuakse dokumendi number liideses, "uniqueid" transpordi parameeter peab olema ka seadistatud toimimiseks ja skeemis peab olema väli "ext_unique_id"|
+| XML   | xd_object                 | VEEB          | PURCHASE      | Vaikimisi objekt, kui ei saadeta                                                                                                  |
-|XML|supplier_update|0|PURCHASE|Hankija andmete osaline update, (email, ... ) väljad on vaja spekis täpsustada|
+| XML   | xd_confirm                | 0             | PURCHASE      | Automaatne dokumendi kinnitamine, seda saab ka juhtida XML väljaga "confirm"                                                      |
-|XML|xd_object|VEEB|PURCHASE|Vaikimisi objekt, kui ei saadeta|
-|XML|xd_confirm|0|PURCHASE|Automaatne dokumendi kinnitamine, seda saab ka juhtida XML väljaga "confirm"|
+===Ressursid ===
+what=resource
+[[https://login.directo.ee/xmlcore/cap_xml_direct/xml_IN_ressursid.xsd|Skeem ]]
+== Päis: ==
+^XML väli^SQL väli^UI väli^Selgitus^
+|session_id|x| | |
+|ext_unique_id|ext_unique_id| | |
+|number|number| | |
+|date|aeg| | |
+|comment|kommentaar| | |
+|customer|vaik_klient_kood| | |
+|employee|vaik_tegija| | |
+|stock|ladu| | |
+|project|projekt| | |
+|asset|inventar| | |
+|datafield1|lisa_field1| | |
+|datafield2|lisa_field2| | |
+|datafield3|lisa_field3| | |
+|datafield4|lisa_field4| | |
+|datafield5|lisa_field5| | |
+|datafield6|lisa_field6| | |
+|datafield7|lisa_field7| | |
+|object|objekt| | |
+|confirm|kinnita| | |
+== Read: ==
+^XML väli^SQL väli^UI väli^Selgitus^
+|item|artikkel| | |
+|quantity|kogus| | |
+|date|aeg| | |
+|description|nimetus| | |
+|price|hind| | |
+|discount|ale| | |
+|comment|kommentaar| | |
+|event|event| | |
+|purchaseprice|fifo| | |
+|unit|yhik| | |
+|employee|tegija| | |
+|invoiced|arvega| | |
+|contract|leping| | |
+|timewindow1|aeg_aken1| | |
+|timewindow2|aeg_aken2| | |
+|project|projekt| | |
+|sum|summa| | |
+|customer|klient_kood| | |
+|customername|klient_nimi| | |
+|stock|r_ladu| | |
+|vatcode|kmk| | |
+|contact|kontakt| | |
+|object|objektid| | |
+|closed|suletud| | |
+|initialqty|kogus_alg| | |
+|finishedqty|kogus_tehtud| | |
+|stopped|peatutud| | |
+|customerqty|klient_kogus| | |
+|sn|sn| | |
+|constant1|konstant1| | |
+|constant2|konstant2| | |
+|constant3|konstant3| | |
+|constant4|konstant4| | |
+|asset|r_inventar| | |
+|capitalasset|pohivara| | |
+|shelf|riiul| | |
+|department|osakond| | |
+|text1|tekst1| | |
+|text2|tekst2| | |
+|text3|tekst3| | |
+|text4|tekst4| | |
+|delete|kustuta| | |
+|rn|rn| | |
+==== Väljundid ====
+=== Artiklid (Items) ===
+  * what=item  [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_artiklid.xsd|Skeem ]] \\ Filtrid: class,code,type,barcode,supplier,supplieritem,closed,ts
+== Artikli laolimiidid (Item stock limits) ==
+  * what=itemstocklimit [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_artiklid_laolimiidid.xsd|Skeem ]] \\ Filtrid: code,stock,ts
+== Artikli pakendid (Item packages) ==
+  * what=itempackage [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_artiklid_pakendid.xsd|Skeem ]] \\ Filtrid: code,ts
+== Seotud artikli (Item relations) ==
+  * what=itemrelitem [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_artiklid_seotud.xsd|Skeem ]] \\ Filtrid: code,ts
+=== Kliendid (Customers) ===
-====Väljundid ====
-==Artiklid (Items) ==
-  * what=item  [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_artiklid.xsd|Skeem ]] \\ Filtrid: class,code,type,barcode,supplier,supplieritem,closed,ts
-==Kliendid (Customers) ==
   * what=customer	[[https://login.directo.ee/xmlcore/cap_xml_direct/ws_kliendid.xsd|Skeem ]] \\ Filtrid: code,loyaltycard,regno,email,phone,closed,ts
-== Laoseis (Stock levels) ==
-  * what=stocklevel	[[https://login.directo.ee/xmlcore/cap_xml_direct/ws_laoseis.xsd|Skeem ]] \\ Filtrid: code,stock,ts
+=== Hankijad (Suppliers) ===
-== Hinnavalemi read (Price formula rows) ==
+  * what=supplier
+  * [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_hankijad.xsd|Skeem ]] \\
+  * Filtrid: code,regno,email,closed,ts
+=== Laoseis (Stock levels) ===
+  * what=stocklevel [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_laoseis.xsd|Skeem ]] \\
+  * what= stocklevel_sn [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_laoseis_sn.xsd|Skeem ]] \\
+  * what=stocklevel_variant [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_laoseis_variandid.xsd|Skeem ]] \\
+  * Filtrid: code,stock,ts
+=== Hinnavalemi read (Price formula rows) ===
   * what=priceformularow	[[https://login.directo.ee/xmlcore/cap_xml_direct/ws_hinnavalemid.xsd|Skeem ]] \\ Filtrid: class,code,type,barcode,supplier,supplieritem,closed,ts
-== Artikli klassid (Item classes) ==
+=== Artikli klassid (Item classes) ===
   * what=itemclass	[[https://login.directo.ee/xmlcore/cap_xml_direct/ws_artikliklassid.xsd|Skeem ]] \\ Filtrid: code,master
-== Arved (Invoices) ==
+=== Arved (Invoices) ===
   * what=invoice [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_arved.xsd|Skeem ]] \\ Filtrid: number,customercode,transactiondate,date1,date2,ts, ordernumber
-== Tellimused (Orders) ==
+=== Tellimused (Orders) ===
   * what=order [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_tellimused.xsd|Skeem ]] \\ Filtrid: number,date1,date2,ts, projekt, customerordernumber, stock, status
-== Finantskanded (Transactions) ==
+=== Finantskanded (Transactions) ===
   * what=transaction [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_kanded.xsd|Skeem ]] \\ Filtrid: number,date1,date2,ts
-== Laekumised (Receipts) ==
+=== Laekumised (Receipts) ===
   * what=receipt [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_laekumised.xsd|Skeem ]] \\ Filtrid: number,date1,date2,ts
-== Ostuarved (Purchase) ==
+=== Ostuarved (Purchase) ===
   * what=purchase [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_oarved.xsd|Skeem ]] \\ Filtrid: number,date1,date2,supplier,confirmed,status,ts
-== Kustutatud dokumendid (Deleted documents ) ==
+=== Ressursid (Resources) ===
+  * what=resource [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_ressursid.xsd|Skeem ]] \\
+  * Filtrid: number,confirmed,ts
+=== Kustutatud dokumendid (Deleted documents ) ===
   * what=delete [[https://login.directo.ee/xmlcore/cap_xml_direct/ws_kustutamised.xsd|Skeem ]] \\ Filtrid: number,code,document,ts