en:xml_direct
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| en:xml_direct [2025/08/04 09:15] – [Ostuarved] toomas | en:xml_direct [2026/08/19 10:43] (current) – toomas | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// | + | {{page>en:xml_direct:start}} |
| - | + | ||
| - | ======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, | + | |
| - | + | ||
| - | All components within the XML Direct interface follow a **fixed field structure**, | + | |
| - | + | ||
| - | =====Key Features ===== | + | |
| - | * **Modular Architecture**: | + | |
| - | * **Uniform Data Format**: Field definitions and data structure are standardized across all implementations, | + | |
| - | * **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, | + | |
| - | * 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 '' | + | |
| - | - Since there can be multiple API keys, you need to open the employee card for whom the key has been created. For example, open the employee card ' | + | |
| - | - Go to the '' | + | |
| - | - Go to the '' | + | |
| - | - On the line of the required interface, press the button {{: | + | |
| - | + | ||
| - | =====Access to the Interface (URL) ===== | + | |
| - | Access to the interface is via the POST method, form/ | + | |
| - | + | ||
| - | A token must be used for access (see the '' | + | |
| - | + | ||
| - | **curl example ** | + | |
| - | < | + | |
| - | curl --location ' | + | |
| - | --header ' | + | |
| - | --data-urlencode ' | + | |
| - | --data-urlencode ' | + | |
| - | --data-urlencode ' | + | |
| - | --data-urlencode ' | + | |
| - | </ | + | |
| - | + | ||
| - | + | ||
| - | =====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:// | + | |
| - | =====General ====== | + | |
| - | + | ||
| - | * Output interfaces show all records, and restrictions can be made with query filters! | + | |
| - | * The functionality of input interfaces can be controlled with '' | + | |
| - | * Some inputs also support setting default values. | + | |
| - | =====Components ===== | + | |
| - | Selectable components | + | |
| - | ^ Component (what) | + | |
| - | | Orders (order) | + | |
| - | | Invoices (invoice ) | x | + | |
| - | | Receipts (receipt) | + | |
| - | | Customers (customer) | + | |
| - | | Suppliers (supplier) | + | |
| - | | Items (item) | + | |
| - | | Items:Stock Limits (itemstocklimit) | + | |
| - | | Items: | + | |
| - | | Items: | + | |
| - | | Item classes (itemclass) | + | |
| - | | Stock level (stocklevel) | + | |
| - | | Stock level with serial numbers (stocklevel_sn) | | x | | + | |
| - | | Stock level with variants (stocklevel_variant) | | + | |
| - | | Price formula rows (priceformularow) | + | |
| - | | Purchase invoices (purchase) | + | |
| - | | Financial transactions (transaction) | + | |
| - | | Resources (resource) | + | |
| - | | Deleted documents | + | |
| - | + | ||
| - | ====Inputs ==== | + | |
| - | ===Invoices=== | + | |
| - | what=invoice [[https:// | + | |
| - | + | ||
| - | == Header: === | + | |
| - | ^ XML field ^ SQL field ^ UI field ^ Explanation | + | |
| - | | session_id | + | |
| - | | number | + | |
| - | | date | aeg | Date | ALT.FROM: current time | | + | |
| - | | duedate | + | |
| - | | transactiondate | + | |
| - | | vatzone | + | |
| - | | paymentterm | + | |
| - | | ordernumber | + | |
| - | | latepaymentpenalty | + | |
| - | | object | + | |
| - | | project | + | |
| - | | account | + | |
| - | | country | + | |
| - | | currency | + | |
| - | | currencyrate | + | |
| - | | customercode | + | |
| - | | customername | + | |
| - | | orderer_code | + | |
| - | | contact | + | |
| - | | comment | + | |
| - | | intcomment | + | |
| - | | salesman | + | |
| - | | language | + | |
| - | | customerordernumber | + | |
| - | | email | email | e-mail | + | |
| - | | address1 | + | |
| - | | address2 | + | |
| - | | address3 | + | |
| - | | phone | telefon | + | |
| - | | fax | faks | Fax | | | + | |
| - | | deliveryname | + | |
| - | | deliveryaddress1 | + | |
| - | | deliveryaddress2 | + | |
| - | | deliveryaddress3 | + | |
| - | | priceformula | + | |
| - | | vatregno | + | |
| - | | datafield1 | + | |
| - | | datafield2 | + | |
| - | | datafield3 | + | |
| - | | datafield4 | + | |
| - | | datafield5 | + | |
| - | | datafield6 | + | |
| - | | datafield7 | + | |
| - | | quotation | + | |
| - | | contractnumber | + | |
| - | | prepayment | + | |
| - | | type | tyyp | | | | + | |
| - | | status | + | |
| - | | paymenttotal | + | |
| - | | confirm | + | |
| - | | stock | ladu | Stock | ALT.FROM: tr.params | + | |
| - | | creditedinvoice | + | |
| - | | asset | inventar | + | |
| - | | dealtype | + | |
| - | | delivery | + | |
| - | | deliveryterm | + | |
| - | | deliverytermcomment | + | |
| - | | deliverymethod | + | |
| - | | deliverymethodcomment | lahetusviis_komm | + | |
| - | | manager | + | |
| - | | changestock | + | |
| - | | customer_type | + | |
| - | | customer_regno | + | |
| - | | customer_class | + | |
| - | | customer_loyaltycard | + | |
| - | + | ||
| - | == 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, | + | |
| - | |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 [[https:// | + | |
| - | + | ||
| - | ===Orders === | + | |
| - | what=order | + | |
| - | [[https:// | + | |
| - | + | ||
| - | == Header: === | + | |
| - | ^ XML field ^ SQL field ^ UI field ^ Explanation | + | |
| - | | session_id | + | |
| - | | number | + | |
| - | | customercode | + | |
| - | | customername | + | |
| - | | date | aeg | Date | ALT.FROM: current time | | + | |
| - | | address1 | + | |
| - | | address2 | + | |
| - | | address3 | + | |
| - | | deliveryaddress1 | + | |
| - | | deliveryaddress2 | + | |
| - | | deliveryaddress3 | + | |
| - | | paymentterm | + | |
| - | | deliverymethod | + | |
| - | | customerordernumber | + | |
| - | | email | email | e-mail | + | |
| - | | phone | telefon | + | |
| - | | comment | + | |
| - | | stock | ladu | Stock | ALT.FROM: tr.params | + | |
| - | | object | + | |
| - | | contact | + | |
| - | | datafield1 | + | |
| - | | datafield2 | + | |
| - | | datafield3 | + | |
| - | | datafield4 | + | |
| - | | datafield5 | + | |
| - | | datafield6 | + | |
| - | | datafield7 | + | |
| - | | paymenttotal | + | |
| - | | vatzone | + | |
| - | | priceformula | + | |
| - | | currency | + | |
| - | | currencyrate | + | |
| - | | vatregno | + | |
| - | | country | + | |
| - | | status | + | |
| - | | delivery | + | |
| - | | customer_type | + | |
| - | | customer_regno | + | |
| - | | customer_loyaltycard | + | |
| - | | salesman | + | |
| - | | project | + | |
| - | | deliveryname | + | |
| - | | factoring | + | |
| - | | deliveryterm | + | |
| - | | language | + | |
| - | == Rows: == | + | |
| - | ^ XML field ^ SQL field ^ UI field ^ Explanation | + | |
| - | | item | artikkel | + | |
| - | | description | + | |
| - | | price | yhikuhind | + | |
| - | | quantity | + | |
| - | | discount | + | |
| - | | account | + | |
| - | | vatcode | + | |
| - | | unit | yhik | Unit | ALT.FROM: item | | + | |
| - | | comment | + | |
| - | | variant | + | |
| - | | deliverytime | + | |
| - | | stock | r_ladu | + | |
| - | | project | + | |
| - | | ext_sum | + | |
| - | | 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, | + | |
| - | |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|x | + | |
| - | |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 " | + | |
| - | |XML|xd_order_assemble|1|ORDER|Triggers the order assembler for items with recipes | | + | |
| - | + | ||
| - | To configure default order values, read more [[https:// | + | |
| - | ===Receipts === | + | |
| - | what=receipt | + | |
| - | [[https:// | + | |
| - | + | ||
| - | == 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 > ' | + | |
| - | |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 | + | |
| - | [[https:// | + | |
| - | + | ||
| - | == 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 " | + | |
| - | |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 > ' | + | |
| - | |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 | + | |
| - | [[https:// | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | ==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, | + | |
| - | |address2|aadress2|address, | + | |
| - | |address3|aadress3|address, | + | |
| - | |deliveryaddress1|lahaadress1|address, | + | |
| - | |deliveryaddress2|lahaadress2|address, | + | |
| - | |deliveryaddress3|lahaadress3|address, | + | |
| - | |county|maakond|County| | | + | |
| - | |country|asumaa|Country| | | + | |
| - | |contact|kontakt|Representative| | | + | |
| - | |phone|telefon|Phone| | | + | |
| - | |email|email|E-mail| 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 | + | |
| - | [[https:// | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | ==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| | | | + | |
| - | |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| | | | + | |
| - | == 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 [[en: | + | |
| - | + | ||
| - | what=item | + | |
| - | [[https:// | + | |
| - | + | ||
| - | ==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 | + | |
| - | [[https:// | + | |
| - | + | ||
| - | ==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 > ' | + | |
| - | |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| | | + | |
| - | |email|email|e-mail| 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| " | + | |
| - | + | ||
| - | ==rows == | + | |
| - | ^XML field^SQL field^UI field^Explanation^ | + | |
| - | |account|konto|Account| | | + | |
| - | |object|objekt|Object| ALT.FROM: project | | + | |
| - | |name|sisu|Content| | + | |
| - | |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, | + | |
| - | |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 < | + | |
| - | ==Purchase invoice transport parameters == | + | |
| - | ^ TYPE ^ CODE ^ PARAMETER 1 ^ PARAMETER 2 ^ EXPLANATION | + | |
| - | | XML | xd_autosupplier | + | |
| - | | XML | xd_autosupplier_autocode | + | |
| - | | XML | xd_update | + | |
| - | | XML | supplier_update | + | |
| - | | XML | xd_object | + | |
| - | | XML | xd_confirm | + | |
| - | ===Ressursid === | + | |
| - | + | ||
| - | what=resource | + | |
| - | [[https:// | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | == 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 | + | |
| - | + | ||
| - | == Artikli laolimiidid (Item stock limits) == | + | |
| - | * what=itemstocklimit [[https:// | + | |
| - | + | ||
| - | == Artikli pakendid (Item packages) == | + | |
| - | * what=itempackage [[https:// | + | |
| - | + | ||
| - | == Seotud artikli (Item relations) == | + | |
| - | * what=itemrelitem [[https:// | + | |
| - | + | ||
| - | === Kliendid (Customers) === | + | |
| - | + | ||
| - | * what=customer [[https:// | + | |
| - | + | ||
| - | === Hankijad (Suppliers) === | + | |
| - | + | ||
| - | * what=supplier | + | |
| - | * [[https:// | + | |
| - | * Filtrid: code, | + | |
| - | + | ||
| - | === Laoseis (Stock levels) === | + | |
| - | * what=stocklevel [[https:// | + | |
| - | * what= stocklevel_sn [[https:// | + | |
| - | * what=stocklevel_variant [[https:// | + | |
| - | * Filtrid: code, | + | |
| - | + | ||
| - | === Hinnavalemi read (Price formula rows) === | + | |
| - | + | ||
| - | * what=priceformularow [[https:// | + | |
| - | + | ||
| - | === Artikli klassid (Item classes) === | + | |
| - | + | ||
| - | * what=itemclass [[https:// | + | |
| - | + | ||
| - | === Arved (Invoices) === | + | |
| - | + | ||
| - | * what=invoice [[https:// | + | |
| - | + | ||
| - | === Tellimused (Orders) === | + | |
| - | + | ||
| - | * what=order [[https:// | + | |
| - | + | ||
| - | === Finantskanded (Transactions) === | + | |
| - | + | ||
| - | * what=transaction [[https:// | + | |
| - | + | ||
| - | === Laekumised (Receipts) === | + | |
| - | + | ||
| - | * what=receipt [[https:// | + | |
| - | + | ||
| - | === Ostuarved (Purchase) === | + | |
| - | + | ||
| - | * what=purchase [[https:// | + | |
| - | + | ||
| - | === Ressursid (Resources) === | + | |
| - | * what=resource [[https:// | + | |
| - | * Filtrid: number, | + | |
| - | + | ||
| - | === Kustutatud dokumendid (Deleted documents ) === | + | |
| - | + | ||
| - | * what=delete [[https:// | + | |
| - | + | ||
en/xml_direct.1754288120.txt.gz · Last modified: 2025/08/04 09:15 by toomas