v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

Contact

Create a new contact

Creates a new contact. For adding addresses and communication ways, you will need to use the ContactAddress and CommunicationWay endpoints.

post/Contact

Request body

namestring nullable

The organization name. Be aware that the type of contact will depend on this attribute. If it holds a value, the contact will be regarded as an organization.

statusinteger nullable

Defines the status of the contact. 100 <-> Lead - 500 <-> Pending - 1000 <-> Active.

customerNumberstring nullable

The customer number

surenamestring nullable

The first name of the contact. Yeah... not quite right in literally every way. We know. Not to be used for organizations.

familynamestring nullable

The last name of the contact. Not to be used for organizations.

titelstring nullable

A non-academic title for the contact. Not to be used for organizations.

descriptionstring nullable

A description for the contact.

academicTitlestring nullable

A academic title for the contact. Not to be used for organizations.

genderstring nullable

Gender of the contact. Not to be used for organizations.

name2string nullable

Second name of the contact. Not to be used for organizations.

birthdaystring date nullable

Birthday of the contact. Not to be used for organizations.

vatNumberstring nullable

Vat number of the contact.

bankAccountstring nullable

Bank account number (IBAN) of the contact.

bankNumberstring nullable

Bank number of the bank used by the contact.

defaultCashbackTimeinteger nullable

Absolute time in days which the contact has to pay his invoices and subsequently get a cashback.

defaultCashbackPercentnumber float nullable

Percentage of the invoice sum the contact gets back if he paid invoices in time.

defaultTimeToPayinteger nullable

The payment goal in days which is set for every invoice of the contact.

taxNumberstring nullable

The tax number of the contact.

taxOfficestring nullable

The tax office of the contact (only for greek customers).

exemptVatboolean nullable

Defines if the contact is freed from paying vat.

defaultDiscountAmountnumber float nullable

The default discount the contact gets for every invoice. Depending on defaultDiscountPercentage attribute, in percent or absolute value.

defaultDiscountPercentageboolean nullable

Defines if the discount is a percentage (true) or an absolute value (false).

buyerReferencestring nullable

Buyer reference of the contact.

governmentAgencyboolean nullable

Defines whether the contact is a government agency (true) or not (false).

Example request

{
  "customerNumber": "Customer-1337",
  "parent": {
    "objectName": "Contact"
  },
  "surename": "John",
  "familyname": "Snow",
  "titel": "Commander",
  "category": {
    "id": 3,
    "objectName": "Category"
  },
  "description": "Rightful king of the seven kingdoms",
  "name2": "Targaryen"
}

Response

Created - Returns created contact

idstring

The contact id

objectNamestring

The contact object name

createstring date-time

Date of contact creation

updatestring date-time

Date of last contact update

namestring

The organization name. Be aware that the type of contact will depend on this attribute. If it holds a value, the contact will be regarded as an organization.

statusstring

Defines the status of the contact. 100 <-> Lead - 500 <-> Pending - 1000 <-> Active.

customerNumberstring

The customer number

surenamestring

The first name of the contact. Yeah... not quite right in literally every way. We know. Not to be used for organizations.

familynamestring

The last name of the contact. Not to be used for organizations.

titelstring

A non-academic title for the contact. Not to be used for organizations.

descriptionstring

A description for the contact.

academicTitlestring

A academic title for the contact. Not to be used for organizations.

genderstring

Gender of the contact. Not to be used for organizations.

name2string

Second name of the contact. Not to be used for organizations.

birthdaystring date

Birthday of the contact. Not to be used for organizations.

vatNumberstring

Vat number of the contact.

bankAccountstring

Bank account number (IBAN) of the contact.

bankNumberstring

Bank number of the bank used by the contact.

defaultCashbackTimestring

Absolute time in days which the contact has to pay his invoices and subsequently get a cashback.

defaultCashbackPercentstring float

Percentage of the invoice sum the contact gets back if he paid invoices in time.

defaultTimeToPaystring

The payment goal in days which is set for every invoice of the contact.

taxNumberstring

The tax number of the contact.

taxOfficestring

The tax office of the contact (only for greek customers).

exemptVatstring

Defines if the contact is freed from paying vat.

defaultDiscountAmountstring float

The default discount the contact gets for every invoice. Depending on defaultDiscountPercentage attribute, in percent or absolute value.

defaultDiscountPercentagestring

Defines if the discount is a percentage (true) or an absolute value (false).

buyerReferencestring

Buyer reference of the contact.

governmentAgencystring

Defines whether the contact is a government agency (true) or not (false).

additionalInformationstring

Additional information stored for the contact.

Example response

{
  "id": "0",
  "objectName": "Contact",
  "name": "string",
  "status": "100",
  "customerNumber": "Customer-1337",
  "parent": {
    "id": "0",
    "objectName": "Contact"
  },
  "surename": "John",
  "familyname": "Snow",
  "titel": "Commander",
  "category": {
    "id": "3",
    "objectName": "Category"
  },
  "description": "Rightful king of the seven kingdoms",
  "sevClient": {
    "objectName": "SevClient"
  },
  "name2": "Targaryen",
  "defaultCashbackTime": "string",
  "defaultCashbackPercent": "string",
  "defaultTimeToPay": "string",
  "taxOffice": "string",
  "exemptVat": "false",
  "defaultDiscountAmount": "string",
  "defaultDiscountPercentage": "false",
  "buyerReference": "string",
  "governmentAgency": "false",
  "additionalInformation": "string"
}