Customers (customer)

Customers. Domain: Partners.


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

Output (get)

Query (get)

Parameter	Description
`token`	interface token (required)
`get`	1
`what`	customer
`code`	optional filter
`loyaltycard`	optional filter
`regno`	optional filter
`email`	optional filter
`phone`	optional filter
`type`	optional filter
`closed`	optional filter
`ts`	changed-since (for syncing)

XML field	SQL field	Type	Length	UI label	Description
`code`	kood	string	32	Kood
`name`	nimi	string	255	Nimi
`object`	objekt	string	255	Objekt
`address1`	aadress1	string	255	aadress, ! vastavalt seadetele
`address2`	aadress2	string	200	aadress, ! vastavalt seadetele
`address3`	aadress3	string	100	aadress, ! vastavalt seadetele
`deliveryaddress1`	lahaadress1	string	255	aadress, ! vastavalt seadetele
`deliveryaddress2`	lahaadress2	string	200	aadress, ! vastavalt seadetele
`deliveryaddress3`	lahaadress3	string	100	aadress, ! vastavalt seadetele
`country`	asumaa	string	2	Asumaa
`county`	maakond	string	32	Maakond
`contact`	kontakt	string	200	Esindaja
`phone`	telefon	string	100	Telefon
`email`	email	string	255	Meil
`regno`	regnr	string	50	Reg nr
`loyaltycard`	kliendikaart	string	100	Kliendikaart	also used for personal ID code
`vatregno`	kmregnr	string	32	Km reg nr
`class`	klass	string	32	Klass
`comment`	kommentaar	string	4000	Kommentaar	or infinite (slower)
`payterm`	tingimus	string	32	Tas. ting.
`vatregion`	maa	int		Maa	local = 0, EU = 1, export = 2
`priceformula`	hinnakiri	string	32	Hinnavalem
`specialpriceformula`	hinnavalem_eri	string	32	Eripakkumised
`balance`	saldo	decimal
`creditlimit`	limiit	decimal
`creditbalance`	krediidijaak	decimal
`deliveryinvoice`	lah_arve	int	1	Lähetus	Lähetus ja Arve = 1, Lähetus = 0
`salesman`	myyja	string	32	Müüja
`currency`	valuuta	string	32	Valuuta
`birthday`	klient_synnipaev	dateTime		Sünnipäev
`discount`	ale	decimal		Soodus %
`closed`	suletud	int	9	Suletud	closed document = 1
`ts`	ts	string			document last changed

Extra fields

XML field	SQL field	Type	Length	UI label
`code`	kood	string	32
`content`	sisu	string	2000	Sisu
`param`	param	string	64	Parameeter

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 cannot be modified (response Type=14).

Header

XML field	SQL field	Type	Length	Mandatory	UI label	Description
`code`	kood	string	32	yes	Kood	document number/ID, mandatory; It must be unique for each document and remain same if more than one transaction of the same document is necessary
`name`	nimi	string	255		Nimi
`object`	objekt	string	255		Objekt
`address1`	aadress1	string	255		aadress, ! vastavalt seadetele
`address2`	aadress2	string	200		aadress, ! vastavalt seadetele
`address3`	aadress3	string	100		aadress, ! vastavalt seadetele
`deliveryaddress1`	lahaadress1	string	255		aadress, ! vastavalt seadetele
`deliveryaddress2`	lahaadress2	string	200		aadress, ! vastavalt seadetele
`deliveryaddress3`	lahaadress3	string	100		aadress, ! vastavalt seadetele
`county`	maakond	string	32		Maakond
`country`	asumaa	string	2		Asumaa
`contact`	kontakt	string	200		Esindaja
`phone`	telefon	string	100		Telefon
`email`	email	string	255	yes	Meil	mandatory
`regno`	regnr	string	50		Reg nr
`vatregno`	kmregnr	string	32		Km reg nr
`notice`	margukiri	int			Märgukirjad	yes = 1
`birthday`	klient_synnipaev	dateTime			Sünnipäev
`gender`	klient_sugu	int	1		Sugu	female = 1, male = 0
`class`	klass	string	32		Klass
`type`	klient_tyyp	int			Tüüp	company = 0, private citizen = 1, government institution = 2
`loyaltycard`	kliendikaart	string	100		Kliendikaart	also used for personal ID code
`deliveryname`	nimi_lahetusel	string	200		Nimi lähetusel
`deliverymode`	lahetusviis	string	32		Läh. viis
`alert`	hoiatus	string	200		Hoiatus
`factoring`	arvetasub	string	32		Arve tasub
`fax`	faks	string	100		Faks
`comment`	kommentaar	string	4000		Kommentaar	or infinite (slower)
`payterm`	tingimus	string	32		Tas. ting.
`vatzone`	maa	int			KM maa	local = 0, EU = 1, export = 2
`language`	keel	string	32		Keel
`salesman`	myyja	string	32		Müüja
`bank`	pank	string	32		Pank
`bankaccount`	arveldusarve	string	100		A/a
`url`	URL	string	250		Url
`status`	staatus	string	50		Staatus
`accountmanager`	kliendihaldur	string	32		Haldur
`dealtype`	tehinguliik	string	2		Tehinguliik
`creditlimit`	limiit	decimal			Limiit
`priceformula`	hinnakiri	string	32		Hinnavalem
`specialpriceformula`	hinnavalem_eri	string	32		Eripakkumised
`discount`	ale	decimal			Soodus %
`destination`	sihtriik	string	2		Sihtriik
`firstname`	eesnimi	string	125
`lastname`	perenimi	string	125
`vatcode`	kmkood	int			KM kood
`extcode`	valine_kood	string	32		Väline kood
`deliveryinvoice`	lah_arve	int	1		Lähetus	Lähetus ja Arve = 1, Lähetus = 0
`currency`	valuuta	string	32		Valuuta
`deliveryterm`	lahetustingimus	string	32		Lähetustingimus
`rikeinvoice`	eak_invoice	int			“Confirmation sends automatic RIK e-invoice	ALT.FROM: 1/yes
`closed`	suletud	int

Do not send:

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

Extra fields

XML field	SQL field	Type	Length	UI label
`code`	kood	string	32
`content`	sisu	string	2000	Sisu
`param`	param	string	64	Parameeter

Transport parameters

Component-specific; add from the source wiki if this component has parameters.

Response

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

<results>
  <Result Type="0" Desc="Created" docid="100001" doctype="CUSTOMER" submit="Customers"/>
</results>