Acumulus API - Manage Contact

» Acumulus » API » Contacts » Manage Contact

API - Manage Contact

Add or update your contact

Resource:

/acumulus/stable/contacts/contact_manage.php

Since API:

Available for authenticated:

API invoerder

Available for authenticated:

API gebruiker

Available for authenticated:

API beheerder

Communication:

Basic submit, including below structure

Support voor testmode :

see: Basic submit

Support voor inodes :

see: Basic submit

Important note

For historical reasons, an update to a known contact using the contactid-node in this API
must be supplied with all XML-nodes in full. Omitted XML-nodes will therefor be considered
empty and will result in a clear, or reset of the value associated with the node as part of the
update proces. This applies to all XML-nodes.

Excluding the following:

contactinvoicetemplateid

Provide value of 0 to explicitly clear contents.

contactcostheadingid

Provide value of 0 to explicitly clear contents.

contactcostcenterid

Provide value of 0 to explicitly clear contents.

contactbankaccountid

Provide value of 0 to explicitly clear contents.

contactwebsite

Provide empty xml-node to clear.

contactbankaccountnumber

Provide empty xml-node to clear.

contactprivaterate

Provide empty xml-node to clear.

contactentrydescription

Provide empty xml-node to clear.

contactaltname1

Provide empty xml-node to clear.

contactaltname2

Provide empty xml-node to clear.

contactaltperson

Provide empty xml-node to clear.

contactaltaddress1

Provide empty xml-node to clear.

contactaltaddress2

Provide empty xml-node to clear.

contactaltpostalcode

Provide empty xml-node to clear.

contactaltcity

Provide empty xml-node to clear.

contactaltcountrycode

Provide empty xml-node to clear.

contactaltcountry

Provide empty xml-node to clear.

Submit

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
    ...
    <contact>
        <contactid></contactid>
        <contactyourid></contactyourid>
        <contactemail></contactemail>
        <contacttype></contacttype>
        <contactvattypeid></contactvattypeid>
        <overwriteifexists></overwriteifexists>
        <contactname1></contactname1>
        <contactname2></contactname2>
        <contactperson></contactperson>
        <contactsalutation></contactsalutation>
        <contactaddress1></contactaddress1>
        <contactaddress2></contactaddress2>
        <contactpostalcode></contactpostalcode>
        <contactcity></contactcity>
        <contactcountrycode></contactcountrycode>
        <contactcountry></contactcountry>
        <contactvatnumber></contactvatnumber>
        <contacttelephone></contacttelephone>
        <contacttelephone2></contacttelephone2>
        <contactfax></contactfax>
        <contactwebsite></contactwebsite>
        <contactmark></contactmark>
 
        <contactaltname1></contactaltname1>
        <contactaltname2></contactaltname2>
        <contactaltperson></contactaltperson>
        <contactaltaddress1></contactaltaddress1>
        <contactaltaddress2></contactaltaddress2>
        <contactaltpostalcode></contactaltpostalcode>
        <contactaltcity></contactaltcity>
        <contactaltcountrycode></contactaltcountrycode>
        <contactaltcountry></contactaltcountry>
 
        <contactstatus></contactstatus>
 
        <contactbankaccountnumber></contactbankaccountnumber>
        <contactiban></contactiban>
        <contactbic></contactbic>
        <contactsepamandatenr></contactsepamandatenr>
        <contactsepamandatedate></contactsepamandatedate>
        <contactsepaincassostatus></contactsepaincassostatus>
 
        <contactinvoicenotes></contactinvoicenotes>
        <contactabout></contactabout>
 
        <contactinvoicetemplateid></contactinvoicetemplateid>
        <contactvattype></contactvattype>
        <contactvatratebase></contactvatratebase>
        <contactcostheadingid></contactcostheadingid>
        <contactbankaccountid></contactbankaccountid>
    </contact>
</myxml>

contactid non mandatory / mandarory
Supply a valid contactid when applying updates to a specific contact.

contactyourid
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
Optional email adress for your contact. Use comma (,) or semicolon (;) separated addresses when multiple addresses need to be stored.

contacttype

Option

Description

1

Debtor

2

Creditor

3

Debtor/Creditor (neutral) DEFAULT

