Suppliers

Dimension type CRD

Find

Web service type: Method driven

Resource location: /webservices/finder.asmx?wsdl

Method

public Message[] Search(
	string type, // Finder type, See Finder type.
	string pattern, // The search pattern. May contain wildcards * and ?
	int field, // Fields to search through, see Search fields.
	int firstRow, // First row to return, usefull for paging
	int maxRows, // Maximum number of rows to return, usefull for paging
	string[][] options, // See options below
	out FinderData data) // Search results

Finder type

DIM

Search fields

Field ID	Fields searched
0	code and name
1	code
2	name
3	bank account number
4	address fields

The method will return an array containing validation messages. If there are no errors, then the data parameter will contain the actual search result.

Options

Option	Type	Description
office	«office code»	Restricts to the office.
level	enumeration: 1, 2, 3, 4, 5, 6	Specifies the dimension level. Normally the level of balancesheets is level 1.
section	financials	Restricts to financial or time & expenses dimensions.
dimtype	CRD	Shows the supplier dimensions.
modifiedsince	string yyyyMMddHHmmss or yyyyMMdd	Restricts to dimensions modified after, on or at the specified date (and time).
group	«group code»	Specifies the dimension group (wildcards allowed).
matchtype	enumeration: DEB, CRD	This option will show only the relations (dimension type: DEB and/or CRD).
includehidden	0 (false) or 1 (true)	If set to 1, the response will include a status column (active/hidden) and both active and hidden dimensions will be included.

Read

Web service type: XML Web Services

XML

Below example reads the settings of the supplier (CRD) dimension EXAMPLE.

<read>
    <type>dimensions</type>
    <office>001</office>
    <dimtype>CRD</dimtype>
    <code>EXAMPLE</code>
</read>

Create/Update/Delete

If the dimension is not found it will be automatically created, otherwise it is updated. Set dimension/header/@status to deleted for deleting a dimension.

Root

XML structure

<dimension>
    <financials></financials>
    <addresses></addresses>
    <banks></banks>
    <groups></groups>
    <postingrules></postingrules>
    <paymentconditions></paymentconditions>
    <remittanceadvice></remittanceadvice>
</dimension>

Element name: dimension

Name	Description
dimension	Contains information general to the dimension.
financials	Contains the financial settings of the dimension.
addresses	Contains the addresses of the dimension.
banks	Contains the bank accounts of the dimension.
groups	Contains the dimension groups the dimension is part of.
postingrules	Contains the posting rules of the dimension.
paymentconditions	Contains the payment conditions of the dimension.
remittanceadvice	Contains the remittance advice settings of the dimension.

Dimension

XML structure

Request

<dimension>
    <office></office>
    <type></type>
    <code></code>
    <name></name>
    <shortname></shortname>
    <beginperiod></beginperiod>
    <beginyear></beginyear>
    <endperiod></endperiod>
    <endyear></endyear>
    <website></website>
    <sendtype></sendtype>
    <sendmail></sendmail>
</dimension>

Response

<dimension status="" result="">
    <office name="" shortname=""></office>
    <type name="" shortname=""></type>
    <code></code>
    <name></name>
    <shortname></shortname>
    <beginperiod></beginperiod>
    <beginyear></beginyear>
    <endperiod></endperiod>
    <endyear></endyear>
    <website></website>
    <cocnumber></cocnumber>
    <vatnumber></vatnumber>
    <uid></uid>
    <inuse></inuse>
    <behaviour></behaviour>
    <touched></touched>
    <editdimensionname></editdimensionname>
    <sendtype></sendtype>
    <sendmail></sendmail>
</dimension>

Element name: dimension

