twinfield web services dimensions
Post on 02-Dec-2014
437 Views
Preview:
TRANSCRIPT
Twinfield Web services – Dimension Xml Page 1 of 36
Webservices – Dimensions
Twinfield v5.4
September 2010
Twinfield International NV
De Wel 20-b
3871 MV Hoevelaken
Netherlands
Twinfield Web services – Dimension Xml Page 2 of 36
Important message
No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any
means, photocopying, recording, or otherwise, without prior written consent of Twinfield.
This specification is provided “as is” without any express or implied warranty. If you submit any comments or
suggestions to Twinfield International NV, and Twinfield modifies the XML structure based on your input, Twinfield
shall own the modified XML version.
Information in this document is subject to change without notice.
contact information
Twinfield International N.V.
De Wel 20-b
3871 MV Hoevelaken
Tel. +31 (0)30-2982242
Fax. +31 (0)33-4677005
www.twinfield.com
info@twinfield.com
support: login page
https://login.twinfield.com
publish information
copyright © 2005 – 2010 - Twinfield International N.V.
version 1.3
Feedback can be send to: info@twinfield.com
Printed in the Netherlands on recycled paper or digitally published in Portable Document Format (PDF).
Twinfield Web services – Dimension Xml Page 3 of 36
Table of contents
Important message................................................................................................................. 2
contact information ................................................................................................................ 2
publish information ................................................................................................................. 2
Table of contents.................................................................................................................... 3
Preface .................................................................................................................................. 4
Audience and Prerequisites ..................................................................................................... 4
General Xml recommendations ............................................................................................... 5
Error handling ........................................................................................................................ 5
Field definitions ...................................................................................................................... 6
Attributes in the response Xml ................................................................................................ 6
Dimension types .................................................................................................................... 7
Example ................................................................................................................................. 12
Determine the next dimension code......................................................................................... 14
General Ledger accounts (GL accounts) ................................................................................. 15
Customers ............................................................................................................................. 19
Suppliers................................................................................................................................ 24
Payment and direct debit settings ........................................................................................... 28
Cost Centers .......................................................................................................................... 30
Project ................................................................................................................................... 32
Dimension actions .................................................................................................................. 35
Dimension read ...................................................................................................................... 36
International payments ........................................................................................................... 36
Twinfield Web services – Dimension Xml Page 4 of 36
Preface
This document describes the Xml message to add or modify users in Twinfield. The Xml messages, which are
described in this document, can be used by using the Twinfield ProcesXml Web service function. A full description
of the available Twinfield Web services can be downloaded from the F.A.Q. in Twinfield (see also the paragraph
“Related documents”).
Audience and Prerequisites
This document is intended for developers who are designing or developing Twinfield Web service enabled
applications.
The Twinfield User Interface (GUI) corresponds directly with the Twinfield Xml layer. When you need to build an
integration with Twinfield we strongly advice to „simulate‟ the interface (e.g. dimension settings and posting
journals) manually in Twinfield. The (error) messages generated by the Twinfield client are the same as the error
messages returned in the Web services response Xml messages.
Readers should have a working knowledge of the Twinfield concepts and HTTP, Xml, SOAP or
Web services communication standard. General information on Xml, SOAP or web services can be found on
http://www.w3schools.com
Related documents
Description of all available Twinfield Web services and Xml messages are described in the corresponding manuals.
These manuals can be downloaded from the F.A.Q. in Twinfield, with the keywords: Webservices, SOAP or XML.
Twinfield Web services – Dimension Xml Page 5 of 36
General Xml recommendations
The Twinfield Web services are based on Xml, which requires all documents to be well formed. If an Xml document
is not well formed it will raise an error event.
Xml Encoding
Xml documents may contain foreign characters, like Norwegian æ ø å , or French ê è é.
To let your Xml parser understand these characters, you should save your Xml documents as Unicode. The
preferred encoding is “ISO-8859-1”
<?xml version="1.0" encoding="ISO-8859-1"?>
Illegal Xml characters have to be replaced by entity references.
If you place a character like “<” inside an Xml element, it will generate an error because the parser interprets it as
the start of a new element. You cannot write something like this:
There are 5 predefined entity references in Xml:
Xml character Character Description
< < Less than
> > Greater than
& & Ampersand
' „ Apostrophe
" “ Quotation mark
Note: Only the characters “<” and “&” are strictly illegal in Xml. Apostrophes, quotation marks and greater than
signs are legal, but it is a good habit to replace them.
Error handling
Twinfield errors are reported in the form of a „result‟ attribute on the tags. If a posting is successfully executed, the
root-tag of the Xml-Document shows the attribute „result‟ with value „1‟. If a problem occurs during the posting, the
problem tag will show the attribute „result‟ with value „0‟. In addition two extra attributes are shown, namely „msg‟
with a description of the problem and „msgtype‟. The tags which are hierarchically „above‟ this tag will also have the
attribute „result‟ with value „0‟ (this also applies to the root-tag).
Twinfield Web services – Dimension Xml Page 6 of 36
Field definitions
Certain “tags” are of a fixed format, such as date and amount fields.
Type Format Description
BOOLEAN true/false True or Not true
DATE yyyymmdd ISO date format
MONEY 0.00 Full stop used as decimal separator.
PERIOD yyyy/mm Year/period
STRING(XX) Free text field with maximum xx characters
FIXED VALUE The element value is fixed to the given value.
CODE Restricted text field with maximum of 16
characters. The allowed characters are:
“A” to “Z” (uppercase),
“0” to 9,
“_” (underscore),
“-“ (hyphen) and
“+” (plus).
Twinfield code field. This field will be checked if
the corresponding master is available in
Twinfield.
INTEGER Numeric value, zero or greater
ENUMERATION Restricted value set The values allowed are described in inverted
commas with | used as the separator
After processing the Xml Twinfield will populate, on the CODE fields, extra attributes in the result Xml. For example
the dimension tags, „name‟ and „shortname‟ with the name and search name of the dimension.
Attributes in the response Xml
The following attributes can be added in the response Xml.
Type Format Description
result Result of the posting
0 = not successful, 1= successful
ENUMERATION (1|0)
msg Notification about why the posting failed STRING
msgtype Notification type; warning or error ENUMERATION (“warning|error”)
name Name of the Twinfield master STRING
shortname Short name of the Twinfield master STRING
type Type of dimension (only for dimensions) STRING
inuse Have financial transactions been posted to this dimension BOOLEAN (“true|false”)
vatcode Reserved; only for dimensions
vatobligatory Reserved; only for dimensions
Twinfield Web services – Dimension Xml Page 7 of 36
Dimension types
Menu path: Accounting>Dimensions>Type
o General Ledger
o Balance, code BAS
o Profit & Loss, code PNL
o Relations
o Customers, code DEB
o Suppliers, code CRD
o Cost centers, code KPL
o Fixed assets, code AST
o Projects, code PRJ
Screen in Twinfield
Twinfield Web services – Dimension Xml Page 8 of 36
Description of the dimension type XML elements
Tag Parent node Description Type definition
dimensiontype - root node -
office dimensiontype Office code CODE, optional
code dimensiontype Dimensiontype CODE, mandatory
mask dimensiontype Dimension mask CODE, optional
name dimensiontype Dimension type name STRING(36), optional
shortname dimensiontype Dimension type shortname STRING(20), optional
addresses dimensiontype node -
label1 – label6 addresses Address labels, description of field1 –
field6 in the dimension address element
STRING(20), optional
levels dimensiontype node - (read only)
financials levels Financial level INTEGER, read only
time levels Level in time & expenses INTEGER, read only
fixedassets levels Level in fixed assets (future use) INTEGER, read only
invoices levels Level in invoice articles (future use) INTEGER, read only
Example
This example changes the dimension mask to “1####” for the Customers (DEB) dimension type.
Request
<?Xml version="1.0" encoding="ISO-8859-1"?>
<dimensiontype>
<office>0000</office>
<code>DEB</code>
<mask>1####</mask>
<name>Customers</name>
</dimensiontype>
Twinfield Web services – Dimension Xml Page 9 of 36
Response XML
<dimensiontype status="active" result="1">
<office name="Webshop JJLammers.com" shortname="">0000</office>
<code>DEB</code>
<mask>1####</mask>
<name>Customers</name>
<shortname>AR</shortname>
<touched>2</touched>
<levels>
<financials>2</financials>
<time>0</time>
<fixedassets>0</fixedassets>
<invoices>0</invoices>
</levels>
<address>
<label1>foa</label1>
<label2>Address</label2>
<label3>Postal address</label3>
<label4>VAT nummer</label4>
<label5>COC nummer</label5>
<label6 />
</address>
</dimensiontype>
Twinfield Web services – Dimension Xml Page 10 of 36
Dimension groups
Screen in Twinfield
Corresponding XML node: dimensiongroup
Corresponding XML node: dimensions/dimension
Structure of the dimension group elements
Tag Attributes Description Occurs
<dimensiongroups> result="1"
result="0"
msg=""
OK
Not OK, an error occurred, see also Error
handling
1
<dimensiongroup> status=”active|deleted” The status of the dimension group. 1-
<dimensions> 0,1
<dimension/> 0-
</dimensions>
</dimensiongroup>
</dimensiongroups>
Twinfield Web services – Dimension Xml Page 11 of 36
Description of the dimension group elements
Tag Parent node Description Type definition
dimensiongroups - root node -
dimensiongroup dimensiongroups node -
office dimensiongroup Office code CODE, mandatory
code dimensiongroup Dimensiontype CODE, mandatory
name dimensiongroup Dimension type name STRING(36), optional
shortname dimensiongroup Dimension type shortname STRING(20), optional
dimensions dimensiongroup node - optional
dimension dimensions node - optional
type dimension Dimension type CODE
code dimension Dimension code CODE
Twinfield Web services – Dimension Xml Page 12 of 36
Example
This example creates a new dimension group and adds the customer 1001 to this dimension group.
<?Xml version="1.0" encoding="ISO-8859-1"?>
<dimensiongroup>
<office>0000</office>
<code>LOC_CUST</code>
<name>Customers</name>
<dimensions>
<dimension>
<type>DEB</type>
<code>1001</code>
</dimension>
</dimensions>
</dimensiongroup>
Response XML
<dimensiongroup status="active" result="1">
<office name="Webshop JJLammers.com" shortname="">0000</office>
<code>LOC_CUST</code>
<name>Local customers</name>
<shortname />
<touched>1</touched>
<dimensions>
<dimension>
<type name="Customers" shortname="Customers">DEB</type>
<code name="Customer 1001" shortname="">1001</code>
</dimension>
</dimensions>
</dimensiongroup>
Twinfield Web services – Dimension Xml Page 13 of 36
Dimensions
Menu path: Accounting>Dimensions>Manage
Structure of the dimensions XML
Tag Attributes Description Occur
<dimensions> result="1"
result="0"
msg=""
OK
An error occurred, see also Error
handling
1
<dimension> status=”active|hidden” 1-
<financials> 0,1
<childvalidations> 0-
<childvalidation/> type=”code|group|type”
level=”1|2|3|4”
Validiate against Dimension code, -
group or –type
Dimension level
1
</childvalidations>
</financials>
<addresses> 0,1
<address/> id="xx"
default=”true|false”
type="invoice|postal|cont
act"
Sequence number
Default address
Address type
0-
</addresses>
<banks> 0,1
<bank/> id="xx"
default="true/false"
Sequence number
Default bank
0-
<address/> 0,1
</banks>
<creditmanagement/> 0,1
<groups> 1
<group/> 0-
</groups>
<invoicing/> 1
<postingrules> 0,1
<postingrules> 0-
<lines> 0,1
<line/> 0-
</lines> 0,1
</postingrules> 0-
</dimension>
</dimensions>
Twinfield Web services – Dimension Xml Page 14 of 36
Determine the next dimension code
The option “next free code” is added to the dimension Xml. When the code field is not added to the dimension Xml,
Twinfield will determine the code which must be used.
Example Request Xml
<?xml version="1.0"?>
<dimension>
<office>0000</office>
<type>KPL</type>
<name>Sales & Markerting</name>
</dimension>
Response Xml
<?xml version="1.0"?>
<dimension status="active" result="1">
<office name="Webshop JJLammers.com" shortname="">0000</office>
<type name="Cost center" shortname="Kostenplaatsen">KPL</type>
<name>Sales & Markerting</name>
<code>00004</code>
<editdimensionname>true</editdimensionname>
<financials>
<level>2</level>
<matchtype>notmatchable</matchtype>
<accounttype>inherit</accounttype>
<subanalyse>maybe</subanalyse>
<payavailable>false</payavailable>
<paycode></paycode>
<ebilling>false</ebilling>
<ebillmail></ebillmail>
<duedays>0</duedays>
<relationsreference></relationsreference>
<substitutionlevel>0</substitutionlevel>
<substitutewith></substitutewith>
<vatobligatory>false</vatobligatory>
<performancetype/>
<vatcode name="" shortname="" type=""></vatcode>
<vattype name="" shortname=""></vattype>
</financials>
</dimension>
Twinfield Web services – Dimension Xml Page 15 of 36
General Ledger accounts (GL accounts)
- Balance
- Profit & Loss
This documentation only the BAS Dimension type will be described, the PNL dimension type has the same XML
structure. Only the fixed value of the “type” element is different, PNL (=Profit & Loss).
Screens in Twinfield
Corresponding XML node: dimension
Corresponding XML node: banks/bank
Corresponding XML node: groups/group
Corresponding XML node: dimension financials and for the validation rules the corresponding XML node is:
childvalidations/childvalidation
Twinfield Web services – Dimension Xml Page 16 of 36
Description of the General Ledger elements
Tag Parent node Description Type definition
dimensions - root node - (optional)
dimension dimensions node -
office dimension Office code CODE, optional
code dimension dimension code, must be compliant with
the mask in the Dimension type
CODE, optional (see:
“Determine the next dimension
code”)
type dimension Dimension type, fixed to BAS or PNL FIXED VALUE
name dimension STRING(40)
beginyear dimension INTEGER
beginperiod dimension INTEGER
endyear dimension INTEGER
endperiod dimension INTEGER
banks dimension node -
bank bank node -
ascription bank Description of the (bank) account number STRING(40)
accountnumber bank Local bank account number STRING(40)
groups dimension node - (optional)
group groups CODE, optional
financials dimension node -
subanalyse financials Is subanalyse to a customer, supplier or
cost center needed.
ENUMERATION:
- true
- false
- maybe
matchtype financials Sets the GL account match able value.
The preferred value for suspense
accounts is “matchable”.
ENUMERATION:
- not matchable
- matchable
- relation
vattype financials Type vat code, for future use -
vatcode financials Default VAT code, for future use CODE, optional
vatobligatory financials Is the VAT code obligatory, for future use BOOLEAN
childvalidations financials node -
Twinfield Web services – Dimension Xml Page 17 of 36
Tag Parent node Description Type definition
childvalidation childvalidations Validation rule when sub analyses to a
customer, supplier or cost center is
needed.
type attrubute of
childvalidation
Validation to which Dimension type. ENUMERATION:
- code (=dimension code)
- type (= Dimension type)
- group (=dimension group)
level attrubute of
childvalidation
Financial level ENUMERATION:
- 1 (=GL account)
- 2 (= customer, supplier or
cost center)
- 3 (=project or asset)
- 4 (= project activity)
Example
This example adds a new Balance sheet account, “3101 Work in Progress - Consultants” in Twinfield. In this
example we add also a validation rule. In the Twinfield input function the user must also enter a cost center and
project when posting a journal on this GL account.
Request
<?Xml version="1.0" encoding="ISO-8859-1"?>
<dimension>
<office>0000</office>
<code>3101</code>
<type>BAS</type>
<name>Work in Progress - Consultants</name>
<financials>
<subanalyse>true</subanalyse>
<childvalidations>
<childvalidation type="type" level="2">KPL</childvalidation>
<childvalidation type="type" level="3">PRJ</childvalidation>
</childvalidations>
</financials>
<groups>
<group>GLB30</group>
<group>SLB30.20</group>
</groups>
</dimension>
Twinfield Web services – Dimension Xml Page 18 of 36
Response XML
<dimension status="active" result="1">
<office name="Webshop JJLammers.com" shortname="">0000</office>
<code>3101</code>
<type name="Balans" shortname="Balans">BAS</type>
<inuse>false</inuse>
<shortname />
<name>Work in Progress - Consultants</name>
<behaviour>system</behaviour>
<touched>0</touched>
<beginperiod>0</beginperiod>
<beginyear>0</beginyear>
<endperiod>0</endperiod>
<endyear>0</endyear>
<website />
<vatnumber />
<cocnumber />
<inuse>false</inuse>
<financials>
<matchtype>notmatchable</matchtype>
<accounttype>balance</accounttype>
<subanalyse>true</subanalyse>
<duedays>0</duedays>
<level>1</level>
<payavailable>false</payavailable>
<paycode name="" shortname="" />
<ebilling>false</ebilling>
<ebillmail />
<substitutionlevel>0</substitutionlevel>
<substitutewith />
<relationsreference />
<vattype name="" shortname="" />
<vatcode name="" shortname="" />
<vatobligatory>false</vatobligatory>
<childvalidations>
<childvalidation type="type" level="2">KPL</childvalidation>
<childvalidation type="type" level="3">PRJ</childvalidation>
</childvalidations>
</financials>
<groups>
<group shortname="Stock" name="Stock">GLB30</group>
<group shortname="WIP" name="Work in Progress">SLB30.20</group>
</groups>
</dimension>
Twinfield Web services – Dimension Xml Page 19 of 36
Customers
Screens in Twinfield
Corresponding XML node: dimension
Corresponding XML node: addresses/address
Corresponding XML node: banks/bank. This customer is linked to the Dutch Clieop direct debit “payment file”. The
bank settings are be different per payment (or direct debit) file. A full description can be found in the chapter:
International payments.
Corresponding XML node: financials
Twinfield Web services – Dimension Xml Page 20 of 36
Corresponding XML node: creditmanagement
Corresponding XML node: invoicing
Corresponding XML node: postingrules
Description of the customer elements
Tag Parent node Description Type definition
dimensions - root node - (optional)
dimension dimensions node -
office dimension Office code CODE
code dimension dimension code, must be compliant
with the mask in the Dimension type
CODE, optional (“Determine
the next dimension code”)
type dimension Dimension type, fixed to DEB FIXED VALUE
name dimension Name of the customer STRING(40)
website dimension Website STRING(40)
addresses dimension node -
address addresses node -
Twinfield Web services – Dimension Xml Page 21 of 36
Tag Parent node Description Type definition
id attribute of
address
Sequence number INTEGER
type attribute of
address
Address type ENUMERATION:
- invoice
- postal
- contact
default attribute of
address
Is this the default address, only one
default address is possible
Boolean
name address Company name STRING(80)
field1 – field6 address User defined fields, the labels are
configured in the Dimension type.
STRING(40)
postcode address Postal code STRING(40)
city address City STRING(40)
country address ISO country code. STRING(2)*
telephone address STRING(15)
telefax address STRING(15)
email address E-mail address STRING(128)
banks dimension node -
bank banks node -
ascription bank Name of the account number holder
accountnumber bank Bank account number
city bank City of the account number holder
financials dimension node -
duedays financials INTEGER
payavailable financials Is a direct debit possible? BOOLEAN
paycode financials Direct Debit code CODE
vattype financials Type vat code, for future use -
vatcode financials Default VAT code, for future use CODE
vatobligatory financials Is the VAT code obligatory, for future
use
BOOLEAN
substitutewith financials Default customer GL account. CODE
Twinfield Web services – Dimension Xml Page 22 of 36
Tag Parent node Description Type definition
ebilling financials Send the invoice per email to the
customer.
BOOLEAN
ebillmail financials E-mail address to send the invoice to. STRING(128)
creditmanagement dimension node -
basecreditlimit creditmanagement
responsibleuser creditmanagement Credit manager CODE
sendreminder creditmanagement Remind BOOLEAN
blocked creditmanagement Are the related projects for this
customer blocked in Projects>Data
entry
BOOLEAN
freetext1 creditmanagement Usage rights BOOLEAN
freetext2 creditmanagement Segment code STRING(20)
comment creditmanagement Comments TEXT
invoicing dimension node -
discountarticle invoicing Item (discount article) CODE
Example
This example creates a new customer “10020 - Morgan Limited” in Twinfield.
Request XML
<?Xml version="1.0" encoding="ISO-8859-1"?>
<dimension>
<code>10020</code>
<name>Morgan Limited</name>
<type>DEB</type>
<website>www.yourdomain.com</website>
<addresses>
<address default="true" type="invoice">
<field1>FAO Mr J.P. Morgan</field1>
<field2>Streetname</field2>
<field3 />
<postcode>1234 AB</postcode>
<city>Berlin</city>
<country>DE</country>
<telephone>010-12345</telephone>
<telefax>010-1234</telefax>
<field4>VAT12345</field4>
Twinfield Web services – Dimension Xml Page 23 of 36
<email>jpmorgan@yourdomain.com</email>
</address>
</addresses>
<banks>
<bank default="true">
<ascription>Morgan Ltd.</ascription>
<accountnumber>123456</accountnumber>
<city>Berlin</city>
</bank>
</banks>
<financials>
<duedays>30</duedays>
<payavailable>true</payavailable>
<paycode>250NL</paycode>
<ebilling>true</ebilling>
<ebillmail>bills@yourdomain.com</ebillmail>
</financials>
<creditmanagement>
<sendreminder>true</sendreminder>
<responsibleuser />
<basecreditlimit />
<comment />
<freetext1 />
<freetext2 />
<blocked />
</creditmanagement>
<invoicing>
<discountarticle />
</invoicing>
</dimension>
Twinfield Web services – Dimension Xml Page 24 of 36
Suppliers
Screen in Twinfield:
Corresponding XML node: dimension
Corresponding XML node: addresses/address
Corresponding XML node: banks/bank. This customer is linked to the Dutch Clieop direct debit “payment file”. The
bank settings are be different per payment (or direct debit) file. A full description can be found in the chapter:
International payments.
Corresponding XML node: financials
Twinfield Web services – Dimension Xml Page 25 of 36
Description of the supplier elements
Tag Parent node Description Type definition
dimensions - root node - (optional)
dimension dimensions Node -
office dimension Office code CODE
code dimension dimension code, must be compliant with
the mask in the Dimension type
CODE, optional (“Determine the
next dimension code”)
type dimension Dimension type, fixed to CRD CODE, mandatory
name dimension Name of the supplier STRING(40)
website dimension Website STRING(40)
addresses dimension node -
address addresses node -
id attribute of
address
Sequence number INTEGER
type attribute of
address
Address type ENUMERATION:
- invoice
- postal
- contact
default attribute of
address
Is this the default address, only one
default address is possible
BOOLEAN
name address Company name STRING(80)
field1 – field6 address User defined fields, the labels are
configured in the dimension type.
STRING(40)
postcode address Postal code STRING(40)
city address City STRING(40)
country address ISO country code. STRING(2)
telephone address STRING(15)
telefax address STRING(15)
email address E-mail address STRING(128)
banks dimension node -
bank banks node -
ascription bank Name of the account number holder STRING(40)
Twinfield Web services – Dimension Xml Page 26 of 36
Tag Parent node Description Type definition
accountnumber bank Bank account number STRING(40)
city bank City of the account number holder STRING(40)
financials dimension node -
duedays financials INTEGER
payavailable financials Is a payment possible? BOOLEAN
paycode financials Payment code CODE
vattype financials Type vat code, for future use -
vatcode financials Default VAT code, for future use CODE
vatobligatory financials Is the VAT code obligatory, for future use - (BOOLEAN)
relationsreference financials Customer reference, your customer
number by the supplier
STRING(40)
substitutewith financials Default supplier GL account. CODE
Example
This example creates a new supplier “2001 – Vodafone Ltd.” in Twinfield.
<?Xml version="1.0" encoding="ISO-8859-1"?>
<dimension>
<code>2001</code>
<type>CRD</type>
<name>Vodafone Ltd.</name>
<addresses>
<address default="true" type="invoice">
<field1>FAO Mr J.P. Hone</field1>
<field2>145 Streetname</field2>
<postcode>EC1V 4UK </postcode>
<city>London</city>
<country>GB</country>
<telephone>010-12345</telephone>
<telefax>010-1234</telefax>
<field4>VAT12345</field4>
<email>JPhone@vodaf.com</email>
</address>
</addresses>
<banks>
<bank default="true">
<ascription>Vodafone Ltd.</ascription>
<accountnumber>98745</accountnumber>
<city>London</city>
Twinfield Web services – Dimension Xml Page 27 of 36
</bank>
</banks>
<financials>
<duedays>14</duedays>
<payavailable>true</payavailable>
<paycode>250NL</paycode>
<relationsreference>2345</relationsreference>
</financials>
</dimension>
Twinfield Web services – Dimension Xml Page 28 of 36
Payment and direct debit settings
Corresponding XML node: dimension
m = mandatory a = available x = not available or required
NL
(DOM)
NL
(INT)
NL
(INT) DE
DE
(INT)
IE
(DOM)
FI
(DOM)
AT
(DOM)
AT
(INT) GENERIC
FI
(INT)
FI
(INT)
BANK FIELDS Xmlfield
NO
PA
YM
EN
T
TY
PE
CLIE
OP
03
BTL91 - IB
AN
BTL91 - N
ON
IBA
N
DTA
US
DTA
ZV
EM
TS
LM
02
PA
YM
UL
(D
OM
)
PA
YM
UL
(IN
T)
TW
FP
AY
*
ULM
P -
IB
AN
ULM
P -
NO
N
IBA
N
Account holder ascription m m m a m a m m m a country* m a
Account number accountnumber
NON-
IBAN m a a m a m m m a a a a
Address address/field1 x x m m x
x x x x x m m
No. address/field2 x x m m x
x x x x x m m
Bank name bankname a x m m x a x x a a a a a
BIC code biccode IBAN x m
x a x x a a country* m a
Branch
a a m m x a a a a a a a a
Country
BOTH NL m m m a IE m AT a m a m
IBAN iban IBAN x m a x a x x a a a m a
National bank code natbiccode
NON-
IBAN x a a a a m x m a country* m a
Number
a x m m x a x x a a a a a
Postcode postcode a x a a x a x x a a a a a
State state a x a a x a x x a a a a a
Way of payment wayofpayment x x a a x x x x x x x x x
Pay address payaddress x x a a x x x x x x x x x
* mandatory fields are determined on country level
Twinfield Web services – Dimension Xml Page 29 of 36
NL
(DOM)
NL
(INT)
NL
(INT) DE
DE
(INT)
IE
(DOM)
FI
(DOM)
AT
(DOM)
AT
(INT) GENERIC
FI
(INT)
FI
(INT)
ADDRESS FIELDS Xmlfield
NO
PA
YM
EN
T
TY
PE
CLIE
OP
03
BTL91 - IB
AN
BTL91 - N
ON
IBA
N
DTA
US
DTA
ZV
EM
TS
LM
02
PA
YM
UL
(D
OM
)
PA
YM
UL
(IN
T)
TW
FP
AY
*
ULM
P -
IB
AN
ULM
P -
NO
N
IBA
N
Address
x x x x x x x x x x m m
City
x x m m x x x x x x m m
Country
x x m m x x x x x x m m
Twinfield Web services – Dimension Xml Page 30 of 36
Cost Centers
Screen in Twinfield:
Corresponding XML node: dimension
Description of the cost center elements
Tag Parent node Description Type definition
dimensions - root node - (optional)
dimension dimensions node -
office dimension Office code CODE, optional
code dimension Dimension code, must be compliant with
the mask in the Dimension type
CODE, optional (“Determine the
next dimension code”)
type dimension Dimension type, fixed to KPL FIXED VALUE
name dimension Dimension name STRING(40)
Example
This example creates a new cost center “00001 - Sales & Marketing” in Twinfield
Request XML
<?Xml version="1.0" encoding="ISO-8859-1"?>
<dimension>
<office>0000</office>
<code>00001</code>
<type>KPL</type>
<name>Sales & Markerting</name>
</dimension>
Twinfield Web services – Dimension Xml Page 31 of 36
Response XML
<dimension status="active" result="1">
<office name="Webshop JJLammers.com" shortname="">0000</office>
<code>00001</code>
<type name="Cost Center" shortname="">KPL</type>
<name>Sales & Markerting</name>
<inuse>false</inuse>
<shortname />
<behaviour>normal</behaviour>
<touched>0</touched>
<beginperiod>0</beginperiod>
<beginyear>0</beginyear>
<endperiod>0</endperiod>
<endyear>0</endyear>
<website />
<vatnumber />
<cocnumber />
<inuse>false</inuse>
<financials>
<level>2</level>
<matchtype>notmatchable</matchtype>
<accounttype>inherit</accounttype>
<subanalyse>maybe</subanalyse>
<payavailable>false</payavailable>
<paycode />
<ebilling>false</ebilling>
<ebillmail />
<duedays>0</duedays>
<relationsreference />
<substitutionlevel>0</substitutionlevel>
<substitutewith />
<vatobligatory>false</vatobligatory>
<vatcode />
<vattype />
</financials>
</dimension>
Twinfield Web services – Dimension Xml Page 32 of 36
Project
Screen in Twinfield:
Corresponding XML node: dimension
Corresponding XML node: financials
Corresponding XML node: projects
Description of the project elements
Tag Parent node Description Type definition
dimensions - root node - (optional)
dimension dimensions node -
office dimension Office code CODE, optional
code dimension Dimension code, must be compliant with
the mask in the Dimension type
CODE, optional (“Determine
the next dimension code”)
type dimension Dimension type, fixed to PRJ FIXED VALUE
name dimension Dimension name STRING(40)
Twinfield Web services – Dimension Xml Page 33 of 36
Tag Parent node Description Type definition
financials dimension node -
substitutionlevel financials Dimension level, fixed to 2 FIXED VALUE
substitutewith financials Cost center code CODE
projects dimension node -
invoicedescription projects Invoice description STRING(256)
startdate projects Valid date (from) DATE
enddate projects Valid date (to) DATE
authoriser projects Authoriser CODE
authoriser@locked projects Attribute BOOLEAN
customer projects Customer CODE
customer@locked projects Attribute; Can the customer code be
changed during input
BOOLEAN
billable projects Billable BOOLEAN
billable@locked projects Attribute; Can the billable option be
changed during input
BOOLEAN
billable@inherit projects Attribute BOOLEAN
billable@forratio projects Attribute BOOLEAN
quantities projects node -
quantity quantities node -
mandatory quantity Use quantities BOOLEAN
label quantity Preferred label STRING(40)
rate quantity The project (quantity) rate code CODE
billable quantity Are the quantities billable BOOLEAN
billable@locked quantity BOOLEAN
Twinfield Web services – Dimension Xml Page 34 of 36
Example
This example creates a new project “P001 - Consultancy” in Twinfield
Request XML
<?Xml version="1.0" encoding="ISO-8859-1"?>
<dimension>
<office>0000</office>
<code>P001</code>
<type>PRJ</type>
<name>Consultancy</name>
<financials>
<substitutionlevel>2</substitutionlevel>
<substitutewith>00001</substitutewith>
</financials>
</dimension>
Twinfield Web services – Dimension Xml Page 35 of 36
Dimension actions
This chapter describes the methods to delete or hide a dimension in Twinfield. When a journal entry has been posted
on a dimension the deleted status is not available. To prevent users to post journals in the future to this dimension
you need to hide this dimension.
Description of the dimension actions elements
Tag Parent node Description Type definition
dimensions - root node - (optional)
dimension dimensions node -
status attribute of
dimension
Delete or hides a dimension in Twinfield.
When a dimension is hidden you can
enable the dimension by setting the status
to “active”.
ENUMERATION:
- deleted
- hide
- active
office dimension Office code CODE, optional
code dimension Dimension code, must be compliant with
the mask in the Dimension type
CODE, mandatory
type dimension Dimension type, fixed to KPL CODE, mandatory
Example
This example deletes customer 1000 in office 0000, hide customer 1001 in the current office and re-enables
customer 1002.
Request Xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<dimensions>
<dimension status="deleted"> <!-- Delete dimension -->
<office>0000</office>
<code>1000</code>
<type>DEB</type>
</dimension>
<dimension status="hide"> <!-- Hide dimension -->
<type>DEB</type>
<code>1001</code>
</dimension>
<dimension status="active"> <!-- Save/re-enable -->
<type>DEB</type>
<code>1002</code>
</dimension>
</dimensions>
Twinfield Web services – Dimension Xml Page 36 of 36
Dimension read
This example reads the dimension setting of customer (DEB) 1000 in office 001. More information about the read
Xml message is described in the manual: “Twinfield Web Services”
Request Xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<read>
<type>dimensions</type>
<office>001</office>
<dimtype>DEB</dimtype>
<code>1000</code>
</read>
International payments
Twinfield supports several payment formats, each payment format can have a different
top related