Mandatory properties

The following parameters must be transmitted every time a transaction is created or updated

  • forename
  • surname
  • companyname (only in case of a company)
  • email
  • address
    • street
    • street_number
    • postal_code
    • city
    • country

Sample

{
    "contact": {
        "salutation": "Mr",
        "title": "Dr.",
        "forename": "John",
        "surname": "Doe",
        "companyname": "Example Inc.",
        "dob": "1901-02-03",
        "email": "example@example.com",
        "phone": "0049-123-456789",
        "mobile": "0049-987-654321",
        "address": {
            "street": "Example Street",
            "street_number": "6a",
            "postal_code": "01234",
            "city": "Examplecity",
            "country": "DE"
        }
    }
}

Properties

NameTypeDescriptionSampleFormatNotes
contactModel\Contact


contact.forenamestringForename of the contact personJohn
mandatory
contact.surnamestringSurname of the contact personDoe
mandatory
contact.companynamestringCompany nameExample Inc.
mandatory (only in case of a company)
contact.salutationstring

Form of address

Mr"Mr", "Ms", ...recommended
contact.genderstring

Gender

m"m", "f", "d", ...
contact.titlestringAristocratic or Academic titlesDr.

contact.emailstring

Email

mail@example.comE.123mandatory
contact.phonestring

Phone

+49 4321 567890E.123recommended
contact.mobilestring

Mobile

+49 123 987654321E.123
contact.faxstring

Fax

+49 4321 567891E.123
contact.dobstring

Date of birth

1950-12-25ISO 8601 (YYYY-MM-DD)recommended
contact.picturestringThe document id of an user picture
(To upload the picture use our document service.)


not recommended
contact.url_websitestring

URL to website

www.example.comRFC 1738
contact.birthplacestringBirthplaceBerlin

contact.nationalitystring

Nationality

DEISO 3166-1 (alpha-2)
contact.addressModel\AddressAddress


contact.address.typestringAddress-Typeinvoice
recommended
contact.address.streetstringStreetExample Street
mandatory
contact.address.street_numberstringStreet number6a
mandatory
contact.address.citystringCityExamplecity
mandatory
contact.address.postal_codestringPostal code01234
mandatory
contact.address.countrystring

Country

DEISO 3166-1 (alpha-2)mandatory