Property name	Value	Description
@status	active deleted hide	For creating and updating status may be left empty. For deleting deleted should be used. In case a dimension that is used in a transaction is deleted, its status has been changed into hide. Hidden dimensions can be activated by using active.
office	code	Office code.
type	code	Dimension type. See Dimension type. Dimension type of suppliers is CRD.
code	code	Dimension code, must be compliant with the mask of the CRD Dimension type.
uid	string	Unique identification of the dimension. Read-only attribute.
name	string(80)	Name of the dimension.
shortname	string(20)	Short name of the dimension.
inuse	true false	Indicates whether the dimension is used in a financial transaction or not. Read-only attribute.
behaviour	normal system template	Determines the behaviour of dimensions. Read-only attribute.
touched	integer	Count of the number of times the dimension settings are changed. Read-only attribute.
beginperiod	integer	Determines together with beginyear the period from which the dimension may be used.
beginyear	integer	Determines together with beginperiod the period from which the dimension may be used.
endperiod	integer	Determines together with endyear the period till which the dimension may be used.
endyear	integer	Determines together with endperiod the period till which the dimension may be used.
website	string(40)	Website of the dimension.
cocnumber		Obsolete. Use instead field5 of the address line.
vatnumber		Obsolete. Use instead field4 of the address line.
editdimensionname		Not in use.

Financials

XML structure

Request

<financials>
    <matchtype></matchtype>
    <accounttype></accounttype>
    <subanalyse></subanalyse>
    <duedays></duedays>
    <payavailable></payavailable>
    <meansofpayment></meansofpayment>
    <paycode></paycode>
    <ebilling></ebilling>
    <ebillmail></ebillmail>
    <substitutionlevel></substitutionlevel>
    <substitutewith></substitutewith>
    <relationsreference>></relationsreference>
    <vatcode></vatcode>
    <childvalidations>
        <...>
    </childvalidations>
</financials>

Response

<financials>
    <matchtype></matchtype>
    <accounttype></accounttype>
    <subanalyse></subanalyse>
    <duedays></duedays>
    <level></level>
    <payavailable></payavailable>
    <meansofpayment></meansofpayment>
    <paycode name="" shortname=""></paycode>
    <ebilling></ebilling>
    <ebillmail></ebillmail>
    <substitutionlevel></substitutionlevel>
    <substitutewith></substitutewith>
    <relationsreference></relationsreference>
    <vattype name="" shortname=""></vattype>
    <vatcode name="" shortname="" type=""></vatcode>
    <vatobligatory></vatobligatory>
    <performancetype></performancetype>
    <collectmandate>
        <...>
    </collectmandate>
    <collectionschema></collectionschema>
    <childvalidations>
        <...>
    </childvalidations>
</financials>

Element name: financials

Property name	Value	Description
matchtype	code	Fixed value customersupplier.
accounttype	code	Fixed value inherit.
subanalyse	true false maybe	Fixed value false.
duedays	integer	The number of due days.
level	integer	Specifies the dimension level. Normally the level of suppliers is level 2. Read-only attribute.
payavailable	true false	Determines if credit transfer is possible.
meansofpayment	none paymentfile cheques	The option none is only allowed in case payavailable is set to false. The options paymentfile or cheques are only allowed in case payavailable is set to true.
paycode	string(16)	The code of the payment type in case credit transfer is possible. Only if meansofpayment is set to paymentfile.
ebilling		Not is use. Fixed value false.
ebillmail		Not in use.
substitutionlevel	integer	Level of the balancesheet account. Fixed value 1.
substitutewith	string(16)	Default supplier balancesheet account.
relationsreference	string(40)	External supplier number.
vattype		Not in use.
vatcode	string(16)	Default VAT code.
vatobligatory		Not in use.
performancetype		Not in use.
collectmandate		Not in use.
collectionschema		Not in use.

Collect mandate information

XML structure

Request

Not allowed in the XML request.

Response

<collectmandate>
    <id></id>
    <signaturedate></signaturedate>
    <firstrundate></firstrundate>
</collectmandate>

Element name: collectmandate

Property name	Value	Description
id		Not in use.
signaturedate		Not in use.
firstrundate		Not in use.

Addresses

Element name: addresses

Property name	Value	Description
address	node	Sets the dimension addresses.

Address

XML structure

Request

<addresses>
    <address default="" type="">
        <name></name>
        <country></country>
        <city></city>
        <postcode></postcode>
        <telephone></telephone>
        <telefax></telefax>
        <email></email>
        <field1></field1>
        <field2></field2>
        <field3></field3>
        <field4></field4>
        <field5></field5>
        <field6></field6>
    </address>
