API - Basic Submit

In general all API resources require below basic nodes as part of the submit structure.

Submit structure

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
    <contract>
        <contractcode></contractcode>
        <username></username>
        <password></password>
        <emailonerror></emailonerror>
        <emailonwarning></emailonwarning>
    </contract>
 
    <format></format>
    <testmode></testmode>
    <lang></lang>
    <inodes></inodes>
    <onodes></onodes>
    <order></order>
 
    <connector>
         <application>myapplication</application>
         <webkoppel>myplugin</webkoppel>
         <development>mydevelopment</development>
         <remark>myremark</remark>
         <sourceuri>https://my.source.uri/</sourceuri>
    </connector>
</myxml>

Applicable to all API

contractcode mandatory
Unique identifier for your Acumulus account. You can have multiple username/password combinations within a single contractcode. It is suggested to create a seperate username/password for each system you are using to connect to this API.


username mandatory
Username, used for identification.


password mandatory
Password, used for identification.


emailonerror mandatory
If set, errors raised are send to this address by email. Only a single email address is allowed.


emailonwarning mandatory
If set, warnings raised are send to this address by email. Only a single email address is allowed.


format
A case insensitive optional parameter to define in which type of format you would like to receive the response.

Option
Output format
 
json
JSON
 
xml
XML
DEFAULT


lang
Language for error and warning in responses.

Option
Description
en
English (Default)
nl
Dutch




API Specific

Below xml-nodes are only available in resources when explicitly mentioned. Please refer to call-specific documentation.

testmode
Numeric identifier for applying testmode. When using testmode no real changes are made but your input is being checked for warnings and errors.

Option
Behavior
 
0
Normal run
DEFAULT
1
No changes are made.
 

inodes
List of ";"-separated XML-node identifiers which should be included in the response. Defaults to full response when left out or empty.
Example #1: <inodes>NONE</inodes> if there is no need for the API to send a full response but only information about possible errors and warnings.
Example #2: <inodes>entryid;token;paymentstatus</inodes> for Get Entry Details when only these xml-nodes are of interest.

onodes
List of ";"-separated XML-node identifiers which can be used to influence the sorting of the response. Defaults to endpoint-specific sorting when left out or empty.
Example #2: <onodes>contactname;contactyourid;contactcity;</onodes> for List Contacts when sorting is wanted with contactname as primary sorting value.

order
Order to define sorting.

Option
Sorting order
def
API defined (Default)
inv
Inverted sorting