Sisujuht
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.
API võti
Et leida liidese XML võti ja edastada see arendajale:
- Logi Directosse sisse kasutajaga kellel on
SUPER
õigused
- Liigu sektsioonini
XML liidesed
Ligipääs liidesele (URL)
Liidesele ligipääs käib POST meetodil, form/urlencoded järgneva URL'i suhtes: https://login.directo.ee/xmlcore/cap_xml_direct/xmlcore.asp
Ligipääsuks tuleb kasutada token'it. Token asendab vanemat tüüpi liideste appkey ja andmebaasi nime korraga. Token tuleb POST meetodil muutujas TOKEN
(sarnaselt siis html vormi postitamisele) saata antud URL'i pihta tulemuse saamiseks. Ebakorrektse või valesti saadetud tokeni korral on vastus <result type=„5“ desc=„Unauthorized“/>
ja kui ei kasuta muutujat TOKEN, siis on vastus <err>token required</err>
curl näide
curl --location 'https://login.directo.ee/xmlcore/cap_xml_direct/xmlcore.asp' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'token=••••••' \ --data-urlencode 'get=1' \ --data-urlencode 'what=xxxxx' \ --data-urlencode 'ts=xx.xx.xxxx'
Postman näide
Väljund ja Sisend Postman keskkonna jaoks saab alla laadida siit ning siis importida Collectionina Postmani ning seal testida.
Hind
Hind vastavalt valitud komponentidele. Kustutatud dokumentide väljund on tasuta komplektis kaasas.
Testimine
XML Direct liidese testimise link https://login.directo.ee/xmlcore/cap_xml_direct/webupload.html
Üldine
- Väljundliidesed näitavad kõiki kirjeid ning piiranguid saab teha päringu filtritega!
- Sisendliideste funktsionaalsust saab juhtida
TRANSPORDI PARAMEETRITEGA
- palun loe sisendkomponendi Transpordi parameetrite kohta täpsemalt. Vaikimisi tühja või '0' väärtusega transpordi parameetrit ei pea tegema. - Osadel sisenditel toetab ka vaikeväärtuste seadistamist.
Komponendid
Valitavad komponendid
Komponent (what) | Sisend (put=1) | Väljund (get=1) |
---|---|---|
Tellimused (order) | x | x |
Arved (invoice ) | x | x |
Laekumised (receipt) | x | x |
Kliendid (customer) | x | x |
Artiklid (item) | x | x |
Artikliklassid (itemclass) | x | |
Laoseis (stocklevel) | x | |
Hinnavalemi read (priceformularow) | x | |
Ostuarved (purchase) | x | x |
Finantskanded (transaction) | x | x |
Kustutatud dokumendid | x |
Sisendid
Arved
what=invoice Skeem
Päis:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Arve | 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 |
date | aeg | Kuupäev | ALT.FROM: current time |
duedate | aeg2 | Tähtaeg | ALT.FROM: paymentterm |
transactiondate | kande_aeg | ||
vatzone | maa | KM maa | local = 0, EU = 1, export = 2 , ALT.FROM: customer > 0 |
paymentterm | tingimus | T-ting | ALT.FROM: customer , kui on kasutusel laekumiste loomine, läheb see kood ka laekumise makseviisiks |
ordernumber | tellimusenr | Tell. nr. | |
latepaymentpenalty | viivis | Viivis | ALT.FROM: customer |
object | objekt | Objekt | ALT.FROM: tr.params |
project | projekt | Projekt | |
account | konto | Võla konto | |
country | asumaa | Sihtriik | ALT.FROM: customer |
currency | valuuta | Valuuta | ALT.FROM: glob.settings > 'EUR' |
currencyrate | kurssbv1 | Kurss | ALT.FROM: ECB current published rates |
customercode | klient_kood | Klient | mandatory by default! |
customername | klient_nimi | ALT.FROM: customer | |
orderer_code | klient_tellija | ||
contact | esindaja | Nende esindaja | ALT.FROM: customer |
comment | kommentaar | Kommentaar | |
intcomment | sisekommentaar | Sisekommentaar | |
salesman | myyja | Müügiagent | ALT.FROM: tr.params > 'XML' |
language | keel | Keel | ALT.FROM: customer |
customerordernumber | klienditellimus | Kliendi tell. nr. | |
meil | ALT.FROM: customer | ||
address1 | aadress1 | aadress, ! vastavalt seadetele | ALT.FROM: customer |
address2 | aadress2 | aadress, ! vastavalt seadetele | ALT.FROM: customer |
address3 | aadress3 | aadress, ! vastavalt seadetele | ALT.FROM: customer |
phone | telefon | Telefon | ALT.FROM: customer |
fax | faks | Faks | |
deliveryname | klientnimi_lahetusel | Nimi lähetusel | |
deliveryaddress1 | lahetusaadress1 | lähetusaadress, ! vastavalt seadetele | |
deliveryaddress2 | lahetusaadress2 | lähetusaadress, ! vastavalt seadetele | |
deliveryaddress3 | lahetusaadress3 | lähetusaadress, ! vastavalt seadetele | |
priceformula | hinnakiri | Hinnavalem | |
vatregno | kmregnumber | KM Reg. nr | ALT.FROM: customer |
datafield1 | lisa_field1 | Lisaväli 1, ! või vastavalt seadetele | |
datafield2 | lisa_field2 | Lisaväli 2, ! või vastavalt seadetele | |
datafield3 | lisa_field3 | Lisaväli 3, ! või vastavalt seadetele | |
datafield4 | lisa_field4 | Lisaväli 4, ! või vastavalt seadetele | |
datafield5 | lisa_field5 | Lisaväli 5, ! või vastavalt seadetele | |
datafield6 | lisa_field6 | Lisaväli 6, ! või vastavalt seadetele | |
datafield7 | lisa_field7 | Lisaväli 7, ! või vastavalt seadetele | |
quotation | pakkumine | Pakkumine | |
contractnumber | leping | Leping | |
prepayment | ettemaksu_arve | 1 ettemaksu arve, 0 tavaline arve | |
type | tyyp | ||
status | staatus | Staatus | |
paymenttotal | laekumine_summa | Positive number will create receipt with same doc. number. If receipt with this number already exists, receipt will not be created and no notification will be issued | |
confirm | kinnita | „1“ - confirm document | |
stock | ladu | Ladu | ALT.FROM: tr.params |
creditedinvoice | kredarve | Kred. arve | |
asset | inventar | Inventar | |
dealtype | tehinguliik | Tehinguliik | |
delivery | lahetusaeg | Lähetusaeg | |
deliveryterm | lahetustingimus | Läh. ting. | ALT.FROM: customer |
deliverytermcomment | lahetustingimus_komm | Läh. ting. | |
deliverymethod | lahetusviis | Lähetusviis | |
deliverymethodcomment | lahetusviis_komm | Lähetusviis | |
manager | haldur | Vastutaja | |
changestock | muudaladu | stock changing invoice = 1 | |
customer_type | klient_tyyp | Kliendikaardil: Tüüp | company = 0, private citizen = 1, government institution = 2 |
customer_regno | klient_regnr | Kliendikaardil: Reg nr | |
customer_class | klient_klass | Kliendikaardil: Klass | |
customer_loyaltycard | klient_kliendikaart | Kliendikaardil: Kliendikaart |
read:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
item | artikkel | Artikkel | |
description | seletus | Sisu | ALT.FROM: item |
variant | variant | Variant | |
price | hind | Ühikuhind | unit price without vat |
discount | pross | % | |
quantity | kogus | Kogus | |
unit | yhik | Ühik | ALT.FROM: item |
sum | summa | Summa | |
account | konto | Konto | ALT.FROM: item > item class (depending on vatregion) |
object | objektid | Objekt | ALT.FROM: item > item class |
project | projekt | Projekt | ALT.FROM: item > item class |
purchaseprice | kulu | Ostuhind | ALT.FROM: item |
vatcode | kmk | KMk | ALT.FROM: customer > item > item class (depending on vatregion) |
comment | r_kommentaar | Kommentaar | |
date1 | r_aeg1 | ||
date2 | r_aeg2 | ||
salesman | r_myyja | Müüja | |
order | tellimus | ||
orderrow | trn | ||
stock | r_ladu | Ladu | |
sn | seerianumber | Seerianr | |
deliverytime | lahetusaeg | Lähetusaeg | |
customer | r_klient | Tellija | |
customername | r_klient_nimi | Tellija nimi | |
text1 | tekst1 | Tekst1 | |
text2 | tekst2 | Tekst2 | |
text3 | tekst3 | Tekst3 | |
text4 | tekst4 | Tekst4 | |
constant1 | konstant1 | Konstant1 | |
constant2 | konstant2 | Konstant2 | |
constant3 | konstant3 | Konstant3 | |
constant4 | konstant4 | Konstant4 | |
shelf | riiul | Riiul | |
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 |
Arvete transpordi parameetrid
TÜÜP | KOOD | PARAMEETER 1 | PARAMEETER 2 | SELGITUS |
---|---|---|---|---|
XML | xd_changestock | 0 | INVOICE | Ladumuutev arve (Param.1 =1 on muuda ladu) |
XML | xd_uniqueid | lisa_field1 | INVOICE | 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_autocustomer_autocode | 0 | INVOICE | Seotud kliendi loomisel luuakse kood liideses, unikaalne email on vajalik ja kliendi koodi süsteemiseadistused on vajalikud |
XML | xd_update | 1 | INVOICE | Luba dokumendi update, kui puuduvad seotud dokumendid |
XML | xd_series | DOK | INVOICE | 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_customer_update | 0 | INVOICE | Kliendi andmete osaline update, (nimi, email, telefon) või vastavalt spekile |
XML | xd_object | TEST_OBJEKT | INVOICE | Vaikimisi objekt, kui ei saadeta |
XML | xd_salesman | XML | INVOICE | Vaikimisi müüja |
XML | xd_stock | PL | INVOICE | Vaikimisi ladu, kui ei saadeta |
XML | xd_confirm | 0 | INVOICE | Automaatne dokumendi kinnitamine, seda saab ka juhtida XML väljaga „confirm“ |
XML | xd_posinvoice | 0 | INVOICE | 1 = kassaarve |
XML | xd_autocustomer | 0 | INVOICE | Automaatne seotud kliendi loomine, kui kliendi koodi ei eksisteeri |
Arve vaikimisi väärtuste seadistamiseks loe täpsemalt siit
Tellimused
what=order Skeem
Päis:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Tellimus | 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 |
customercode | klient_kood | Klient | mandatory by default! |
customername | klient_nimi | ALT.FROM: customer | |
date | aeg | Kuupäev | ALT.FROM: current time |
address1 | aadress1 | aadress, ! vastavalt seadetele | ALT.FROM: customer |
address2 | aadress2 | aadress, ! vastavalt seadetele | ALT.FROM: customer |
address3 | aadress3 | aadress, ! vastavalt seadetele | ALT.FROM: customer |
deliveryaddress1 | lahetusaadress1 | lähetusaadress, ! vastavalt seadetele | |
deliveryaddress2 | lahetusaadress2 | lähetusaadress, ! vastavalt seadetele | |
deliveryaddress3 | lahetusaadress3 | lähetusaadress, ! vastavalt seadetele | |
paymentterm | tingimus | T-ting | ALT.FROM: customer , kui on kasutusel laekumiste loomine, läheb see kood ka laekumise makseviisiks |
deliverymethod | lahetusviis | Lähetusviis | ALT.FROM: customer |
customerordernumber | kliendi_tellimus | Kliendi tell. nr. | |
meil | ALT.FROM: customer | ||
phone | telefon | Telefon | ALT.FROM: customer |
comment | kommentaar | Kommentaar | |
stock | ladu | Ladu | ALT.FROM: tr.params |
object | objekt | Objekt | ALT.FROM: tr.params |
contact | esindaja | Nende esindaja | ALT.FROM: customer |
datafield1 | lisa_field1 | Lisaväli 1, ! või vastavalt seadetele | |
datafield2 | lisa_field2 | Lisaväli 2, ! või vastavalt seadetele | |
datafield3 | lisa_field3 | Lisaväli 3, ! või vastavalt seadetele | |
datafield4 | lisa_field4 | Lisaväli 4, ! või vastavalt seadetele | |
datafield5 | lisa_field5 | Lisaväli 5, ! või vastavalt seadetele | |
datafield6 | lisa_field6 | Lisaväli 6, ! või vastavalt seadetele | |
datafield7 | lisa_field7 | Lisaväli 7, ! või vastavalt seadetele | |
paymenttotal | laekumine_summa | Positive number will create receipt with same doc. number. If receipt with this number already exists, receipt will not be created and no notification will be issued | |
vatzone | maa | Maa | local = 0, EU = 1, export = 2 , ALT.FROM: customer > 0 |
priceformula | hinnakiri | Hinnavalem | |
currency | valuuta | Valuuta | ALT.FROM: glob.settings > 'EUR' |
currencyrate | kurssbv1 | Kurss | ALT.FROM: ECB current published rates |
vatregno | kmregnumber | KM Reg. nr | ALT.FROM: customer |
country | asumaa | Sihtriik | ALT.FROM: customer |
status | staatus | Staatus | |
delivery | lahetusaeg | Lähetusaeg | |
customer_type | klient_tyyp | Kliendikaardil: Tüüp | company = 0, private citizen = 1, government institution = 2 |
customer_regno | klient_regnr | Kliendikaardil: Reg nr | |
customer_loyaltycard | klient_kliendikaart | Kliendikaardil: Kliendikaart | |
salesman | myyja | Müügiagent | ALT.FROM: tr.params > 'XML' |
project | projekt | Projekt | |
deliveryname | klient_nimi_lahetusel | Nimi lähetusel | |
factoring | arvetasub | Arve tasub | ALT.FROM: customer |
deliveryterm | lahetustingimus | Läh. ting. | |
language | keel | Keel | ALT.FROM: customer |
Read:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
item | artikkel | Artikkel | |
description | nimetus | Sisu | ALT.FROM: item |
price | yhikuhind | Ühikuhind | unit price without vat |
quantity | kogus | Kogus | |
discount | pross | % | |
account | konto | Konto | ALT.FROM: item > item class (depending on vatregion) |
vatcode | kmkood | KMk | ALT.FROM: customer > item > item class (depending on vatregion) |
unit | yhik | Ühik | ALT.FROM: item |
comment | r_kommentaar | Kommentaar | |
variant | variant | Variant | |
rsum | rsum | RSKM (kui on saadetud price/ühikuhind, siis rskm'i ei kasutata) | |
deliverytime | lahetusaeg | Lähetusaeg | |
stock | r_ladu | Ladu | |
project | projekt | Projekt | ALT.FROM: item > item class |
ext_sum | ext_sum | ||
ext_id | ext_id | ||
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 |
Tellimuse transpordi parameetrid
TÜÜP | KOOD | PARAMEETER 1 | PARAMEETER 2 | SELGITUS |
---|---|---|---|---|
XML | xd_stock | PL | ORDER | Vaikimisi ladu, kui ei saadeta |
XML | xd_object | VEEB | ORDER | Vaikimisi objekt, kui ei saadeta |
XML | xd_autocustomer | 1 | ORDER | Automaatne seotud kliendi loomine, kui kliendi koodi ei eksisteeri |
XML | xd_confirm | 0 | ORDER | Automaatne dokumendi kinnitamine, seda saab ka juhtida XML väljaga „confirm“ |
XML | xd_update | 1 | ORDER | Luba dokumendi update, kui puuduvad seotud dokumendid |
XML | xd_series | DOK | ORDER | 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_autocustomer_autocode | 0 | ORDER | Seotud kliendi loomisel luuakse kood liideses, unikaalne email on vajalik ja kliendi koodi süsteemiseadistused on vajalikud |
XML | xd_customer_update | 0 | ORDER | Kliendi andmete osaline update, (nimi, email, telefon) või vastavalt spekile |
XML | xd_uniqueid | kliendi_tellimus | ORDER | 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_salesman | XML | ORDER | Vaikimisi müüja |
XML | xd_confirmpayment | 1 | ORDER | Automaatne laekumise kinnitamine |
XML | xd_paymentvatcode | 11 | ORDER | Loodava seotud laekumise rea km kood, laekumine tekib välja „paymentamount“ saatmisel, mis peab skeemis olemas olema |
XML | xd_order_assemble | 1 | ORDER | Käivitab tellimuse komplekteerija retseptidega artiklitele |
Tellimuse vaikimisi väärtuste seadistamiseks loe täpsemalt siit
Laekumised
what=receipt Skeem
Päis:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Laekumine | 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 |
date | aeg | Aeg | ALT.FROM: current time |
description | seletus | Kommentaar | |
paymentmode | tasumisviis | Tas. viis | |
user | kasutaja | Kasutaja | |
reference | viide | Viide | |
object | objekt | Objekt | ALT.FROM: tr.params |
project | projekt | Projekt | ALT.FROM: tr.params |
location | arvuti | Koht | |
confirm | kinnita | confirm document = 1 |
read:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
invoice | arvenumber | Arve nr | |
aeg | raeg | Aeg | ALT.FROM: receipt header |
customer | klient_kood | Klient | ALT.FROM: invoice > order > customer by regno field |
order | ettemaks | Tellimuse nr | |
customername | klient_nimi | Tekst | ALT.FROM: invoice > order > customer by regno field |
payment | tasuti | Tasuti | ALT.FROM: in case of base currency = received field |
bankcurrency | valuuta_p | Val saadud | ALT.FROM: glob.settings > 'EUR' |
received | summa_p | Summa S | |
currencyrate | kurss_p | Kurss S | ALT.FROM: ECB current published rates |
paymentfee | teenustasu | T-Tasu | |
vatcode | kmk | KMk | ALT.FROM: tr.params |
paymentfeecurrency | valuuta_teenus | T-Tasu val. | |
description | selgitus | Selgitus | |
regno | reg | Reg number/IK | ALT.FROM: customer |
bankaccount | arveldusarve | Arveldusarve | |
objects | objektid | Objekt | ALT.FROM: invoice > order |
account | r_konto | Konto | |
fine | viivis | Viivis | |
rn | rn | Nr | row order number in document 1 - N , ALT.FROM: random |
Kanded
what=transaction Skeem
Päis:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Number | document number/ID, mandatory; With combination of field „type“ it must be unique for each document and remain same if more than one transaction of the same document is necessary |
date | aeg2 | Aeg | |
reference | viide | Viide | |
comment | seletus | Seletus | |
type | tyyp | Tüüp | ALT.: FIN |
read:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
account | konto | Konto | |
object | objekt | Objektid | |
description | sisu | Sisu | ALT.FROM: account |
vatcode | kmkood | KM kood | |
quantity | kogus | Kogus | |
debitamount | baas1deebet | Deebet | |
creditamount | baas1kreedit | Kreedit | |
currencydebit | valuutadeebet | Val. deebet | |
currencycredit | valuutakreedit | Val. kreedit | |
currencyrate | b1kursile | Kurss | ALT.FROM: ECB current published rates |
currency | valuuta | Valuuta | ALT.FROM: glob.settings > 'EUR' |
date | r_aeg | Aeg | |
supplier | hankija | Hankija | |
customer | klient | Klient | |
project | projekt | Projekt | |
rn | rn | Nr | row order number in document 1 - N , ALT.FROM: random |
Kliendid
- Postitamisel ja muutmisel on alati nõutud code ja email!
what=customer Skeem
Kliendid
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 | |
object | objekt | Objekt | |
address1 | aadress1 | aadress, ! vastavalt seadetele | |
address2 | aadress2 | aadress, ! vastavalt seadetele | |
address3 | aadress3 | aadress, ! vastavalt seadetele | |
deliveryaddress1 | lahaadress1 | aadress, ! vastavalt seadetele | |
deliveryaddress2 | lahaadress2 | aadress, ! vastavalt seadetele | |
deliveryaddress3 | lahaadress3 | aadress, ! vastavalt seadetele | |
county | maakond | Maakond | |
country | asumaa | Asumaa | |
contact | kontakt | Esindaja | |
phone | telefon | Telefon | |
Meil | mandatory | ||
regno | regnr | Reg nr | |
vatregno | kmregnr | Km reg nr | |
notice | margukiri | Märgukirjad | yes = 1 |
birthday | klient_synnipaev | Sünnipäev | |
gender | klient_sugu | Sugu | female = 1, male = 0 |
class | klass | Klass | |
type | klient_tyyp | Tüüp | company = 0, private citizen = 1, government institution = 2 |
loyaltycard | kliendikaart | Kliendikaart | also used for personal ID code |
deliveryname | nimi_lahetusel | Nimi lähetusel | |
deliverymode | lahetusviis | Läh. viis | |
alert | hoiatus | Hoiatus | |
factoring | arvetasub | Arve tasub | |
fax | faks | Faks | |
comment | kommentaar | Kommentaar | |
payterm | tingimus | Tas. ting. | |
vatzone | maa | KM maa | local = 0, EU = 1, export = 2 |
language | keel | Keel | |
salesman | myyja | Müüja | |
bank | pank | Pank | |
bankaccount | arveldusarve | A/a | |
url | URL | Url | |
status | staatus | Staatus | |
accountmanager | kliendihaldur | Haldur | |
dealtype | tehinguliik | Tehinguliik | |
creditlimit | limiit | Limiit | |
priceformula | hinnakiri | Hinnavalem | |
specialpriceformula | hinnavalem_eri | Eripakkumised | |
discount | ale | Soodus % | |
destination | sihtriik | Sihtriik | |
firstname | eesnimi | ||
lastname | perenimi | ||
vatcode | kmkood | KM kood | |
extcode | valine_kood | Väline kood | |
deliveryinvoice | lah_arve | Lähetus | Lähetus ja Arve = 1, Lähetus = 0 |
currency | valuuta | Valuuta | |
closed | suletud |
Lisaväljad:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
code | kood | ||
content | sisu | Sisu | |
param | param | Parameeter |
Kliendi transpordi parameetrid
TÜÜP | KOOD | PARAMEETER 1 | PARAMEETER 2 | SELGITUS |
---|---|---|---|---|
XML | xd_uniqueid | CUSTOMER | 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 |
Artiklid
- Artikli kaardi täitmisel liides täidab valjad vastavalt reeglitele Kohustuslikud väljad
what=item Skeem
Artiklid
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 | |
class | klass | Klass | |
barcode | ribakood | Ribakood | |
areacode | piirkonnakood | Päritolu | |
unit | yhik | Ühik | |
salesprice | baashind | Müügihind | without VAT |
accountlocal | konto_myyk | Müük Siseriiklik | |
accounteu | konto_myyk_EU | Müük EU | |
accountexport | konto_myyk_eksport | Müük Eksp | |
vatcode | KMkood | KM Siseriiklik | |
vatcodeeu | KMkood_EU | KM EU | |
vatcodeexport | KMkood_eksport | KM mitte EU | |
type | tyyp | Tüüp | ALT.FROM: tr.params, cannot be updated. 0=service; 1=stock item; 2=rental item |
minlevel | minimaaltase | Min tase | |
shelf | riiulikood | Riiul | |
weight | kaal | Kaal | |
volume | maht | Maht | |
warranty | garantii | Garantii | |
package1 | yhikumuut1 | Pakis 1 | |
package2 | yhikumuut2 | Pakis 2 | |
sntracking | SN_jalgimine | Seeria nr | cannot be updated. 0=without sn tracking; 1=serial no tracking; 2=batch no tracking |
cost | ostuhind | Ostuhind | |
object | objekt | Objekt | |
recipe | retsept | Retsept | |
recipetorows | retsept_ridadeks | Retsept ei asetu | |
alert | hoiatus | Hoiatus | |
closed | suletud | Suletud | closed = 1, open = 0 |
description | pikktekst | Kirjeldus | |
vatprice1 | hind_okonline | Lisahind 1 (customizable) | with local VAT |
vatprice2 | hind_delfi | Lisahind 2 (customizable) | with local VAT |
vatprice3 | soodus_hind1 | Soodushind 1 (customizable) | with local VAT |
vatprice4 | soodus_hind2 | Soodushind 2 -customizable) | with local VAT |
vatprice | hind_tavaline | Tavahind | ALT.FROM: salesprice + local vat |
priority | prioriteet | Prioriteet | |
url | url | URL | |
supplier | hankija_kood | Hankija | |
supplieritem | hankija_artikkel | Hank. artikkel | |
maxlevel | maksimaaltase | Max tase | |
abc | abc | ABC klass | |
cn8code | cn8_kood | CN8 kood | |
cnkogus | cnkogus | CN kogus | |
vatcodeeu2 | KMKood_EU2 | KM EU 2 | |
vatcodeeu3 | KMKood_EU3 | KM EU 3 | |
vatcodeconcern | KMKood_kontsern | KM kontsern | |
accounteu2 | konto_myyk_EU2 | Müük EU 2 | |
accounteu3 | konto_myyk_EU3 | Müük EU 3 | |
accountconcern | konto_myyk_kontsern | Müük kontsern | |
snclass | sn_klass | SN klass | |
normarrivaltime | norm_aeg | Norm saabumisaeg | |
replacement | asendus | Asendus | |
snrule | sn_reegel | SN reegel | |
project | projekt | Projekt | |
variants | variandid | Variant | cannot be updated. 0=no; 1=yes |
autosn | auto_sn | Auto SN | |
specialprice1 | kaibeta_hind1 | Artikli käibeta lisahind1 (customizable) | |
specialprice2 | kaibeta_hind2 | Artikli käibeta lisahind2 (customizable) | |
specialprice3 | kaibeta_hind3 | Artikli käibeta lisahind3 (customizable) | |
specialprice4 | kaibeta_hind4 | Artikli käibeta lisahind4 (customizable) | |
specialprice5 | kaibeta_hind5 | Artikli käibeta lisahind5 (customizable) | |
specialprice6 | kaibeta_hind6 | Artikli käibeta lisahind6 (customizable) | |
specialprice7 | kaibeta_hind7 | Artikli käibeta lisahind7 (customizable) | |
specialprice8 | kaibeta_hind8 | Artikli käibeta lisahind8 (customizable) | |
height | korgus | Kõrgus | |
width | laius | Laius | |
depth | sygavus | Sügavus | |
grossweight | kaal_bruto | Bruto kaal | |
giftcert | kinkekaart | Kinkekaart | |
manufacturer | tootja | Tootja |
Artiklid lisaväljad:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
code | kood | ||
content | sisu | Sisu | |
param | param | Parameeter |
Artiklid pakendid:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
class | pakendi_klass | Klass | |
type | pakendi_tyyp | Tüüp | |
height | korgus | Kõrgus | |
width | laius | Laius | |
length | pikkus | Pikkus | |
volume | maht | Maht | |
qty | kogus | Pak.kogus | |
packageweight | pakendi_kaal | Pakendi kaal | |
productweight | toote_kaal | Toote kaal | |
totalweight | kaal_kokku | KOKKU kaal | |
totalvolume | maht_kokku | KOKKU maht | |
barcode | ribakood | Ribakood | |
comment | kommentaar | Kommentaar | |
shelf | riiul | Riiul |
Artiklid - hankija artiklid:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
supplier | hankija | Hankija | |
supplieritem | hankija_artikkel | Hank. artikkel | |
name | nimi | Nimi | |
price | hind | Ostuhind | |
normarrivaltime | norm_aeg | Norm saabumisaeg | |
object | objekt | Objekt | |
variant | variant | Variant | |
varianta | varianta | VariantA - (customizable) | |
variantb | variantb | VariantB - (customizable) | |
variantc | variantc | VariantC - (customizable) | |
variantd | variantd | VariantD - (customizable) | |
variante | variante | VariantE - (customizable) | |
variantf | variantf | VariantF - (customizable) | |
variantg | variantg | VariantG - (customizable) | |
varianth | varianth | VariantH - (customizable) | |
salesprice | myygihind | Müügihind | without VAT |
sales | myyk | ALT.FROM: tr.params, cannot be updated , sales item = 1, supplier item = 0 |
Artiklid - minmax:
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
stock | ladu | Ladu | |
shelf | riiul | Riiul | |
variant | variant | Variant | |
minlevel | min_kogus | MIN | |
maxlevel | max_kogus | MAX |
Kliendi 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 |
Ostuarved
what=purchase Skeem
Päis
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Number | 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 |
date | aeg | Arve aeg | ALT.FROM: current time |
duedate | tas_aeg | Tas. aeg | |
sum | summa | Tasuda | sum with vat |
supplierinvoiceno | hankija_arve | Hankija arve | |
paymentterm | tingimus | Tas. ting. | ALT.FROM: supplier |
suppliercode | hankija_kood | Hankija | |
suppliername | hankija_nimi | ALT.FROM: supplier | |
bankaccount | pangakonto | ALT.FROM: supplier | |
reference | viide | Viitenumber | ALT.FROM: supplier |
transactiontime | kande_aeg | Op. aeg | |
creditaccount | kred_konto | Kred. konto | ALT.FROM: supplier > glob.settings |
factoring | arve_tasub | Arve tasub | |
currency | valuuta | Valuuta | ALT.FROM: glob.settings > 'EUR' |
currencyrate | kurssbv1 | Kurss | ALT.FROM: ECB current published rates |
vatzone | maa | KM Maa (peidetud väli) | local = 0, EU = 1, export = 2 , ALT.FROM: supplier > 0 |
comment | kommentaar | Kommentaar | |
vat | arvestatudkm | KM kokku | |
object | objekt | Objekt | ALT.FROM: supplier > tr.params |
bankcode | pangakood | Pangakood | |
creditpurchase | kredost | Kred. ost | |
purchaseorder | ostutellimus | Ostutellimus | |
project | projekt | Projekt | |
meil | ALT.FROM: supplier | ||
stockreceipt | sissetulek | Sissetulek | |
country | asumaa | Saatjariik | ALT.FROM: supplier |
prepayment | ettemaks | Ettemaks | |
status | staatus | Staatus | |
type | tyyp | Tüüp | |
dividedsum | jagatav_summa | Jagatav summa | |
vatdate | km_aeg | KM aeg | ALT.FROM: date > current time |
reclamation | reklamatsioon | Reklamatsioon | |
reclamationcomment | rekl_selgitus | Rekl. selgitus | |
asset | inventar | Inventar | |
datafield1 | lisa_field1 | ||
datafield2 | lisa_field2 | ||
datafield3 | lisa_field3 | ||
datafield4 | lisa_field4 | ||
datafield5 | lisa_field5 | ||
datafield6 | lisa_field6 | ||
datafield7 | lisa_field7 | ||
intcomment | sisekommentaar | Sisekommentaar | |
supplier_class | hankija_klass | Klass | |
supplier_vatcountry | hankija_maa_tasu | KM-maa | local = 0, EU = 1, export = 2 , ALT.FROM: customer > 0 |
supplier_regno | hankija_regnr1 | Reg nr 1 | |
supplier_vatregno | hankija_kmregnr | Km reg nr | |
supplier_type | hankija_tyyp | Tüüp | |
confirm | kinnita | Olek | „1“ - confirm document |
read
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
account | konto | Konto | |
object | objekt | Objekt | ALT.FROM: project |
name | sisu | Sisu | ALT.FROM: account |
linetotalwovat | summa | Summa | |
vatcode | kmkood | KMK | ALT.FROM: supplier > account > object |
project | projekt | Projekt | |
customer | klient_kood | Klient | |
item | artikkel | Artikkel | |
quantity | kogus | Kogus | |
date1 | r_aeg1 | Algus | |
date2 | r_aeg2 | Lõpp | |
contract | leping | Leping | |
user | kasutaja | Kasutaja | |
oid | oid | OID | |
orderrn | trn | ||
asset | r_inventar | Inventar | |
price | myygihind | Müügihind | |
constant1 | konstant1 | ||
constant2 | konstant2 | ||
constant3 | konstant3 | ||
constant4 | konstant4 | ||
text1 | tekst1 | ||
text2 | tekst2 | ||
text3 | tekst3 | ||
text4 | tekst4 | ||
intcomment | r_sisekommentaar | Sisekommentaar | |
vatsum | km | KM | |
rn | rn | Nr |
manused
XML väli | SQL väli | UI väli | Selgitus |
---|---|---|---|
name | attachment_name | ||
description | attachment_kirjeldus | ||
code | kood | for updating excisting attachments, do not send this field for new attachments | |
sharepoint_link | cloud_preview_query | external Sharepoint attachment link | |
gdrive_link | cloud_gdrive | external Google Drive attachment link | |
ext_link | cloud_ext_link | external attachment link, must be full external link starting with http:// |
Ostuarve transpordi parameetrid
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_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_update | 0 | PURCHASE | Luba dokumendi update, kui puuduvad seotud dokumendid |
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 | supplier_update | 0 | PURCHASE | Hankija andmete osaline update, (email, … ) väljad on vaja spekis täpsustada |
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“ |
Väljundid
Artiklid (Items)
- what=item Skeem
Filtrid: class,code,type,barcode,supplier,supplieritem,closed,ts
Kliendid (Customers)
- what=customer Skeem
Filtrid: code,loyaltycard,regno,email,phone,closed,ts
Laoseis (Stock levels)
- what=stocklevel Skeem
Filtrid: code,stock,ts
Hinnavalemi read (Price formula rows)
- what=priceformularow Skeem
Filtrid: class,code,type,barcode,supplier,supplieritem,closed,ts
Artikli klassid (Item classes)
- what=itemclass Skeem
Filtrid: code,master
Arved (Invoices)
- what=invoice Skeem
Filtrid: number,customercode,transactiondate,date1,date2,ts, ordernumber
Tellimused (Orders)
- what=order Skeem
Filtrid: number,date1,date2,ts, projekt, customerordernumber, stock, status
Finantskanded (Transactions)
- what=transaction Skeem
Filtrid: number,date1,date2,ts
Laekumised (Receipts)
- what=receipt Skeem
Filtrid: number,date1,date2,ts
Ostuarved (Purchase)
- what=purchase Skeem
Filtrid: number,date1,date2,supplier,confirmed,status,ts
Kustutatud dokumendid (Deleted documents )
- what=delete Skeem
Filtrid: number,code,document,ts