contactvattypeid
Numeric and strings describing name of the vattype of contact.

contactvattypeid

contactvattype

contactvattypenl

1

Private and/or VAT exempt

Particulier en/of btw-vrijgesteld

2

Business VAT taxable

Zakelijk btw-plichtig

overwriteifexists
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
Field for contact/company name and e.g. department.

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

contactperson
Contact person.

contactsalutation
Complete salutation e.g. "Geachte heer van der Molen" or "Beste Peter" without trailing comma. Defaults to: "Geachte mevrouw/heer".

contactaddress1
Address field.

contactaddress2
Address field.

contactpostalcode
Address field.

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

contactcountrycode
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
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".

contacttelephone
Customer contact telephone number.

contacttelephone2
Customer contact telephone2 number.

contactfax
Customer contact fax number.

contactwebsite
Customer contact website or reference.

contactwebsite will not be cleared on update when omitted.
Use empty xml-node to clear.

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

contactaltname1
Field for contact/company name and e.g. department.

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactaltname2
Additional fields for contact/company name and e.g. department.

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactaltperson
Contact person.

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactaltaddress1
Address field.

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactaltaddress2
Address field.

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactaltpostalcode
Address field.

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactaltcity
City and optional country in capitals (Amsterdam NETHERLANDS).

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactaltcountrycode
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.

will not be cleared on update when omitted.
Use empty xml-node to clear.

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

will not be cleared on update when omitted.
Use empty xml-node to clear.

contactstatus

Option

Contact

0

non-active

1

active DEFAULT

contactbankaccountnumber
Description of customer bank account.

contactbankaccountnumber will not be cleared on update when omitted.
Use empty xml-node to clear.

contactiban
Customer bank account or IBAN number.

contactbic
Customer BIC number.

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

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

contactsepaincassostatus

Option

Contact

FRST

First

Default when empty of not supplied

RCUR

Recurring

OOFF

Single

FNAL

Final

contactinvoicenotes
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
Multi-line text to provide additional notes for the contact in question. Both newlines and tabs are supported by using \n and \t.

XML-nodes that provide contact configuration settings/defaults

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

contactinvoicetemplateid node requires value of 0 to explicitly clear contents

contactvattype
Default vattype for the contact. Valid values can be found or via the API-pickllist for VAT types.

Option

Description

1

Regular invoice
Gewone factuur.

2

National reverse charge
BTW verlegd naar een Nederlandse ondernemer

3

European International reverse charge
Factuur naar een buitenlandse ondernemer binnen de EU.

4

International invoice outside of EU
Factuur buiten de EU

5

Margin-scheme
Marge-regeling

6

Foreign EU-VAT
Buitenlands EU BTW-tarief

contactvatratebase
Default vatrate for this contact.

Option

Description

-2

Various/mixed VAT

-1

No VAT

0

0%

6

6%

9

9%

19

19%

21

21%

DEFAULT

contactcostheadingid
Default costheading identifier. Numeric value can be retrieved using Acumulus desktop application or API-pickllist.

contactcostheadingid node requires value of 0 to explicitly clear contents

contactcostcenterid
Default costcenteridentifier. Numeric value can be retrieved using Acumulus desktop application or API-pickllist.

contactcostcenterid node requires value of 0 to explicitly clear contents

contactbankaccountid
Default account identifier. Numeric value can be retrieved using Acumulus desktop application or API-pickllist.

contactbankaccountid node requires value of 0 to explicitly clear contents

contactprivaterate
Default prefilled private rate when adding expenses associated with this contact. Min 0, max 100. Up to 2 decimals.

contactprivaterate will not be cleared on update when omitted.
Use empty xml-node to clear.

contactentrydescription
Default prefilled description when creating an entry. For invoices this is similar to the <invoicenote>-node in de "Invoice Add API". While for expenses the content of this field is used to prefil the <description>-node in the "Expense Add API".

contactentrydescription will not be cleared on update when omitted.
Use empty xml-node to clear.

Response

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

All known xml-nodes available for this endpoint will be returned with their set values. Including below.

contactproc
Applied method of processing.

Value

Description

added

Contact has been added to contact list

updated

Contact has been updated

unchanged

No changes has been made

testmode

Nothing has happened