API - Manage Contact

Add or update your contact


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


Submit

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

contactid non mandatory
Supply a known contactid when applying updates to a specific contact.

contactyourid non mandatory
Identifier for your contact. Useful if you want cross-link against external systems or prefer to optionally print this alternative reference on invoices and packaging slips.
contactemail non mandatory

contacttype non mandatory

Option
Description
1
Debtor
2
Creditor
3
Debtor/Creditor (neutral) DEFAULT

overwriteifexists non mandatory
If a customer match has been made using the contactid as an identifier, all customer details wil be overwritten with the information provided within the request.

Option
Description
0
No update made DEFAULT
1
Overwrite all customer data

contactname1 non mandatory
Field for contact/company name and e.g. department.

contactname2 non mandatory
Additional fields for contact/company name and e.g. department.

contactperson non mandatory
Contact person.

contactsalutation non mandatory
Complete salutation e.g. "Geachte heer van der Molen" or "Beste Peter" without trailing comma. When not set it defaults to content set in the contact details in Acumulus or when those details are not set to: "Geachte mevrouw/heer".

contactaddress1 non mandatory
Address field.

contactaddress2 non mandatory
Address field.

contactpostalcode non mandatory
Address field.

contactcity non mandatory
City and optional country in capitals (Amsterdam NETHERLANDS).

contactlocationcode non mandatory

Option
Description
1
National (NL) DEFAULT
2
Within the EU
3
Outside of the EU

contactcountrycode non mandatory
Use international standard country code (ISO 3166-1) for countries in EU only (NL, DE etc). Defaults to NL when an empty or incorrect country code is supplied.

contactcountry non mandatory
Name of country. I.e. Nederland, Deutschland, France. Value will be enlisted on invoice.

contactvatnumber non mandatory/mandatory
VAT-number is mandatory when trying to set reverse charge of VAT. Also known as "verlegde BTW".

contactvatratebase non mandatory
Default vatrate for this contact.

Option
Description
-1
No VAT
0
0%
6
6%
19
19%
21
21% DEFAULT

contacttelephone non mandatory
Customer contact telephone number.

contactfax non mandatory
Customer contact fax number.

contactmark non mandatory
Extra label or mark e.g. "BSN: 1234.56.789".

contactinvoicetemplateid non mandatory
Default invoice templade identifier. Numeric value can be retrieved using Acumulus desktop application or API-pickllist.

contactstatus non mandatory

Option
Contact
0
non-active
1
active DEFAULT

contactiban non mandatory
Customer bank account or IBAN number.

contactbic non mandatory
Customer BIC number.

contactsepamandatenr non mandatory
The Unique SEPA-mandate number you assign to this contact.

contactsepamandatedate non mandatory
SEPA-mandate date. Date in YYYY-MM-DD format when your contact has given you a mandate for SEPA transfers.

contactsepaincassostatus non mandatory

Option
Contact
 
FRST
First
Default when empty of not supplied
RCUR
Recurring
 
OOFF
Single
 
FNAL
Final
 

contactinvoicenotes non mandatory
Multi-line text in order to display specific contact-related information on invoices for the contact in question. Both newlines and tabs are supported by using \n and \t.

contactabout non mandatory
Multi-line text to provide additional notes for the contact in question. Both newlines and tabs are supported by using \n and \t.


Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <contact>
        <contactid></contactid>
        <contactyourid></contactyourid>
        <contactemail></contactemail>
        <contactproc></contactproc>
    </contact>
    <errors>
        <count_errors></count_errors>
    </errors>
    <warnings>
        <count_warnings></count_warnings>
    </warnings>
    <status></status>
</response>

contactid
Numeric identifier for the contact.

contactemail
Contact email address.

contactyourid
Your identifier.

contactproc
Applied method of processing.

Value
Description
updated
Contact has been updated
added
Contact has been added to contact list