Skip to main content

General ledger accounts

Dimension types BAS and PNL

info

In this documentation only the balance sheet (BAS) dimension type will be described, the profit and loss (PNL) dimension type has the same XML structure. Only the fixed value of the type element is different, PNL instead of BAS.

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 IDFields searched
0code and name
1code
2name

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

OptionTypeDescription
office«office code»Restricts to the office.
levelenumeration: 1, 2, 3, 4, 5, 6Specifies the dimension level. Normally the level of balance sheets is level 1.
sectionfinancialsRestricts to financial or time & expenses dimensions.
dimtypeBAS or PNLShows the general ledger account dimensions.
modifiedsincestring yyyyMMddHHmmss or yyyyMMddRestricts to dimensions modified after, on or at the specified date (and time).
group«group code»Specifies the dimension group (wildcards allowed).
includehidden0 (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 balance account (BAS) dimension EXAMPLE.

<read>
    <type>dimensions</type>
    <office>001</office>
    <dimtype>BAS</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>
    <groups></groups>
    <banks></banks>
</dimension>

Element name: dimension

NameDescription
dimensionContains information general to the dimension.
financialsContains the financial settings of the dimension.
groupsContains the dimension groups the dimension is part of.
banksNot in use.

Dimension​

XML structure
<dimension>
    <office></office>
    <type></type>
    <code></code>
    <name></name>
    <shortname></shortname>
    <beginperiod></beginperiod>
    <beginyear></beginyear>
    <endperiod></endperiod>
    <endyear></endyear>
</dimension>

Element name: dimension

Property nameValueDescription
@statusactive
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.
officecodeOffice code.
typecodeDimension type. See Dimension type.
Dimension type of balances accounts is BAS.
codecodeDimension code, must be compliant with the mask of the BAS Dimension type.
uidstringUnique identification of the dimension.
Read-only attribute.
namestring(80)Name of the dimension.
shortnamestring(20)Short name of the dimension.
inusetrue
false		Indicates if the balance account is used in a financial transaction or linked to a VAT code or linked to an article or not in use at all.
Read-only attribute.
behaviournormal
system
template		Determines the behaviour of dimensions.
Read-only attribute.
touchedintegerCount of the number of times the dimension settings are changed.
Read-only attribute.
beginperiodintegerDetermines together with beginyear the period from which the dimension may be used.
beginyearintegerDetermines together with beginperiod the period from which the dimension may be used.
endperiodintegerDetermines together with endyear the period till which the dimension may be used.
endyearintegerDetermines together with endperiod the period till which the dimension may be used.
websiteNot in use.
cocnumberNot in use.
vatnumberNot in use.
editdimensionnameNot in use.

Financials​

XML structure
<financials>
    <matchtype></matchtype>
    <accounttype></accounttype>
    <subanalyse></subanalyse>
    <vatcode></vatcode>
    <childvalidations>
        <...>
    </childvalidations>
</financials>

Element name: financials

Property nameValueDescription
matchtypenotmatchable
matchable		Sets the matchable value of the balance account.
accounttypecodeRead-only attribute. Will be automatically generated because of supplied dimension type
subanalysetrue
false
maybe		Is subanalyses needed.
duedaysNot in use.
levelintegerSpecifies the dimension level. Normally the level of balance accounts is level 1.
Read-only attribute.
payavailableNot in use.
meansofpaymentNot in use.
paycodeNot in use.
ebillingNot in use.
ebillmailNot in use.
substitutionlevelNot in use.
substitutewithNot in use.
relationsreferenceNot in use.
vattypeNot in use.
vatcodestring(16)Default VAT code.
vatobligatoryNot in use.
performancetypeNot in use.
collectmandateNot in use.
collectionschemaNot in use.
childvalidationsnodeValidation rule when subanalyses is needed.

VAT code​

XML structure
<vatcode name="" shortname="" type="" fixed="false"></vatcode>

Element name: vatcode

Property nameValueDescription
@namestring(40)Name of the VAT.
@shortnamestring(20)Short name of the VAT.
@typepurchase
sales		Type of the VAT.
@fixedtrue
false		When true, users are no longer able to use other VAT-codes on this account.

Child validations​

XML structure
<childvalidations>
    <childvalidation type="" level=""></childvalidation>
</childvalidations>

Element name: childvalidation

Property nameValueDescription
typecode (= dimension code)
type (= dimension type)
group (= dimension group)		Validation on dimension code, dimension type or dimension group.
level0 (= only in case type is group)
1 (= balance accounts)
2 (= customer, supplier, cost center)
3 (= project, asset)
4 (= activity)		Financial level.

Groups​

XML structure
<groups>
    <group></group>
</groups>

Element name: groups

Property nameValueDescription
groupstring(16)Sets the dimension group. See Dimension group.

Banks​

Element name: banks

Not in use.

Example​

<dimension>
    <office>001</office>
    <type>BAS</type>
    <code>1310</code>
    <name>Customers</name>
    <shortname>Customers</shortname>
    <financials>
        <matchtype>notmatchable</matchtype>
        <accounttype>balance</accounttype>
        <subanalyse>true</subanalyse>
        <childvalidations>
            <childvalidation type="type" level="2">DEB</childvalidation>
        </childvalidations>
    </financials>
    <groups>
        <group>2REL</group>
    </groups>
</dimension>