</addresses>

Response

<addresses>
    <address default="" type="" id="">
        <name></name>
        <country name="" shortname=""></country>
        <city></city>
        <postcode></postcode>
        <telephone></telephone>
        <telefax></telefax>
        <email></email>
        <contact></contact>
        <field1></field1>
        <field2></field2>
        <field3></field3>
        <field4></field4>
        <field5></field5>
        <field6></field6>
    </address>
</addresses>

Element name: address

Property name	Value	Description
@id	integer	Sequence number of the address line.
@type	invoice postal contact	The type of the address.
@default	true false	Is this the default address, only one default address is possible.
name	string(80)	Company name.
country	string(2)	Country code. The ISO country codes are used.
city	string(40)	City.
postcode	string(16)	Postcode.
telephone	string(25)	Telephone number.
telefax	string(25)	Fax number.
email	string(200)
contact		Obsolete
field1	string(128)	User defined fields, the labels are configured in the Dimension type.
field2	string(128)	User defined fields, the labels are configured in the Dimension type.
field3	string(128)	User defined fields, the labels are configured in the Dimension type.
field4	string(128)	User defined fields, the labels are configured in the Dimension type. Currently, field4 is reserved for VAT numbers. So only valid VAT numbers may be filled in.
field5	string(128)	User defined fields, the labels are configured in the Dimension type.
field6	string(128)	User defined fields, the labels are configured in the Dimension type.

Banks

XML structure

Request

<banks>
    <bank>
        <ascription></ascription>
        <accountnumber></accountnumber>
        <address>
            <...>
        </address>
        <bankname></bankname>
        <biccode></biccode>
        <city></city>
        <country></country>
        <iban></iban>
        <natbiccode></natbiccode>
        <postcode></postcode>
        <state></state>
        <wayofpayment></wayofpayment>
        <payaddress></payaddress>
    </bank>
</banks>

Response

<banks>
    <bank default="" id="" destination="">
        <ascription></ascription>
        <accountnumber></accountnumber>
        <address>
            <...>
        </address>
        <bankname></bankname>
        <biccode></biccode>
        <city></city>
        <country></country>
        <iban></iban>
        <natbiccode></natbiccode>
        <postcode></postcode>
        <state></state>
        <wayofpayment></wayofpayment>
        <payaddress></payaddress>
    </bank>
</banks>

Element name: banks

Property name	Value	Description
@id	integer	Sequence number of the bank account line. When adding a new bank, do not supply the @id. When changing a bank account, supply the corresponding @id.
@default	true false	Is this the default bank account, only one default bank account is possible.
ascription	string(40)	Account holder.
accountnumber	string(40)	Account number.
address	node	Sets a part of the bank address.
bankname	string(40)	Bank name.
biccode	string(16)	BIC code.
city	string(40)	City.
country	string(2)	Bank country code. The ISO country codes are used.
iban	string(40)	IBAN account number.
natbiccode	string(20)	National bank code.
postcode	string(16)	Postcode.
state	string(40)	State.
wayofpayment	0 1 2	normal cheque basis Only if payment type is BTL91.
payaddress	1 2 3	bank payer payer beneficiary Only if wayofpayment = cheque.

Bank addresses

XML structure

Request

<address>
    <field2></field2>
    <field3></field3>
</address>

Response

<address>
    <field2></field2>
    <field3></field3>
</address>

Element name: address

Property name	Value	Description
field2	string(128)	Bank address.
field3	string(128)	Bank address number.

Remittance advice

XML structure

Request

<remittanceadvice>
    <sendtype></sendtype>
    <sendmail></sendmail>
</remittanceadvice>

Response

<remittanceadvice>
    <sendtype></sendtype>
    <sendmail></sendmail>
</remittanceadvice>

Element name: remittanceadvice

Property name	Value	Description
sendtype	ToFileManager ByEmail	To file manager By e-mail
sendmail	string(200)	E-mail address to which the remittance advice will be sent. Mandatory if sendtype = ByEmail.

Groups

XML structure

Request

<groups>
    <group></group>
</groups>

Response

<groups>
    <group shortname="" name=""></group>
