Invoices (invoice)

Invoices. Domain: Sales.


what	`invoice`
Direction	Output (get), Input (put)
Endpoint	`POST https://login.directo.ee/xmlcore/cap_xml_direct/xmlcore.asp`
Schema (output)	ws_arved.xsd
Schema (input)	xml_IN_arved.xsd

Output (get)

Query (get)

Parameter	Description
`token`	interface token (required)
`get`	1
`what`	invoice
`number`	optional filter
`customercode`	optional filter
`transactiondate`	optional filter
`date1`	period start
`date2`	period end
`ordernumber`	optional filter
`ts`	changed-since (for syncing)

XML field	SQL field	Type	Length	UI label	Description
`number`	number	int	9	Arve
`date`	aeg	string		Kuupäev
`duedate`	aeg2	string		Tähtaeg
`transactiondate`	kande_aeg	dateTime
`vatzone`	maa	int		KM Maa	local = 0, EU = 1, export = 2
`paymentterm`	tingimus	string	32	T-ting
`ordernumber`	tellimusenr	int		Tell. nr.
`object`	objekt	string	255	Objekt
`project`	projekt	string	32	Projekt
`account`	konto	string	32	Võla konto
`country`	asumaa	string	2	Sihtriik
`currency`	valuuta	string	32	Valuuta
`currencyrate`	kurssbv1	decimal		Kurss
`customercode`	klient_kood	string	32	Klient
`customername`	klient_nimi	string	200
`orderercode`	klient_tellija	string	32
`customerordernumber`	klienditellimus	string	100	Kliendi tell. nr.
`comment`	kommentaar	string	255	Kommentaar
`intcomment`	sisekommentaar	string	255	Sisekommentaar
`salesman`	myyja	string	30	Müügiagent
`language`	keel	string	32	Keel
`email`	email	string	255	meil
`address1`	aadress1	string	255	aadress, ! vastavalt seadetele
`address2`	aadress2	string	200	aadress, ! vastavalt seadetele
`address3`	aadress3	string	100	aadress, ! vastavalt seadetele
`deliveryaddress1`	lahetusaadress1	string	255	lähetusaadress, ! vastavalt seadetele
`deliveryaddress2`	lahetusaadress2	string	200	lähetusaadress, ! vastavalt seadetele
`deliveryaddress3`	lahetusaadress3	string	100	lähetusaadress, ! vastavalt seadetele
`phone`	telefon	string	100	Telefon
`priceformula`	hinnakiri	string	32	Hinnavalem
`vatregno`	kmregnumber	string	32	KM Reg. nr
`datafield1`	lisa_field1	string	255	Lisaväli 1, ! või vastavalt seadetele
`datafield2`	lisa_field2	string	255	Lisaväli 2, ! või vastavalt seadetele
`datafield3`	lisa_field3	string	255	Lisaväli 3, ! või vastavalt seadetele
`datafield4`	lisa_field4	string	255	Lisaväli 4, ! või vastavalt seadetele
`datafield5`	lisa_field5	string	255	Lisaväli 5, ! või vastavalt seadetele
`datafield6`	lisa_field6	string	255	Lisaväli 6, ! või vastavalt seadetele
`datafield7`	lisa_field7	string	255	Lisaväli 7, ! või vastavalt seadetele
`contractnumber`	leping	int	9	Leping
`prepayment`	ettemaksu_arve	int	1		ettemaksu arve, 0 tavaline arve
`status`	staatus	string	50	Staatus
`confirmed`	kinnitatud	int	1		confirmed document = 1
`stock`	ladu	string	32	Ladu
`creditedinvoice`	kredarve	int		Kred. arve
`deliveryterm`	lahetustingimus	string	32	Läh. ting.
`deliverymethod`	lahetusviis	string	32	Lähetusviis
`netamount`	kokku	decimal		Kokku
`vat`	kaibemaks	decimal
`balance`	saldo	decimal		Saldo
`totalamount`	tasuda	decimal		Kokku
`cu`	cu	string	32	Viimati muutis	document last changed by
`ts`	ts	string			document last changed

Rows

XML field	SQL field	Type	Length	UI label	Description
`item`	artikkel	string	255	Artikkel
`description`	seletus	string	255	Sisu
`price`	hind	decimal		Ühikuhind	unit price without vat
`discount`	pross	decimal		%
`quantity`	kogus	decimal		Kogus
`unit`	yhik	string	32	Ühik
`sum`	summa	decimal		Summa
`object`	objektid	string	255	Objekt
`project`	projekt	string	32	Projekt
`vatcode`	kmk	int		KMk
`comment`	r_kommentaar	string	200	Kommentaar
`date1`	r_aeg1	dateTime
`date2`	r_aeg2	dateTime
`salesman`	r_myyja	string	32	Müüja
`stock`	r_ladu	string	32	Ladu
`sn`	seerianumber	string	128	Seerianr
`total`	rsum	decimal
`rn`	rn	int		Nr
`rr`	rv	int		Rv

