CompanyContactCard

One contact card of a company: a person attached to it (parentUid)

uidstring | nullnullable

Uid of the person. Absent on PUT for a card to create.

Example: 030f134a-fb24-4a16-8acb-d29d9ba50077

namestring | nullnullablerequired

Name of the contact (its single "Nom du contact"). On PUT a changed name becomes the lastName and clears the firstName.

Example: Mr Smith

functionstring | nullnullable

Function or service of the contact

Example: Gardien

isPrimaryContactboolean

Whether this contact is the company's primary contact. At most one card is true; omitted means false.

Example: true

phoneNumber object

Primary phone number of the contact, null if none. A card needs a phone number or an email. On PUT, a new value replaces the phone number the card showed and null removes it; the person's other phone numbers are kept, so after a removal the next stored one becomes primary and is shown on the card.

oneOf

• CompanyContactCoordinate
• null

valuestring | nullnullable

Phone number or email. On PUT, a coordinate without value counts as none.

Example: 0472000000

typestring | nullnullable

Qualifier of the coordinate. On PUT, a null or blank type keeps the type already stored for that value; a new value without type is stored without one.

Example: LANDLINE

email object

Primary email of the contact, null if none. A card needs a phone number or an email. On PUT, a new value replaces the email the card showed and null removes it; the person's other emails are kept, so after a removal the next stored one becomes primary and is shown on the card.

oneOf

• CompanyContactCoordinate
• null

valuestring | nullnullable

Phone number or email. On PUT, a coordinate without value counts as none.

Example: 0472000000

typestring | nullnullable

Qualifier of the coordinate. On PUT, a null or blank type keeps the type already stored for that value; a new value without type is stored without one.

Example: LANDLINE

contractCountinteger<int32>

Number of contracts the contact is linked to, terminated ones included. A contact linked to a contract cannot be left out of a PUT (409). Ignored on PUT.

Example: 0

CompanyContactCard

{
  "uid": "030f134a-fb24-4a16-8acb-d29d9ba50077",
  "name": "Mr Smith",
  "function": "Gardien",
  "isPrimaryContact": true,
  "phoneNumber": {
    "value": "0472000000",
    "type": "LANDLINE"
  },
  "email": {
    "value": "0472000000",
    "type": "LANDLINE"
  },
  "contractCount": 0
}