ContactDto

Represents a person or contact within the tenant's organization.
Contacts can be associated with one or more clients and contain contact details such as name, email, and phone numbers.

Properties

Name	Type	Description
code	string	The unique code for this contact
The unique code for this contact
title	string	The contact's title (e.g., Mr, Mrs, Dr)
The contact's title (e.g., Mr, Mrs, Dr)
firstName	string	The contact's first name
The contact's first name
middleName	string	The contact's middle name
The contact's middle name
lastName	string	The contact's last name (required)
The contact's last name (required)
email	string	The contact's email address
The contact's email address
phone	string	The contact's phone number
The contact's phone number
mobile	string	The contact's mobile number
The contact's mobile number
dateOfBirth	string	The contact's date of birth
The contact's date of birth
utr	string	The contact's Unique Taxpayer Reference (Self Assessment UTR). Used for individuals' personal tax affairs.
The contact's Unique Taxpayer Reference (Self Assessment UTR). Used for individuals' personal tax affairs.
niNumber	string	The contact's National Insurance Number.
The contact's National Insurance Number.
personalCode	string	The contact's Companies House person ID code, used to uniquely identify an individual within the Companies House system.
The contact's Companies House person ID code, used to uniquely identify an individual within the Companies House system.
address	string	The contact's address. Only used when the client type is Individual.
The contact's address. Only used when the client type is Individual.
nationality	enum	Afghan Albanian Algerian American Andorran Angolan Antiguan Argentine Armenian Australian Austrian Azerbaijani Bahamian Bahraini Bangladeshi Barbadian Belarusian Belgian Belizean Beninese Bhutanese Bolivian Bosnian Botswanan Brazilian British Bruneian Bulgarian Burkinabe Burmese Burundian Cambodian Cameroonian Canadian CapeVerdean CentralAfrican Chadian Chilean Chinese Colombian Comoran Congolese CostaRican Croatian Cuban Cypriot Czech Danish Djiboutian Dominican Dutch EastTimorese Ecuadorean Egyptian Emirati EquatorialGuinean Eritrean Estonian Eswatini Ethiopian Fijian Filipino Finnish French Gabonese Gambian Georgian German Ghanaian Greek Grenadian Guatemalan Guinean GuineaBissauan Guyanese Haitian Honduran Hungarian Icelandic Indian Indonesian Iranian Iraqi Irish Israeli Italian Ivorian Jamaican Japanese Jordanian Kazakh Kenyan Kiribati Kuwaiti Kyrgyz Laotian Latvian Lebanese Liberian Libyan Liechtenstein Lithuanian Luxembourgish Macedonian Malagasy Malawian Malaysian Maldivian Malian Maltese Marshallese Mauritanian Mauritian Mexican Micronesian Moldovan Monegasque Mongolian Montenegrin Moroccan Mosotho Mozambican Namibian Nauruan Nepalese NewZealander Nicaraguan Nigerian Nigerien NorthKorean Norwegian Omani Pakistani Palauan Palestinian Panamanian PapuaNewGuinean Paraguayan Peruvian Polish Portuguese Qatari Romanian Russian Rwandan SaintKittsAndNevis SaintLucian Salvadoran Samoan SanMarinese SaoTomean Saudi Senegalese Serbian Seychellois SierraLeonean Singaporean Slovak Slovenian SolomonIslander Somali SouthAfrican SouthKorean SouthSudanese Spanish SriLankan Sudanese Surinamese Swedish Swiss Syrian Taiwanese Tajik Tanzanian Thai Togolese Tongan Trinidadian Tunisian Turkish Turkmen Tuvaluan Ugandan Ukrainian Uruguayan Uzbek Vanuatuan Vatican Venezuelan Vietnamese Vincentian Yemeni Zambian Zimbabwean
Afghan Albanian Algerian American Andorran Angolan Antiguan Argentine Armenian Australian Austrian Azerbaijani Bahamian Bahraini Bangladeshi Barbadian Belarusian Belgian Belizean Beninese Bhutanese Bolivian Bosnian Botswanan Brazilian British Bruneian Bulgarian Burkinabe Burmese Burundian Cambodian Cameroonian Canadian CapeVerdean CentralAfrican Chadian Chilean Chinese Colombian Comoran Congolese CostaRican Croatian Cuban Cypriot Czech Danish Djiboutian Dominican Dutch EastTimorese Ecuadorean Egyptian Emirati EquatorialGuinean Eritrean Estonian Eswatini Ethiopian Fijian Filipino Finnish French Gabonese Gambian Georgian German Ghanaian Greek Grenadian Guatemalan Guinean GuineaBissauan Guyanese Haitian Honduran Hungarian Icelandic Indian Indonesian Iranian Iraqi Irish Israeli Italian Ivorian Jamaican Japanese Jordanian Kazakh Kenyan Kiribati Kuwaiti Kyrgyz Laotian Latvian Lebanese Liberian Libyan Liechtenstein Lithuanian Luxembourgish Macedonian Malagasy Malawian Malaysian Maldivian Malian Maltese Marshallese Mauritanian Mauritian Mexican Micronesian Moldovan Monegasque Mongolian Montenegrin Moroccan Mosotho Mozambican Namibian Nauruan Nepalese NewZealander Nicaraguan Nigerian Nigerien NorthKorean Norwegian Omani Pakistani Palauan Palestinian Panamanian PapuaNewGuinean Paraguayan Peruvian Polish Portuguese Qatari Romanian Russian Rwandan SaintKittsAndNevis SaintLucian Salvadoran Samoan SanMarinese SaoTomean Saudi Senegalese Serbian Seychellois SierraLeonean Singaporean Slovak Slovenian SolomonIslander Somali SouthAfrican SouthKorean SouthSudanese Spanish SriLankan Sudanese Surinamese Swedish Swiss Syrian Taiwanese Tajik Tanzanian Thai Togolese Tongan Trinidadian Tunisian Turkish Turkmen Tuvaluan Ugandan Ukrainian Uruguayan Uzbek Vanuatuan Vatican Venezuelan Vietnamese Vincentian Yemeni Zambian Zimbabwean
maritalStatus	enum	Single Married CivilPartnership Divorced Widowed Separated
Single Married CivilPartnership Divorced Widowed Separated
isDeceased	boolean	Whether this contact is deceased
Whether this contact is deceased
deceasedDate	string	The date the contact was deceased, if known
The date the contact was deceased, if known
clientCount	integer	The number of clients this contact is associated with.
The number of clients this contact is associated with.
client	CodeAndNameDto
portalUser	CodeAndNameDto
individualClient	CodeAndNameDto

JSON Example

{
  "code": "string",
  "title": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string"
}

ContactDto

Properties

JSON Example

Used By Operations

Contained in Schemas