</groups>

Element name: groups

Property name	Value	Description
group	string(16)	Sets the dimension group. See Dimension group.

Posting rules

Element name: postingrules

Property name	Value	Description
postingrule	node	Sets the posting rules of a dimension.

Posting rule

XML structure

Request

<postingrules>
    <postingrule id="1" status="">
        <currency></currency>
        <amount></amount>
        <description></description>
        <lines>
            <...>
        </lines>
    </postingrule>
</postingrules>

Response

<postingrules>
    <postingrule id="1" status="">
        <currency></currency>
        <amount></amount>
        <description></description>
        <lines>
            <...>
        </lines>
    </postingrule>
</postingrules>

Element name: postingrule

Property name	Value	Description
@id	integer	Sequence number of the posting rule. Fixed value 1.
@status	active deleted	For creating and updating active should be used. For deleting deleted should be used.
currency	code	Currency.
amount	amount	Amount.
description	string(40)	Description.
lines	node	Sets the posting rule lines.

Lines

XML structure

Request

<lines>
    <line>
        <office></office>
        <dimension1></dimension1>
        <dimension2></dimension2>
        <dimension3></dimension3>
        <ratio></ratio>
        <vatcode></vatcode>
        <description></description>
    </line>
</lines>

Response

<lines>
    <line>
        <office></office>
        <dimension1></dimension1>
        <dimension2></dimension2>
        <dimension3></dimension3>
        <ratio></ratio>
        <vatcode></vatcode>
        <description></description>
    </line>
</lines>

Element name: line

Property name	Value	Description
office	string(16)	Destination company.
dimension1	string(16)	General ledger.
dimension2	string(16)	Cost center.
dimension3	string(16)	Project or asset.
ratio	decimal	The ratio of the posting rule line.
vatcode	string(16)	VAT code.
description	string(40)	Description.

Payment conditions

XML structure

Request

<paymentconditions>
    <paymentcondition></paymentcondition>
</paymentconditions>

Response

<paymentconditions>
    <paymentcondition></paymentcondition>
</paymentconditions>

Element name: paymentconditions

Property name	Value	Description
paymentcondition	node	Sets the payment conditions of a dimension.

Payment condition

XML structure

Request

<paymentconditions>
    <paymentcondition>
        <discountdays></discountdays>
        <discountpercentage></discountpercentage>
    </paymentcondition>
</paymentconditions>

Response

<paymentconditions>
    <paymentcondition>
        <discountdays></discountdays>
        <discountpercentage></discountpercentage>
    </paymentcondition>
</paymentconditions>

Element name: paymentcondition

Property name	Value	Description
discountdays	integer	Number of discount days.
discountpercentage	decimal	Discount percentage.

Example

Request

<dimension>
    <office>001</office>
    <type>CRD</type>
    <code>2000</code>
    <name>Supplier 0</name>
    <shortname></shortname>
    <beginperiod>0</beginperiod>
    <beginyear>0</beginyear>
    <endperiod>0</endperiod>
    <endyear>0</endyear>
    <website></website>
    <financials>
        <matchtype>customersupplier</matchtype>
        <accounttype>inherit</accounttype>
        <subanalyse>false</subanalyse>
        <duedays>1</duedays>
        <level>2</level>
        <payavailable>true</payavailable>
        <meansofpayment>paymentfile</meansofpayment>
        <paycode>SEPANLCT</paycode>
        <substitutionlevel>1</substitutionlevel>
        <substitutewith>1600</substitutewith>
        <relationsreference>2000</relationsreference>
    </financials>
    <addresses>
        <address id="1" type="invoice" default="true">
            <name>Supplier 0</name>
            <country>NL</country>
            <city>Place 2000</city>
            <postcode>2000</postcode>
            <telephone>010-123452000</telephone>
            <telefax>010-12342000</telefax>
            <email>[email protected]</email>
            <field1>supplier 2000</field1>
            <field2>Streetname part 1 - 2000</field2>
            <field3>Streetname part 2000</field3>
            <field4></field4>
            <field5></field5>
            <field6></field6>
        </address>
    </addresses>
    <banks>
        <bank default="true" id="1">
            <ascription>Supplier 2000</ascription>
            <accountnumber>123456789</accountnumber>
            <address>
                <field2></field2>
                <field3></field3>
            </address>
            <bankname></bankname>
            <biccode>ABNANL2A</biccode>
            <city>Place 2000</city>
            <country>NL</country>
            <iban>NL02ABNA0123456789</iban>
            <natbiccode></natbiccode>
            <postcode></postcode>
            <state></state>
        </bank>
    </banks>
    <groups>
        <group>2REL</group>
    </groups>
    <postingrules>
        <postingrule id="1" status="active">
            <currency name="" shortname=""></currency>
            <amount />
            <description></description>
            <lines />
        </postingrule>
    </postingrules>
    <paymentconditions>
        <paymentcondition>
            <discountdays>5</discountdays>
            <discountpercentage>2.75</discountpercentage>
        </paymentcondition>
    </paymentconditions>