Input (put)

Create: send the document. Modify: requires xd_update=1 and posting the whole document. Default values (ALT.FROM): Mandatory fields.

A confirmed document can be modified only when xd_updateconfirmed=1; otherwise the response is Type=14.
Confirmation can be controlled via the XML field confirm (in addition to xd_confirm).

Header

XML field	SQL field	Type	Length	Mandatory	UI label	Description
`number`	number	int	9	yes	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	dateTime			Kuupäev	ALT.FROM: current time
`duedate`	aeg2	dateTime			Tähtaeg	ALT.FROM: paymentterm
`transactiondate`	kande_aeg	dateTime
`vatzone`	maa	int			KM maa	local = 0, EU = 1, export = 2 ALT.FROM: customer > 0
`paymentterm`	tingimus	string	32		T-ting	ALT.FROM: customer kui on kasutusel laekumiste loomine, läheb see kood ka laekumise makseviisiks
`ordernumber`	tellimusenr	int			Tell. nr.
`latepaymentpenalty`	viivis	decimal			Viivis	ALT.FROM: customer
`object`	objekt	string	255		Objekt	ALT.FROM: tr.params
`project`	projekt	string	32		Projekt
`account`	konto	string	32		Võla konto
`country`	asumaa	string	2		Sihtriik	ALT.FROM: customer
`currency`	valuuta	string	32		Valuuta	ALT.FROM: glob.settings > 'EUR'
`currencyrate`	kurssbv1	decimal			Kurss	ALT.FROM: ECB current published rates
`customercode`	klient_kood	string	32	yes	Klient	mandatory by default!
`customername`	klient_nimi	string	200			ALT.FROM: customer
`orderer_code`	klient_tellija	string	32
`contact`	esindaja	string	100		Nende esindaja	ALT.FROM: customer
`comment`	kommentaar	string	255		Kommentaar
`intcomment`	sisekommentaar	string	255		Sisekommentaar
`salesman`	myyja	string	30		Müügiagent	ALT.FROM: tr.params > 'XML'
`language`	keel	string	32		Keel	ALT.FROM: customer
`customerordernumber`	klienditellimus	string	255		Kliendi tell. nr.
`email`	email	string	255		meil	ALT.FROM: customer
`address1`	aadress1	string	255		aadress, ! vastavalt seadetele	ALT.FROM: customer
`address2`	aadress2	string	200		aadress, ! vastavalt seadetele	ALT.FROM: customer
`address3`	aadress3	string	100		aadress, ! vastavalt seadetele	ALT.FROM: customer
`phone`	telefon	string	100		Telefon	ALT.FROM: customer
`fax`	faks	string	50		Faks
`deliveryname`	klientnimi_lahetusel	string	200		Nimi lähetusel
`deliveryaddress1`	lahetusaadress1	string	255		lähetusaadress, ! vastavalt seadetele
`deliveryaddress2`	lahetusaadress2	string	200		lähetusaadress, ! vastavalt seadetele
`deliveryaddress3`	lahetusaadress3	string	100		lähetusaadress, ! vastavalt seadetele
`priceformula`	hinnakiri	string	32		Hinnavalem
`vatregno`	kmregnumber	string	32		KM Reg. nr	ALT.FROM: customer
`datafield1`	lisa_field1	string	255		Lisaväli 1, ! või vastavalt seadetele
`datafield2`	lisa_field2	string	255		Lisaväli 2, ! või vastavalt seadetele
`datafield3`	lisa_field3	string	255		Lisaväli 3, ! või vastavalt seadetele
`datafield4`	lisa_field4	string	255		Lisaväli 4, ! või vastavalt seadetele
`datafield5`	lisa_field5	string	255		Lisaväli 5, ! või vastavalt seadetele
`datafield6`	lisa_field6	string	255		Lisaväli 6, ! või vastavalt seadetele
`datafield7`	lisa_field7	string	255		Lisaväli 7, ! või vastavalt seadetele
`quotation`	pakkumine	int	9		Pakkumine
`contractnumber`	leping	int	9		Leping
`prepayment`	ettemaksu_arve	int	1			ettemaksu arve, 0 tavaline arve
`type`	tyyp	string	50
`status`	staatus	string	50		Staatus
`paymenttotal`	laekumine_summa	decimal				positive number will create receipt with same doc. number
`confirm`	kinnita	int				“1” - confirm document
`stock`	ladu	string	32		Ladu	ALT.FROM: tr.params
`creditedinvoice`	kredarve	int			Kred. arve
`asset`	inventar	string	32		Inventar
`dealtype`	tehinguliik	string	2		Tehinguliik
`delivery`	lahetusaeg	dateTime			Lähetusaeg
`deliveryterm`	lahetustingimus	string	32		Läh. ting.	ALT.FROM: customer
`deliverytermcomment`	lahetustingimus_komm	string	255		Läh. ting.
`deliverymethod`	lahetusviis	string	32		Lähetusviis
`deliverymethodcomment`	lahetusviis_komm	string	255		Lähetusviis
`manager`	haldur	string	32		Vastutaja
`changestock`	muudaladu	int	1			stock changing invoice = 1
`rounding`	ymardus	decimal				Roudning amount, works with POS invoices
`rikeinvoice`	eak_invoice	int			“Send automatic RIK e-invoice	ALT.FROM: 1/yes
`customer_type`	klient_tyyp	int	32		Kliendikaardil: Tüüp	company = 0, private citizen = 1, government institution = 2
`customer_regno`	klient_regnr	string	50		Kliendikaardil: Reg nr
`customer_class`	klient_klass	string	32		Kliendikaardil: Klass
`customer_loyaltycard`	klient_kliendikaart	string	100		Kliendikaardil: Kliendikaart
`location`	koht	string	32		Koht
`salesmanname`	nende_esindaja	string	100		Müüja nimi

