This is an old revision of the document!
Table of Contents
This page is not fully translated, yet. Please help completing the translation.
(remove this paragraph once the translation is finished)
XML Direct
Introduction
Introduction XML Direct is a standardized integration interface designed to provide seamless, structured access to business-critical data through a single unified endpoint. The interface is modular and configurable, allowing organizations to select only the components relevant to their needs.
All components within the XML Direct interface follow a fixed field structure, ensuring a uniform data format across all Directo customer environments. This common structure enables faster implementation and easier maintenance, as no customer-specific development is required.
Key Features
- Modular Architecture: Components (e.g., customers, invoices, inventory) can be enabled individually according to specific integration requirements.
- Uniform Data Format: Field definitions and data structure are standardized across all implementations, minimizing inconsistencies.
- Shared Development Model: Enhancements and updates are applied centrally and benefit all users, with no need for client-specific customization.
- Secure Access via API Keys:
- Multiple API keys can be generated and assigned to different partners.
- Each API key can be restricted to access only specific components.
- This provides enhanced flexibility and data security.
Implementation Considerations
Prior to implementation, it is essential to:
- Define the scope of integration.
- Identify the required components.
- Ensure the technical partner has access to the necessary documentation and authentication details.
Once agreed upon, activating the XML Direct interface is straightforward and does not require any Directo-side development or configuration.
API Key
To find the interface XML key and provide it to the developer:
- Log in to Directo with a user who has
SUPER
rights - Go to the
XML interfaces
section
Access to the Interface (URL)
Access to the interface is via the POST method, form/urlencoded, to the following URL: https://login.directo.ee/xmlcore/cap_xml_direct/xmlcore.asp
A token must be used for access (see the API Key
obtained in the previous chapter). The token replaces the older interface types' appkey and database name all at once. The token must be sent via the POST method in the TOKEN
variable (similar to submitting an HTML form) to the given URL to get a result. In case of an incorrect or improperly sent token, the response is <result type=„5“ desc=„Unauthorized“/>
. In case token is missing the response is <err>token required</err>
.
curl example
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'
Price
The price depends on the selected components.
The output of deleted documents is included in the price and is free of charge.
The price for an additional API key is €0 per month.
If multiple API keys have the same components, the fee for them is charged only once.
Example:
- API key A contains outputs: customer and item
- API key B contains outputs: customer and order
→ In this case, the fee is only for three unique components: customer, item, and order.
Testing
XML Direct interface testing link https://login.directo.ee/xmlcore/cap_xml_direct/webupload.html
General
- Output interfaces show all records, and restrictions can be made with query filters!
- The functionality of input interfaces can be controlled with
TRANSPORT PARAMETERS
- please read more about the Transport Parameters of the input component. By default, a transport parameter with an empty or '0' value is not required. - Some inputs also support setting default values.
Components
Selectable components
Component (what) | Input \ (put=1) | Output \ (get=1) |
---|---|---|
Orders (order) | x | x |
Invoices (invoice ) | x | x |
Receipts (receipt) | x | x |
Customers (customer) | x | x |
Suppliers (supplier) | x | x |
Items (item) | x | x |
Items:Stock Limits (itemstocklimit) | x | |
Items:Packages (itempackage) | x | |
Items:Related Items (itemrelitem) | x | |
Item classes (itemclass) | x | |
Stock level (stocklevel) | x | |
Stock level with serial numbers (stocklevel_sn) | x | |
Stock level with variants (stocklevel_variant) | x | |
Price formula rows (priceformularow) | x | |
Purchase invoices (purchase) | x | x |
Financial transactions (transaction) | x | x |
Resources (resource) | x | x |
Deleted documents | x |
Inputs
Invoices
what=invoice Schema
Header:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Invoice | 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 | Date | ALT.FROM: current time |
duedate | aeg2 | Due date | ALT.FROM: paymentterm |
transactiondate | kande_aeg | ||
vatzone | maa | VAT zone | local = 0, EU = 1, export = 2 , ALT.FROM: customer > 0 |
paymentterm | tingimus | P-term | ALT.FROM: customer , if receipt creation is used, this code also becomes the payment method of the receipt |
ordernumber | tellimusenr | Order no. | |
latepaymentpenalty | viivis | Late payment penalty | ALT.FROM: customer |
object | objekt | Object | ALT.FROM: tr.params |
project | projekt | Project | |
account | konto | Debt account | |
country | asumaa | Destination country | ALT.FROM: customer |
currency | valuuta | Currency | ALT.FROM: glob.settings > 'EUR' |
currencyrate | kurssbv1 | Rate | ALT.FROM: ECB current published rates |
customercode | klient_kood | Customer | mandatory by default! |
customername | klient_nimi | ALT.FROM: customer | |
orderer_code | klient_tellija | ||
contact | esindaja | Their representative | ALT.FROM: customer |
comment | kommentaar | Comment | |
intcomment | sisekommentaar | Internal comment | |
salesman | myyja | Sales agent | ALT.FROM: tr.params > 'XML' |
language | keel | Language | ALT.FROM: customer |
customerordernumber | klienditellimus | Customer's order no. | |
ALT.FROM: customer | |||
address1 | aadress1 | address, ! according to settings | ALT.FROM: customer |
address2 | aadress2 | address, ! according to settings | ALT.FROM: customer |
address3 | aadress3 | address, ! according to settings | ALT.FROM: customer |
phone | telefon | Phone | ALT.FROM: customer |
fax | faks | Fax | |
deliveryname | klientnimi_lahetusel | Name on delivery | |
deliveryaddress1 | lahetusaadress1 | delivery address, ! according to settings | |
deliveryaddress2 | lahetusaadress2 | delivery address, ! according to settings | |
deliveryaddress3 | lahetusaadress3 | delivery address, ! according to settings | |
priceformula | hinnakiri | Price formula | |
vatregno | kmregnumber | VAT Reg. no | ALT.FROM: customer |
datafield1 | lisa_field1 | Add. field 1, ! or according to settings | |
datafield2 | lisa_field2 | Add. field 2, ! or according to settings | |
datafield3 | lisa_field3 | Add. field 3, ! or according to settings | |
datafield4 | lisa_field4 | Add. field 4, ! or according to settings | |
datafield5 | lisa_field5 | Add. field 5, ! or according to settings | |
datafield6 | lisa_field6 | Add. field 6, ! or according to settings | |
datafield7 | lisa_field7 | Add. field 7, ! or according to settings | |
quotation | pakkumine | Offer | |
contractnumber | leping | Contract | |
prepayment | ettemaksu_arve | 1 for prepayment invoice, 0 for regular invoice | |
type | tyyp | ||
status | staatus | Status | |
paymenttotal | laekumine_summa | |
|
confirm | kinnita | “1” - confirm document | |
stock | ladu | Stock | ALT.FROM: tr.params |
creditedinvoice | kredarve | Credit invoice | |
asset | inventar | Asset | |
dealtype | tehinguliik | Transaction type | |
delivery | lahetusaeg | Delivery time | |
deliveryterm | lahetustingimus | Deliv. term. | ALT.FROM: customer |
deliverytermcomment | lahetustingimus_komm | Deliv. term. | |
deliverymethod | lahetusviis | Delivery method | |
deliverymethodcomment | lahetusviis_komm | Delivery method | |
manager | haldur | Responsible person | |
changestock | muudaladu | stock changing invoice = 1 | |
customer_type | klient_tyyp | On customer card: Type | company = 0, private citizen = 1, government institution = 2 |
customer_regno | klient_regnr | On customer card: Reg no | |
customer_class | klient_klass | On customer card: Class | |
customer_loyaltycard | klient_kliendikaart | On customer card: Loyalty card |
rows:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
item | artikkel | Item | |
description | seletus | Content | ALT.FROM: item |
variant | variant | Variant | |
price | hind | Unit price | unit price without vat |
discount | pross | % | |
quantity | kogus | Quantity | |
unit | yhik | Unit | ALT.FROM: item |
sum | summa | Sum | |
account | konto | Account | ALT.FROM: item > item class (depending on vatregion) |
object | objektid | Object | ALT.FROM: item > item class |
project | projekt | Project | ALT.FROM: item > item class |
purchaseprice | kulu | Purchase price | ALT.FROM: item |
vatcode | kmk | VAT code | ALT.FROM: customer > item > item class (depending on vatregion) |
comment | r_kommentaar | Comment | |
date1 | r_aeg1 | ||
date2 | r_aeg2 | ||
salesman | r_myyja | Salesperson | |
order | tellimus | ||
orderrow | trn | ||
stock | r_ladu | Stock | |
sn | seerianumber | Serial no. | |
deliverytime | lahetusaeg | Delivery time | |
customer | r_klient | Customer | |
customername | r_klient_nimi | Customer name | |
text1 | tekst1 | Text1 | |
text2 | tekst2 | Text2 | |
text3 | tekst3 | Text3 | |
text4 | tekst4 | Text4 | |
constant1 | konstant1 | Constant1 | |
constant2 | konstant2 | Constant2 | |
constant3 | konstant3 | Constant3 | |
constant4 | konstant4 | Constant4 | |
shelf | riiul | Shelf | |
rn | rn | No. | row order number in document 1 - N , ALT.FROM: random |
rr | rv | Rr | row reference for grouping, otherwise equals to rn , ALT.FROM: equals to rn |
Invoice transport parameters
TYPE | CODE | PARAMETER 1 | PARAMETER 2 | EXPLANATION |
---|---|---|---|---|
XML | xd_changestock | 0 | INVOICE | Stock changing invoice (Param.1 =1 means change stock) |
XML | xd_autocustomer_autocode | 0 | INVOICE | When creating a related customer, the code is created in the interface, a unique email is required and system settings for customer codes are necessary |
XML | xd_update | 1 | INVOICE | Allow document update if there are no related documents |
XML | xd_customer_update | 0 | INVOICE | Partial update of customer data (name, email, phone) or according to spec |
XML | xd_object | TEST_OBJECT | INVOICE | Default object if not sent |
XML | xd_salesman | XML | INVOICE | Default salesperson |
XML | xd_stock | PL | INVOICE | Default stock if not sent |
XML | xd_confirm | 0 | INVOICE | Automatic document confirmation, can also be controlled with the “confirm” XML field |
XML | xd_posinvoice | 0 | INVOICE | 1 = POS invoice |
XML | xd_autocustomer | 0 | INVOICE | Automatic creation of a related customer if the customer code does not exist |
To configure default invoice values, read more here
Orders
what=order Schema
Header:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Order | 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 | Customer | mandatory by default! |
customername | klient_nimi | ALT.FROM: customer | |
date | aeg | Date | ALT.FROM: current time |
address1 | aadress1 | address, ! according to settings | ALT.FROM: customer |
address2 | aadress2 | address, ! according to settings | ALT.FROM: customer |
address3 | aadress3 | address, ! according to settings | ALT.FROM: customer |
deliveryaddress1 | lahetusaadress1 | delivery address, ! according to settings | |
deliveryaddress2 | lahetusaadress2 | delivery address, ! according to settings | |
deliveryaddress3 | lahetusaadress3 | delivery address, ! according to settings | |
paymentterm | tingimus | P-term | ALT.FROM: customer , if receipt creation is used, this code also becomes the payment method of the receipt |
deliverymethod | lahetusviis | Delivery method | ALT.FROM: customer |
customerordernumber | kliendi_tellimus | Customer's order no. | |
ALT.FROM: customer | |||
phone | telefon | Phone | ALT.FROM: customer |
comment | kommentaar | Comment | |
stock | ladu | Stock | ALT.FROM: tr.params |
object | objekt | Object | ALT.FROM: tr.params |
contact | esindaja | Their representative | ALT.FROM: customer |
datafield1 | lisa_field1 | Add. field 1, ! or according to settings | |
datafield2 | lisa_field2 | Add. field 2, ! or according to settings | |
datafield3 | lisa_field3 | Add. field 3, ! or according to settings | |
datafield4 | lisa_field4 | Add. field 4, ! or according to settings | |
datafield5 | lisa_field5 | Add. field 5, ! or according to settings | |
datafield6 | lisa_field6 | Add. field 6, ! or according to settings | |
datafield7 | lisa_field7 | Add. field 7, ! or according to settings | |
paymenttotal | laekumine_summa | |
|
vatzone | maa | Zone | local = 0, EU = 1, export = 2 , ALT.FROM: customer > 0 |
priceformula | hinnakiri | Price formula | |
currency | valuuta | Currency | ALT.FROM: glob.settings > 'EUR' |
currencyrate | kurssbv1 | Rate | ALT.FROM: ECB current published rates |
vatregno | kmregnumber | VAT Reg. no | ALT.FROM: customer |
country | asumaa | Destination country | ALT.FROM: customer |
status | staatus | Status | |
delivery | lahetusaeg | Delivery time | |
customer_type | klient_tyyp | On customer card: Type | company = 0, private citizen = 1, government institution = 2 |
customer_regno | klient_regnr | On customer card: Reg no | |
customer_loyaltycard | klient_kliendikaart | On customer card: Loyalty card | |
salesman | myyja | Sales agent | ALT.FROM: tr.params > 'XML' |
project | projekt | Project | |
deliveryname | klient_nimi_lahetusel | Name on delivery | |
factoring | arvetasub | Invoice paid by | ALT.FROM: customer |
deliveryterm | lahetustingimus | Deliv. term. | |
language | keel | Language | ALT.FROM: customer |
Rows:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
item | artikkel | Item | |
description | nimetus | Content | ALT.FROM: item |
price | yhikuhind | Unit price | unit price without vat |
quantity | kogus | Quantity | |
discount | pross | % | |
account | konto | Account | ALT.FROM: item > item class (depending on vatregion) |
vatcode | kmkood | VAT code | ALT.FROM: customer > item > item class (depending on vatregion) |
unit | yhik | Unit | ALT.FROM: item |
comment | r_kommentaar | Comment | |
variant | variant | Variant | |
deliverytime | lahetusaeg | Delivery time | |
stock | r_ladu | Stock | |
project | projekt | Project | ALT.FROM: item > item class |
ext_sum | ext_sum | ||
ext_id | ext_id | ||
rn | rn | No. | row order number in document 1 - N , ALT.FROM: random |
rr | rv | Rr | row reference for grouping, otherwise equals to rn , ALT.FROM: equals to rn |
Order transport parameters
TYPE | CODE | PARAMETER 1 | PARAMETER 2 | EXPLANATION |
---|---|---|---|---|
XML | xd_stock | PL | ORDER | Default stock, if not sent |
XML | xd_object | VEEB | ORDER | Default object, if not sent |
XML | xd_autocustomer | 1 | ORDER | Automatic creation of a related customer if the customer code does not exist |
XML | xd_confirm | 0 | ORDER | Automatic document confirmation, this can also be controlled with the XML field “confirm” |
XML | xd_update | 1 | ORDER | Allow document update if there are no related documents |
XML | xd_autocustomer_autocode | 0 | ORDER | When creating a related customer, the code is created in the interface, a unique email is required and system settings for customer codes are necessary |
XML | xd_customer_update | 0 | ORDER | Partial update of customer data, (name, email, phone) or according to spec |
XML | xd_salesman | XML | ORDER | Default salesperson |
XML | xd_confirmpayment | 1 | ORDER | Automatic receipt confirmation |
XML | xd_paymentvatcode | 11 | ORDER | VAT code for the created related receipt row, receipt is generated upon sending the “paymentamount” field, which must exist in the schema |
XML | xd_order_assemble | 1 | ORDER | Triggers the order assembler for items with recipes |
To configure default order values, read more here
Receipts
what=receipt Schema
Header:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
number | number | Receipt | 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 | Time | ALT.FROM: current time |
description | seletus | Comment | |
paymentmode | tasumisviis | Paym. method | |
user | kasutaja | User | |
reference | viide | Reference | |
object | objekt | Object | ALT.FROM: tr.params |
project | projekt | Project | ALT.FROM: tr.params |
location | arvuti | Location | |
confirm | kinnita | confirm document = 1 |
rows:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
invoice | arvenumber | Invoice no | |
aeg | raeg | Time | ALT.FROM: receipt header |
customer | klient_kood | Customer | ALT.FROM: invoice > order > customer by regno field |
order | ettemaks | Order No. | |
customername | klient_nimi | Text | ALT.FROM: invoice > order > customer by regno field |
payment | tasuti | Paid | ALT.FROM: in case of base currency = received field |
bankcurrency | valuuta_p | Curr. received | ALT.FROM: glob.settings > 'EUR' |
received | summa_p | Amount R | |
currencyrate | kurss_p | Rate R | ALT.FROM: ECB current published rates |
paymentfee | teenustasu | S-Fee | |
vatcode | kmk | VAT code | ALT.FROM: tr.params |
paymentfeecurrency | valuuta_teenus | S-Fee curr. | |
description | selgitus | Explanation | |
regno | reg | Reg number/PC | ALT.FROM: customer |
bankaccount | arveldusarve | Bank account | |
objects | objektid | Object | ALT.FROM: invoice > order |
account | r_konto | Account | |
fine | viivis | Penalty | |
rn | rn | No. | row order number in document 1 - N , ALT.FROM: random |
Transactions
what=transaction Schema
Header:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
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 | Time | |
reference | viide | Reference | |
comment | seletus | Explanation | |
type | tyyp | Type | ALT.: FIN |
rows:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
account | konto | Account | |
object | objekt | Objects | |
description | sisu | Content | ALT.FROM: account |
vatcode | kmkood | VAT code | |
quantity | kogus | Quantity | |
debitamount | baas1deebet | Debit | |
creditamount | baas1kreedit | Credit | |
currencydebit | valuutadeebet | Curr. debit | |
currencycredit | valuutakreedit | Curr. credit | |
currencyrate | b1kursile | Rate | ALT.FROM: ECB current published rates |
currency | valuuta | Currency | ALT.FROM: glob.settings > 'EUR' |
date | r_aeg | Time | |
supplier | hankija | Supplier | |
customer | klient | Customer | |
project | projekt | Project | |
rn | rn | No. | row order number in document 1 - N , ALT.FROM: random |
Customers
- When posting and modifying, code and email are always required!
what=customer Schema
Customers
XML field | SQL field | UI field | Explanation |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
code | kood | Code | 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 | Name | |
object | objekt | Object | |
address1 | aadress1 | address, ! according to settings | |
address2 | aadress2 | address, ! according to settings | |
address3 | aadress3 | address, ! according to settings | |
deliveryaddress1 | lahaadress1 | address, ! according to settings | |
deliveryaddress2 | lahaadress2 | address, ! according to settings | |
deliveryaddress3 | lahaadress3 | address, ! according to settings | |
county | maakond | County | |
country | asumaa | Country | |
contact | kontakt | Representative | |
phone | telefon | Phone | |
mandatory | |||
regno | regnr | Reg no | |
vatregno | kmregnr | VAT reg no | |
notice | margukiri | Notices | yes = 1 |
birthday | klient_synnipaev | Birthday | |
gender | klient_sugu | Gender | female = 1, male = 0 |
class | klass | Class | |
type | klient_tyyp | Type | company = 0, private citizen = 1, government institution = 2 |
loyaltycard | kliendikaart | Loyalty card | also used for personal ID code |
deliveryname | nimi_lahetusel | Name on delivery | |
deliverymode | lahetusviis | Deliv. method | |
alert | hoiatus | Warning | |
factoring | arvetasub | Invoice paid by | |
fax | faks | Fax | |
comment | kommentaar | Comment | |
payterm | tingimus | Pay. term. | |
vatzone | maa | VAT zone | local = 0, EU = 1, export = 2 |
language | keel | Language | |
salesman | myyja | Salesperson | |
bank | pank | Bank | |
bankaccount | arveldusarve | Acct. no | |
url | URL | Url | |
status | staatus | Status | |
accountmanager | kliendihaldur | Manager | |
dealtype | tehinguliik | Transaction type | |
creditlimit | limiit | Limit | |
priceformula | hinnakiri | Price formula | |
specialpriceformula | hinnavalem_eri | Special offers | |
discount | ale | Discount % | |
destination | sihtriik | Destination | |
firstname | eesnimi | ||
lastname | perenimi | ||
vatcode | kmkood | VAT code | |
extcode | valine_kood | External code | |
deliveryinvoice | lah_arve | Shipment | Shipment and Invoice = 1, Shipment = 0 |
currency | valuuta | Currency | |
closed | suletud |
Additional fields:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
code | kood | ||
content | sisu | Content | |
param | param | Parameter |
Customer transport parameters
TYPE | CODE | PARAMETER 1 | PARAMETER 2 | EXPLANATION |
---|
Suppliers
- When posting and modifying, code is always required!
what=supplier Schema
suppliers:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
code | kood | Code | 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 | Name | |
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 | ||
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 |
suppliers additional fields:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
code | kood | ||
content | sisu | Content | |
param | param | Parameter |
Items
- When filling out the item card, the interface fills the fields according to the rules mandatory
what=item Schema
Items
XML field | SQL field | UI field | Explanation |
---|---|---|---|
session_id | x | for internal use at Directo side, do not send this field! | |
code | kood | Code | 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 | Name | |
class | klass | Class | |
barcode | ribakood | Barcode | |
areacode | piirkonnakood | Origin | |
unit | yhik | Unit | |
salesprice | baashind | Sales price | without VAT |
accountlocal | konto_myyk | Sales Domestic | |
accounteu | konto_myyk_EU | Sales EU | |
accountexport | konto_myyk_eksport | Sales Exp | |
vatcode | KMkood | VAT Domestic | |
vatcodeeu | KMkood_EU | VAT EU | |
vatcodeexport | KMkood_eksport | VAT non-EU | |
type | tyyp | Type | ALT.FROM: tr.params, cannot be updated. 0=service; 1=stock item; 2=rental item |
minlevel | minimaaltase | Min level | |
shelf | riiulikood | Shelf | |
weight | kaal | Weight | |
volume | maht | Volume | |
warranty | garantii | Warranty | |
package1 | yhikumuut1 | In package 1 | |
package2 | yhikumuut2 | In package 2 | |
sntracking | SN_jalgimine | Serial no. | cannot be updated. 0=without sn tracking; 1=serial no tracking; 2=batch no tracking |
cost | ostuhind | Purchase price | |
object | objekt | Object | |
recipe | retsept | Recipe | |
recipetorows | retsept_ridadeks | Recipe does not apply | |
alert | hoiatus | Warning | |
closed | suletud | Closed | closed = 1, open = 0 |
description | pikktekst | Description | |
vatprice1 | hind_okonline | Add. price 1 (customizable) | with local VAT |
vatprice2 | hind_delfi | Add. price 2 (customizable) | with local VAT |
vatprice3 | soodus_hind1 | Discount price 1 (customizable) | with local VAT |
vatprice4 | soodus_hind2 | Discount price 2 -customizable) | with local VAT |
vatprice | hind_tavaline | Regular price | ALT.FROM: salesprice + local vat |
priority | prioriteet | Priority | |
url | url | URL | |
supplier | hankija_kood | Supplier | |
supplieritem | hankija_artikkel | Supp. item | |
maxlevel | maksimaaltase | Max level | |
abc | abc | ABC class | |
cn8code | cn8_kood | CN8 code | |
cnkogus | cnkogus | CN quantity | |
vatcodeeu2 | KMKood_EU2 | VAT EU 2 | |
vatcodeeu3 | KMKood_EU3 | VAT EU 3 | |
vatcodeconcern | KMKood_kontsern | VAT concern | |
accounteu2 | konto_myyk_EU2 | Sales EU 2 | |
accounteu3 | konto_myyk_EU3 | Sales EU 3 | |
accountconcern | konto_myyk_kontsern | Sales concern | |
snclass | sn_klass | SN class | |
normarrivaltime | norm_aeg | Normal arrival time | |
replacement | asendus | Replacement | |
snrule | sn_reegel | SN rule | |
project | projekt | Project | |
variants | variandid | Variant | cannot be updated. 0=no; 1=yes |
autosn | auto_sn | Auto SN | |
specialprice1 | kaibeta_hind1 | Item add. price w/o VAT 1 (customizable) | |
specialprice2 | kaibeta_hind2 | Item add. price w/o VAT 2 (customizable) | |
specialprice3 | kaibeta_hind3 | Item add. price w/o VAT 3 (customizable) | |
specialprice4 | kaibeta_hind4 | Item add. price w/o VAT 4 (customizable) | |
specialprice5 | kaibeta_hind5 | Item add. price w/o VAT 5 (customizable) | |
specialprice6 | kaibeta_hind6 | Item add. price w/o VAT 6 (customizable) | |
specialprice7 | kaibeta_hind7 | Item add. price w/o VAT 7 (customizable) | |
specialprice8 | kaibeta_hind8 | Item add. price w/o VAT 8 (customizable) | |
height | korgus | Height | |
width | laius | Width | |
depth | sygavus | Depth | |
grossweight | kaal_bruto | Gross weight | |
giftcert | kinkekaart | Gift card | |
manufacturer | tootja | Manufacturer |
Items additional fields:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
code | kood | ||
content | sisu | Content | |
param | param | Parameter |
Items packages:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
class | pakendi_klass | Class | |
type | pakendi_tyyp | Type | |
height | korgus | Height | |
width | laius | Width | |
length | pikkus | Length | |
volume | maht | Volume | |
qty | kogus | Pack. qty | |
packageweight | pakendi_kaal | Package weight | |
productweight | toote_kaal | Product weight | |
totalweight | kaal_kokku | TOTAL weight | |
totalvolume | maht_kokku | TOTAL volume | |
barcode | ribakood | Barcode | |
comment | kommentaar | Comment | |
shelf | riiul | Shelf |
Items - supplier items:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
supplier | hankija | Supplier | |
supplieritem | hankija_artikkel | Supp. item | |
name | nimi | Name | |
price | hind | Purchase price | |
normarrivaltime | norm_aeg | Normal arrival time | |
object | objekt | Object | |
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 | Sales price | without VAT |
sales | myyk | ALT.FROM: tr.params, cannot be updated , sales item = 1, supplier item = 0 |
Items - minmax:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
stock | ladu | Stock | |
shelf | riiul | Shelf | |
variant | variant | Variant | |
minlevel | min_kogus | MIN | |
maxlevel | max_kogus | MAX |
Item transport parameters
TYPE | CODE | PARAMETER 1 | PARAMETER 2 | EXPLANATION |
---|---|---|---|---|
XML | xd_supplieritemtype | 0 | ITEM | 0 = supplier item; 1 = sales item |
XML | type | 1 | ITEM | 1 = stock item |
Purchase Invoices
what=purchase Schema
Header
XML field | SQL field | UI field | Explanation |
---|---|---|---|
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 | Invoice time | ALT.FROM: current time |
duedate | tas_aeg | Due time | |
sum | summa | To be paid | sum with vat |
supplierinvoiceno | hankija_arve | Supplier invoice | |
paymentterm | tingimus | Pay. term. | ALT.FROM: supplier |
suppliercode | hankija_kood | Supplier | |
suppliername | hankija_nimi | ALT.FROM: supplier | |
bankaccount | pangakonto | ALT.FROM: supplier | |
reference | viide | Reference number | ALT.FROM: supplier |
transactiontime | kande_aeg | Oper. time | |
creditaccount | kred_konto | Cred. account | ALT.FROM: supplier > glob.settings |
factoring | arve_tasub | Invoice paid by | |
currency | valuuta | Currency | ALT.FROM: glob.settings > 'EUR' |
currencyrate | kurssbv1 | Rate | ALT.FROM: ECB current published rates |
vatzone | maa | VAT Zone (hidden field) | local = 0, EU = 1, export = 2 , ALT.FROM: supplier > 0 |
comment | kommentaar | Comment | |
vat | arvestatudkm | VAT total | |
object | objekt | Object | ALT.FROM: supplier > tr.params |
bankcode | pangakood | Bank code | |
creditpurchase | kredost | Cred. purch. | |
purchaseorder | ostutellimus | Purchase order | |
project | projekt | Project | |
ALT.FROM: supplier | |||
stockreceipt | sissetulek | Stock receipt | |
country | asumaa | Origin country | ALT.FROM: supplier |
prepayment | ettemaks | Prepayment | |
status | staatus | Status | |
type | tyyp | Type | |
dividedsum | jagatav_summa | Divisible sum | |
vatdate | km_aeg | VAT time | ALT.FROM: date > current time |
reclamation | reklamatsioon | Reclamation | |
reclamationcomment | rekl_selgitus | Recl. explanation | |
asset | inventar | Asset | |
datafield1 | lisa_field1 | ||
datafield2 | lisa_field2 | ||
datafield3 | lisa_field3 | ||
datafield4 | lisa_field4 | ||
datafield5 | lisa_field5 | ||
datafield6 | lisa_field6 | ||
datafield7 | lisa_field7 | ||
intcomment | sisekommentaar | Internal comment | |
supplier_class | hankija_klass | Class | |
supplier_vatcountry | hankija_maa_tasu | VAT-zone | local = 0, EU = 1, export = 2 , ALT.FROM: customer > 0 |
supplier_regno | hankija_regnr1 | Reg no 1 | |
supplier_vatregno | hankija_kmregnr | VAT reg no | |
supplier_type | hankija_tyyp | Type | |
confirm | kinnita | State | “1” - confirm document |
rows
XML field | SQL field | UI field | Explanation |
---|---|---|---|
account | konto | Account | |
object | objekt | Object | ALT.FROM: project |
name | sisu | Content | ALT.FROM: account |
linetotalwovat | summa | Sum | |
vatcode | kmkood | VAT code | ALT.FROM: supplier > account > object |
project | projekt | Project | |
customer | klient_kood | Customer | |
item | artikkel | Item | |
quantity | kogus | Quantity | |
date1 | r_aeg1 | Start | |
date2 | r_aeg2 | End | |
contract | leping | Contract | |
user | kasutaja | User | |
oid | oid | OID | |
orderrn | trn | ||
asset | r_inventar | Asset | |
price | myygihind | Sales price | |
constant1 | konstant1 | ||
constant2 | konstant2 | ||
constant3 | konstant3 | ||
constant4 | konstant4 | ||
text1 | tekst1 | ||
text2 | tekst2 | ||
text3 | tekst3 | ||
text4 | tekst4 | ||
intcomment | r_sisekommentaar | Internal comment | |
vatsum | km | VAT | |
rn | rn | No. |
attachments
XML field | SQL field | UI field | Explanation |
---|---|---|---|
name | attachment_name | ||
description | attachment_kirjeldus | ||
code | kood | for updating existing 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:// |
Purchase invoice transport parameters
TYPE | CODE | PARAMETER 1 | PARAMETER 2 | EXPLANATION |
---|---|---|---|---|
XML | xd_autosupplier | 1 | PURCHASE | Automatic creation of a related supplier if the supplier code does not exist, a unique reg. number is a prerequisite |
XML | xd_autosupplier_autocode | 0 | PURCHASE | When creating a related supplier, the code is created in the interface, a unique reg. number is required and system settings for supplier codes are necessary |
XML | xd_update | 0 | PURCHASE | Allow document update if there are no related documents |
XML | supplier_update | 0 | PURCHASE | Partial update of supplier data, (email, … ) fields need to be specified in the spec |
XML | xd_object | VEEB | PURCHASE | Default object, if not sent |
XML | xd_confirm | 0 | PURCHASE |
Resources
what=resource Schema
Header:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
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 |
Rows:
XML field | SQL field | UI field | Explanation |
---|---|---|---|
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 |
Outputs
Items (Items)
- what=item Schema
Filters: class,code,type,barcode,supplier,supplieritem,closed,ts
Item stock limits (Item stock limits)
- what=itemstocklimit Schema
Filters: code,stock,ts
Item packages (Item packages)
- what=itempackage Schema
Filters: code,ts
Item relations (Item relations)
- what=itemrelitem Schema
Filters: code,ts
Customers (Customers)
- what=customer Schema
Filters: code,loyaltycard,regno,email,phone,closed,ts
Suppliers (Suppliers)
- what=supplier
- Filters: code,regno,email,closed,ts
Stock levels (Stock levels)
Price formula rows (Price formula rows)
- what=priceformularow Schema
Filters: class,code,ts
Item classes (Item classes)
- what=itemclass Schema
Filters: code,master
Invoices (Invoices)
- what=invoice Schema
Filters: number,customercode,transactiondate,date1,date2,ts, ordernumber
Orders (Orders)
- what=order Schema
Filters: number,date1,date2,ts, projekt, customerordernumber, stock, status
Financial transactions (Transactions)
- what=transaction Schema
Filters: number,date1,date2,ts
Receipts (Receipts)
- what=receipt Schema
Filters: number,date1,date2,ts
Purchase Invoices (Purchase)
- what=purchase Schema
Filters: number,date1,date2,supplier,confirmed,status,ts
Resources (Resources)
- what=resource Schema
- Filters: number,confirmed,ts
Deleted documents (Deleted documents )
- what=delete Schema
Filters: number,code,document,ts