Külgriba
Sisujuht
Property Management Direct liides
Liides on mõeldud kinnisvara halduse lahenduse pakkujate (Real Estate Management / Property Management) liidestamiseks.
Lahenduse eripärad, võttes arvesse Directo loogikat, on seotud kinnisvarahaldurite klientidega. Kui Directos on iga kinnisvaraobjekt eraldi baas, siis kinnisvaras on see eraldi objekt ning kliendid on ühised. Samas on Diretos võimalik ka olukord, kus sama klient on erinevates baasides erineva kliendikoodiga. Ainus ühine osa on ettevõtte reg.nr. ning eraisikutel isikukood. Seetõttu on oluline et reg.nr ja isikukoodid ei oleks directo baasis topelt!
Klientide loomine/haldamine käib tüüpiliselt kinnisvara platvormil - lisab uued kliendid läbi liidese (kliendid sisend) või kontrollib kliendi olemasolu reg.nr. järgi (kliendid väljund).
Hind
Hind ühe baasi kohta vastavalt hinnakirjale
Hind sisaldab:
- paigaldust
- standardliidese komponendid:
- ostuarved väljund
- kliendid sisend
- kliendid väljund
- arvete sisend
- liidese täiendused (standardi täiendused)
Ühispöördumispunkt
Liidesele ligipääs käib POST meetodil, form/urlencoded järgneva URL'i suhtes: https://login.directo.ee/xmlcore/PropManag/xmlcore.asp
Ligipääsu tagamiseks 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“/>
Testimine
Test web liides https://login.directo.ee/xmlcore/PropManag/webupload.html
Liidese komponendid
Üldine
Väljundliidesed näitavad kõiki kirjeid ning piiranguid saab teha päringu filtritega!
Arvete sisend
Skeem: https://login.directo.ee/xmlcore/propmanag/xml_IN_arved.xsd
what=invoice
put=1
Tegevused
- lisamine
- muutmine
Erisused
- Kliendi koodi asemel võib saata ettevõtte registri numbri. Registi numbri järgi leitakse tegelik kliendi kood
- Kustutamised tuleb teha Directo UI's
- Kui ei postitata kas
pricevõisumvälja, siis tuleb kontrollida Directo seadistustArve rea summa või ühiku arvutamine salvestamiselning muuta korrektseks - Kontrolli seadistust
Arve on vaikimisi ladumuutev, kuna vaikimisi peaks olema tegu mitte ladumuutvate arvetega.
Transpordi parameetrid häälestamine
Võimalikud transpordi parameetrid:
| TÜÜP | KOOD | PARAMEETER 1 | PARAMEETER 2 | Kirjeldus |
|---|---|---|---|---|
| XML | md_changestock | 0 | INVOICE | ladumuutev arve (Param.1 =1 on muuda ladu) |
| XML | md_uniqueid | lisa_field7 | 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 | md_autocustomer_autocode | 0 | INVOICE | Seotud kliendi loomisel luuakse kood liideses, unikaalne email on vajalik ja kliendi koodi süsteemiseadistused on vajalikud |
| XML | md_update | 1 | INVOICE | Luba dokumendi update, kui puuduvad seotud dokumendid |
| XML | md_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 | md_object | OBJEKT | INVOICE | Vaikimisi objekt, kui ei saadeta |
| XML | md_stock | PL | INVOICE | Vaikimisi ladu, kui ei saadeta |
| XML | md_confirm | 0 | INVOICE | Automaatne dokumendi kinnitamine, seda saab ka juhtida XML väljaga „confirm“ |
| XML | md_autocustomer | 0 | INVOICE | Automaatne seotud kliendi loomine, kui kliendi koodi ei eksisteeri |
| XML | md_2_salesman | TEST | INVOICE | Vaikimisi müüja |
Oluline md_update parameeter mida on enamus juhtudel vaja. Täpsustada see koostöös partneriga.
Arved 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 |
| ordernumber | tellimusenr | Tell. nr. | |
| object | objekt | Objekt | ALT.FROM: tr.params |
| project | projekt | Projekt | |
| customercode | klient_kood | Klient | mandatory by default! |
| customername | klient_nimi | ALT.FROM: customer | |
| orderer_code | klient_tellija | Tellija | |
| comment | kommentaar | Kommentaar | |
| intcomment | sisekommentaar | Sisekommentaar | |
| salesman | myyja | Müügiagent | ALT.FROM: tr.params > 'XML' |
| 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 | |
| contractnumber | leping | Leping | |
| status | staatus | Staatus | |
| confirm | kinnita | „1“ - confirm document | |
| stock | ladu | Ladu | ALT.FROM: tr.params |
| customer_regno | klient_regnr | Kliendikaardil: Reg nr |
Arved read:
| XML väli | SQL väli | UI väli | Selgitus |
|---|---|---|---|
| item | artikkel | Artikkel | |
| description | seletus | Sisu | ALT.FROM: item |
| 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 | |
| project | projekt | Projekt | |
| vatcode | kmk | KMk | ALT.FROM: customer > item > item class (depending on vatregion) |
| comment | r_kommentaar | Kommentaar | |
| salesman | r_myyja | Müüja | |
| stock | r_ladu | Ladu | |
| text1 | tekst1 | Tekst1 | |
| text2 | tekst2 | Tekst2 | |
| text3 | tekst3 | Tekst3 | |
| text4 | tekst4 | Tekst4 | |
| 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 |
Ostuarvete väljund
Skeem: https://login.directo.ee/xmlcore/propmanag/ws_oarved.xsd
what=purchase
get=1
Filter „number“,„date1“,„date2“,„supplier“,„confirmed“,„ts“
Ostu arved päis:
| XML väli | SQL väli | UI väli | Selgitus |
|---|---|---|---|
| number | number | ||
| supplier | hankija_kood | ||
| supplier_name | hankija_nimi | ||
| date | aeg | ||
| total | summa | ||
| payterm | tingimus | ||
| duedate | tas_aeg | ||
| transactiondate | kande_aeg | ||
| comment | kommentaar | ||
| supplierinvoicenumber | hankija_arve | ||
| object | objekt | ||
| currency | valuuta | ||
| currencyreate | kurssbv1 | ||
| confirmed | kinnitatud | ||
| ts | ts |
Ostu arved read:
| XML väli | SQL väli | UI väli | Selgitus |
|---|---|---|---|
| item | artikkel | ||
| object | objekt | ||
| project | projekt | ||
| description | sisu | ||
| amount | summa | ||
| vat | km | ||
| vatcode | kmkood | ||
| customer | klient_kood | ||
| qty | kogus | ||
| rn | rn |
Ostu arved menetlused:
| XML väli | SQL väli | UI väli | Selgitus |
|---|---|---|---|
| user | kasutaja | ||
| signature | allkiri_cu | ||
| signaturedate | allkiri_ts | ||
| signaturestatus | vastatud | 1 - allkirjastatud; 2 - keeldutud | |
| comment | kommentaar | ||
| user_name | kasutaja_nimi | ||
| signature_name | allkiri_nimi |
Kliendid
Kliendid väljund
Skeem: https://login.directo.ee/xmlcore/propmanag/ws_kliendid.xsd
what=customer
get=1
Filter „code“,„loyaltycard“,„regno“,„email“,„phone“,„closed“,„ts“
| XML väli | SQL väli | UI väli | Selgitus |
|---|---|---|---|
| code | kood | Kood | |
| 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 | |||
| regno | regnr | Reg nr | |
| vatregno | kmregnr | Km reg nr | |
| 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 | |
| fax | faks | Faks | |
| comment | kommentaar | Kommentaar | |
| payterm | tingimus | Tas. ting. | |
| vatregion | maa | Maa | local = 0, EU = 1, export = 2 |
| language | keel | Keel | |
| salesman | myyja | Müüja | |
| status | staatus | Staatus | |
| accountmanager | kliendihaldur | Haldur | |
| destination | sihtriik | Sihtriik | |
| firstname | eesnimi | ||
| lastname | perenimi | ||
| vatcode | kmkood | KM kood | |
| referenceno | viitenumber | ||
| closed | suletud | Suletud | closed = 1 |
| cu | cu | Viimati muutis | document last changed by |
| ts | ts | document last changed |
kliendid lisa:
| XML väli | SQL väli | UI väli | Selgitus |
|---|---|---|---|
| code | kood | ||
| content | sisu | ||
| param | param |
Kliendid sisend
Skeem: https://login.directo.ee/xmlcore/propmanag/xml_IN_kliendid.xsd
what=customer
put=1
Tegevused
- lisamine
- muutmine
Erisused
- Kliendi lisamine registrikoodi järgi - kui kliendi kood on teadmata, siis kasutada välja ext_unique_id, kuhu panna registri number.
- Kliendi update registrikoodi järgi
- VATZone on vaikimisi siseriiklik (0)
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! | |
| ext_unique_id | ext_unique_id | ! vastavalt seadetele | if Directo number/code is not used, this is alternative ID; It must be unique for each document and remain same if more than one transaction of the same document is necessary |
| 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 , Kas on võimalik et saadetakse ilma koodita vaid ainult reg.nr ja selle järgi toimub update või insert. Insert puhul on vaja kood |
| 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 , Võimalik lisada mitu meili aadressi semikooloniga eraldatud | ||
| 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 , Vaikimisi siseriiklik (0) |
| 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 | |
| closed | suletud |
Kliendid lisa:
| XML väli | SQL väli | UI väli | Selgitus |
|---|---|---|---|
| code | kood | ||
| content | sisu | Sisu | |
| param | param | Parameeter |
Lehekülje tarvikud