Do not send:

session_id – for internal use at Directo side, do not send this field!

Rows

XML field	SQL field	Type	Length	UI label	Description
`item`	artikkel	string	32	Artikkel
`description`	seletus	string	255	Sisu	ALT.FROM: item
`variant`	variant	string	32	Variant
`price`	hind	decimal		Ühikuhind	unit price without vat
`discount`	pross	decimal		%
`quantity`	kogus	decimal		Kogus
`unit`	yhik	string	32	Ühik	ALT.FROM: item
`sum`	summa	decimal		Summa
`account`	konto	string	32	Konto	ALT.FROM: item > item class (depending on vatregion)
`object`	objektid	string	255	Objekt	ALT.FROM: item > item class
`project`	projekt	string	32	Projekt	ALT.FROM: item > item class
`purchaseprice`	kulu	decimal		Ostuhind	ALT.FROM: item
`vatcode`	kmk	int		KMk	ALT.FROM: customer > item > item class (depending on vatregion)
`comment`	r_kommentaar	string	200	Kommentaar
`date1`	r_aeg1	dateTime
`date2`	r_aeg2	dateTime
`salesman`	r_myyja	string	32	Müüja
`order`	tellimus	int
`orderrow`	trn	int
`stock`	r_ladu	string	32	Ladu
`sn`	seerianumber	string	128	Seerianr
`deliverytime`	lahetusaeg	dateTime		Lähetusaeg
`customer`	r_klient	string	32	Tellija
`customername`	r_klient_nimi	string	250	Tellija nimi
`text1`	tekst1	string	32	Tekst1
`text2`	tekst2	string	32	Tekst2
`text3`	tekst3	string	32	Tekst3
`text4`	tekst4	string	32	Tekst4
`constant1`	konstant1	decimal		Konstant1
`constant2`	konstant2	decimal		Konstant2
`constant3`	konstant3	decimal		Konstant3
`constant4`	konstant4	decimal		Konstant4
`shelf`	riiul	string	32	Riiul
`rsum`	rsum	decimal		RSKM (kui on saadetud price/ühikuhind, siis rskm'i ei kasutata)
`rn`	rn	int		Nr	row order number in document 1 - N ALT.FROM: random
`rr`	rv	int		Rv	row reference for grouping, otherwise equals to rn ALT.FROM: equals to rn

Payment

XML field	SQL field	Type	Length	Mandatory	UI label	Description
`peyterm`	tingimus	string	32
`sum`	raha	decimal

Transport parameters

Configured on the token (interface), not sent in xmldata. PARAMETER 2 = document type.

TYPE	CODE	PARAMETER 1	PARAMETER 2	DESCRIPTION
XML	`xd_changestock`	0	INVOICE	Stock-changing invoice
XML	`xd_update`	1	INVOICE	Allow update when no linked documents
XML	`xd_object`	TEST_OBJEKT	INVOICE	Default object if not sent
XML	`xd_stock`	PL	INVOICE	Default warehouse if not sent
XML	`xd_confirm`	0	INVOICE	Auto-confirm document; also via XML field confirm
XML	`xd_posinvoice`	0	INVOICE	1 = POS invoice
XML	`xd_updateconfirmed`	1	INVOICE	Allow modifying a confirmed document

Response

docid = number of the created/updated document. Error codes: Responses and error codes.

<results>
  <Result Type="0" Desc="Created" docid="100001" doctype="INVOICE" submit="Invoices"/>
</results>