API - Get contact details

Retrieve detailed contact information / contactinformatie


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


Submit

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
    ...
    <contactid></contactid>
</myxml>

contactid mandatory
Numeric identifier for the contact you are trying to retrieve detailed information for. You can find these numeric identifiers in both Acumulus and by using the contacts picklist API-call.


Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <contact>
        <contactid></contactid>
        <contactyourid></contactyourid>
        <contactname1></contactname1>
        <contactname2></contactname2>
        <contacttype></contacttype>
        <contacttypename></contacttypename>
        <contactperson></contactperson>
        <contactsalutation></contactsalutation>
        <contactaddress1></contactaddress1>
        <contactaddress2></contactaddress2>
        <contactpostalcode></contactpostalcode>
        <contactcity></contactcity>
        <contactcountrycode></contactcountrycode>
        <contactcountry></contactcountry>
        <contacttelephone></contacttelephone>
        <contactfax></contactfax>
        <contactemail></contactemail>
        <contactwebsite></contactwebsite>
        <contactbankaccountnumber></contactbankaccountnumber>
        <contactiban></contactiban>
        <contactbic></contactbic>
        <contactmark></contactmark>
        <contactvatnumber></contactvatnumber>
        <contactvatratebase></contactvatratebase>
        <contactinvoicetemplateid></contactinvoicetemplateid>
        <contactabout></contactabout>
        <contactinvoicenotes></contactinvoicenotes>
        <contactsepamandatenr></contactsepamandatenr>
        <contactsepamandatedate></contactsepamandatadate>
        <contactsepaincassostatus></contactsepaincassostatus>
        <contactstatus></contactstatus>
    </contact>
</response>

A single contact data set is returned.

contactid
Numeric identifier for the contact.

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

contactname1
Primary contact name (in CDATA format).

contactname1
Secondary contact name (in CDATA format).

contacttype
Numeric reference to the type of contact. Also available through picklist API-call.

contacttype
contacttypename
1
Debiteur (klant)
2
Crediteur (leverancier)
3
Relatie

contacttypename
String descriptive name of the type of contact. Also available through picklist API-call (in CDATA format).

contacttypeid
contacttypename
1
Debiteur (klant)
2
Crediteur (leverancier)
3
Relatie

contactperson
Name of the contact (in CDATA format).

contactsalutation
Complete salutation for the contact (in CDATA format).

contactaddress1
Address field (in CDATA format).

contactaddress2
Address field (in CDATA format).

contactpostalcode
Address field (in CDATA format).

contactcity
City and optional country in capitals (Amsterdam NETHERLANDS) (in CDATA format).

contactcountrycode
International standard country code (ISO 3166-1).

contactcountry
Name of the country (in CDATA format).

contacttelephone
Contact telephone number (in CDATA format).

contactfax
Contact fax number (in CDATA format).

contactemail
Contact email address (in CDATA format).

contactwebsite
Contact website (in CDATA format).

contactbankaccountnumber
Contact bank account number (in CDATA format).

contactiban
Contact IBAN number (in CDATA format).

contactbic
Contact BIC number (in CDATA format).

contactmark
Contact extra label or mark, useful for i.e. "BSN: 1234.56.789" (in CDATA format).

contactvatnumber
Contact VAT number (in CDATA format).

contactvatratebase
Default VAT value for the contact.

contactinvoicetemplateid
Selected invoicetemplate for the contact.

contactabout
Contact specific information or remarks (in CDATA format).

contactinvoicenotes
Notes to appear on invoices for this contact

contactsepamandatenr
Unique number assigned to this contact for SEPA-incasso transactions.

contactsepamandatedate
Date in YYYY-MM-DD format starting the mandate given by this contact for SEPA-incasso transactions. Displays as 0000-00-00 when empty or not set.

contactsepaincassostatus
Current status for this contact applicable to SEPA-incasso transactions. One of FRST, RCUR, OOFF or FNAL.

contactstatus
Status of the contact. Either 0 or 1.

Option
Description
0
Inactive/Locked contact. Not available or linkable for new entries.
Existing entries not affected
1
Contact active.