API - List contacts

List the available contacts / contactoverzicht


Resource:
/acumulus/stable/contacts/contacts_list.php
Since API:
Authentication:
API user
Communication:
Basic submit, including below structure


Submit

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
	...
	<contacttype></contacttype>
   <contactstatus></contactstatus>
   <filter></filter>
   <offset></offset>
   <rowcount></rowcount>
</myxml>

filter non mandatory
The filter tag can be used as a search string for the list to match against. It checks against the names, city, address and postal-code your contact.

offset non mandatory
Numeric offset tag can be used to jump into the results. Say you have 40 contacts and you want to skip the first 12 in the results you simply provide an offset of 12. The maximum offset number is the amount of contacts matched.

rowcount non mandatory
Numeric tag that defines the amount of results you want returned. If the rowcount number exceeds the amount of contacts it simply returns the maximum amount of contacts. The default is to return all rows, which the call can be forced to when setting the rowcount to 0.

contactstatus non mandatory
Numeric value. The contactstatus tag allows you choose which contacts to be listed.

Value
Description
0
Disabled contacts
1
Active contacts
2
All contacts DEFAULT

contacttype non mandatory
Numeric value. The contacttype tag allows you choose a specific type of contacts to be listed. The numeric values correspond to those available from the contacttypes picklist.

Contact Type
Description
1
Debiteur (klant)
2
Crediteur (leverancier)
3
Relatie

Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <contacts>
        <contact>
            <contactid></contactid>
            <contactyourid></contactyourid>
            <contactname></contactname>
            <contactname1></contactname1>
            <contactname2></contactname2>
            <contactstatus></contactstatus>
            <contacttypeid></contacttypeid>
            <contacttypename></contacttypename>
            <contactperson></contactperson>
            <contactaddress1></contactaddress1>
            <contactaddress2></contactaddress2>
            <contactcity></contactcity>
            <contacttelephone></contacttelephone>
            <contactemail></contactemail>
            <contactcountrycode></contaccountrycode>
        </contact>
        ...
    </contacts>
</response>

contactid
Integer.

contactyourid
Your numeric identifier for the contact. Defaults to 0 when empty.

contactname
Name of contact. Depends on content in contactname1 and contactname2 fields. Provides either contactname1 or contactname2 in response.

contactname1
Primary name for contact.

contactname2
Secondary or additional name for contact.

contactstatus
0 for disabled contacts, 1 for active contacts.

contacttypeid
contacttypename
contactperson
contactaddress1
contactaddress2
contactcity
contacttelephone
contactemail
contactcountrycode