</dimension>

Response

<dimension status="active" result="1">
    <office name="001" shortname="001">001</office>
    <type name="Crediteuren" shortname="Crediteuren">CRD</type>
    <code>2000</code>
    <uid>c6c05844-c075-4b51-a4ca-6f30f45d5a12</uid>
    <name>Supplier 0</name>
    <shortname></shortname>
    <inuse>true</inuse>
    <behaviour>normal</behaviour>
    <touched>4</touched>
    <beginperiod>0</beginperiod>
    <beginyear>0</beginyear>
    <endperiod>0</endperiod>
    <endyear>0</endyear>
    <website></website>
    <cocnumber></cocnumber>
    <vatnumber></vatnumber>
    <editdimensionname>false</editdimensionname>
    <financials>
        <matchtype>customersupplier</matchtype>
        <accounttype>inherit</accounttype>
        <subanalyse>false</subanalyse>
        <duedays>1</duedays>
        <level>2</level>
        <payavailable>true</payavailable>
        <meansofpayment>paymentfile</meansofpayment>
        <paycode name="SEPANLCT" shortname="SEPA NL Excasso">SEPANLCT</paycode>
        <ebilling>false</ebilling>
        <ebillmail></ebillmail>
        <substitutionlevel>1</substitutionlevel>
        <substitutewith name="Crediteuren" shortname="Crediteuren" dimensiontype="BAS">1600</substitutewith>
        <relationsreference>2000</relationsreference>
        <vattype name="" shortname=""></vattype>
        <vatcode />
        <vatobligatory>false</vatobligatory>
        <performancetype />
        <collectmandate>
            <id></id>
            <signaturedate></signaturedate>
            <firstrundate></firstrundate>
        </collectmandate>
        <collectionschema />
    </financials>
    <addresses>
        <address id="1" type="invoice" default="true">
            <name>Supplier 0</name>
            <country name="Nederland" shortname="">NL</country>
            <city>Place 2000</city>
            <postcode>2000</postcode>
            <telephone>010-123452000</telephone>
            <telefax>010-12342000</telefax>
            <email>[email protected]</email>
            <contact></contact>
            <field1>supplier 2000</field1>
            <field2>Streetname part 1 - 2000</field2>
            <field3>Streetname part 2000</field3>
            <field4>155676842B01</field4>
            <field5></field5>
            <field6></field6>
        </address>
    </addresses>
    <banks>
        <bank default="true" id="1">
            <ascription>Supplier 2000</ascription>
            <accountnumber>123456789</accountnumber>
            <address>
                <field2></field2>
                <field3></field3>
            </address>
            <bankname></bankname>
            <biccode>TESTNL2A</biccode>
            <city>Place 2000</city>
            <country name="Nederland" shortname="">NL</country>
            <iban>NL13TEST0123456789</iban>
            <natbiccode></natbiccode>
            <postcode></postcode>
            <state></state>
        </bank>
    </banks>
    <groups>
        <group shortname="Relaties" name="Relaties">2REL</group>
    </groups>
    <paymentconditions>
        <paymentcondition>
        <discountdays>5</discountdays>
        <discountpercentage>2.75</discountpercentage>
        <paymentcondition>
    </paymentconditions>
</dimension>