> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.ContactEntity

<h1 id="SuperOffice_WebApi_Data_ContactEntity">
  Class ContactEntity
</h1>

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for ContactEntity.
The Contact Service. The service implements all services working with the Contact object

```csharp theme={null}
public class ContactEntity : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[ContactEntity](SuperOffice.WebApi.Data.ContactEntity.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get ContactEntity 123 using the WebApi client:
\<pre>\<code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ContactAgent(configuration);
var contactEntity = agent.GetContactEntity( 123 );\</code>\</pre>

## Remarks

Use \<xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false">\</xref>:
All ContactEntity: \<pre>\<code class="lang-csharp">"SimpleContact"\</code>\</pre>
Activities: \<pre>\<code class="lang-csharp">"ContactActivity"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"contactId eq " + id\</code>\</pre>.
Appointments: \<pre>\<code class="lang-csharp">"Appointment"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"contactId eq " + id\</code>\</pre>.
Documents: \<pre>\<code class="lang-csharp">"Document"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"contactId eq " + id\</code>\</pre>.
Projects: \<pre>\<code class="lang-csharp">"ContactProjects"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"contactId eq " + id\</code>\</pre>.
Sales: \<pre>\<code class="lang-csharp">"SaleFilteredWithStakeholder"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"contactId eq " + id\</code>\</pre>.
Persons: \<pre>\<code class="lang-csharp">"Person"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"contactId eq " + id\</code>\</pre>.
Relations: \<pre>\<code class="lang-csharp">"Relation"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"source/restrictionContactId eq " + id\</code>\</pre>.
Tickets: \<pre>\<code class="lang-csharp">"Ticket"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"contactId eq " + id\</code>\</pre>.

## Constructors

<h3 id="SuperOffice_WebApi_Data_ContactEntity__ctor">
  ContactEntity()
</h3>

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public ContactEntity()
```

## Properties

<h3 id="SuperOffice_WebApi_Data_ContactEntity_ActiveErpLinks">
  ActiveErpLinks
</h3>

The number of active erp links

```csharp theme={null}
public virtual int ActiveErpLinks { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_ActiveInterests">
  ActiveInterests
</h3>

The number of active interests.

```csharp theme={null}
public virtual int ActiveInterests { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_ActiveStatusMonitorId">
  ActiveStatusMonitorId
</h3>

Active status monitor identity with the lowest rank for contact

```csharp theme={null}
public virtual int ActiveStatusMonitorId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Address">
  Address
</h3>

```csharp theme={null}
public virtual Address Address { get; set; }
```

#### Property Value

[Address](SuperOffice.WebApi.Data.Address.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Associate">
  Associate
</h3>

The user that owns this contact.
\<p>Use MDO List name "associate" to get list items.\</p>

```csharp theme={null}
public virtual Associate Associate { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_BounceEmails">
  BounceEmails
</h3>

Email addresses with a positive bounce counter.

```csharp theme={null}
public virtual string[] BounceEmails { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Business">
  Business
</h3>

The business that the contact is associated with. The GUI forces the user to enter a business type.
\<p>Use MDO List name "business" to get list items.\</p>

```csharp theme={null}
public virtual Business Business { get; set; }
```

#### Property Value

[Business](SuperOffice.WebApi.Data.Business.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Category">
  Category
</h3>

The category that is set on the company. The GUI forces the user to enter a category type
\<p>Use MDO List name "category" to get list items.\</p>

```csharp theme={null}
public virtual Category Category { get; set; }
```

#### Property Value

[Category](SuperOffice.WebApi.Data.Category.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_ContactId">
  ContactId
</h3>

Primary key

```csharp theme={null}
public virtual int ContactId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Country">
  Country
</h3>

The country this contact is located in. The country a contact is saved with, affects the phone number format, and the address layout.
\<p>Use MDO List name "country" to get list items.\</p>

```csharp theme={null}
public virtual Country Country { get; set; }
```

#### Property Value

[Country](SuperOffice.WebApi.Data.Country.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_CreatedBy">
  CreatedBy
</h3>

The user that created the contact

```csharp theme={null}
public virtual Associate CreatedBy { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_CreatedDate">
  CreatedDate
</h3>

Date registered

```csharp theme={null}
public virtual DateTime CreatedDate { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_CustomFields">
  CustomFields
</h3>

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.
Custom fields combines user defined fields and extra fields into one bucket.
The individual \<xref href="SuperOffice.WebApi.Data.ContactEntity.ExtraFields" data-throw-if-not-resolved="false">\</xref> and \<xref href="SuperOffice.WebApi.Data.ContactEntity.UserDefinedFields?text=UserDefinedFields" data-throw-if-not-resolved="false">\</xref> properties are deprecated in favor of this
combined collection.
The value string is the encoded value: "\[I:123]" or "\[DT:2019-09-11]".

```csharp theme={null}
public virtual StringDictionary CustomFields { get; set; }
```

#### Property Value

[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)

#### Remarks

The naming convention of the key string is as follows:
\<table>\<tbody>\<tr>\<td class="term">Extra field data\</td>\<td class="description">
\[Extra field name]\<p>\</p>
Example: \<pre>\<code class="lang-csharp">'x\_gorp' = '\[I:123]'\</code>\</pre>
\</td>\</tr>\<tr>\<td class="term">User defined field data\</td>\<td class="description">
\[Prog-id name]\<p>\</p>
Example: \<pre>\<code class="lang-csharp">'SuperOffice:1' = '\[I:123]'\</code>\</pre>\<p>\</p>
\</td>\</tr>\</tbody>\</table>

<h3 id="SuperOffice_WebApi_Data_ContactEntity_CustomerLanguage">
  CustomerLanguage
</h3>

customerlanguage

```csharp theme={null}
public virtual CustomerLanguage CustomerLanguage { get; set; }
```

#### Property Value

[CustomerLanguage](SuperOffice.WebApi.Data.CustomerLanguage.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_DbiAgentId">
  DbiAgentId
</h3>

Integration agent (eJournal)

```csharp theme={null}
public virtual int DbiAgentId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_DbiKey">
  DbiKey
</h3>

The primary key for the integrated entry in the external datasource.

```csharp theme={null}
public virtual string DbiKey { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_DbiLastModified">
  DbiLastModified
</h3>

When the entry was last modified.

```csharp theme={null}
public virtual DateTime DbiLastModified { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_DbiLastSyncronized">
  DbiLastSyncronized
</h3>

Last external syncronization.

```csharp theme={null}
public virtual DateTime DbiLastSyncronized { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Deleted">
  Deleted
</h3>

If nonzero, then this contact is 'deleted' and should generally not be shown

```csharp theme={null}
public virtual short Deleted { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Department">
  Department
</h3>

Department

```csharp theme={null}
public virtual string Department { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Description">
  Description
</h3>

Description of the contact. Usually shown as a postit note.

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Domains">
  Domains
</h3>

Web domains for this contact, ordered in array by rank

```csharp theme={null}
public virtual string[] Domains { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Emails">
  Emails
</h3>

The contact's email

```csharp theme={null}
public virtual EntityElement[] Emails { get; set; }
```

#### Property Value

[EntityElement](SuperOffice.WebApi.Data.EntityElement.md)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_ExtraFields">
  ExtraFields
</h3>

Deprecated: Use \<xref href="SuperOffice.WebApi.Data.ContactEntity.CustomFields" data-throw-if-not-resolved="false">\</xref> instead.
Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
The value string is the encoded value: "\[I:123]" or "\[DT:2019-09-11]".

```csharp theme={null}
public virtual StringDictionary ExtraFields { get; set; }
```

#### Property Value

[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)

#### Remarks

The naming convention of the key string is as follows:
\<table>\<tbody>\<tr>\<td class="term">Plug-in data\</td>\<td class="description">
\[Plug-in name].\[Property name]
Example: DocumentPlugin.DocumentType
\</td>\</tr>\<tr>\<td class="term">Foreign key data\</td>\<td class="description">
The device identity is appended directly to the device name if it exists.
This is not commonly used, but the database opens for this as a possibility to have several devices with the same name,
and hence we would ensure an unique key if this field is used.
Example: Audience.SecretService.DefaultCountry
\</td>\</tr>\<tr>\<td class="term">User defined table data\</td>\<td class="description">
\[Table name].\[Field name]
Example: Phunneling.AggregatedSales
\</td>\</tr>\<tr>\<td class="term">Other\</td>\<td class="description">
Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary.
We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
\</td>\</tr>\</tbody>\</table>

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Faxes">
  Faxes
</h3>

The contact's fax numbers

```csharp theme={null}
public virtual EntityElement[] Faxes { get; set; }
```

#### Property Value

[EntityElement](SuperOffice.WebApi.Data.EntityElement.md)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_GroupId">
  GroupId
</h3>

Group id of original owning associate, semantics like appnt.grp\_id

```csharp theme={null}
public virtual int GroupId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Interests">
  Interests
</h3>

The contact's available and selected interests.
\<p>Use MDO List name "contint" to get list items.\</p>

```csharp theme={null}
public virtual SelectableMDOListItem[] Interests { get; set; }
```

#### Property Value

[SelectableMDOListItem](SuperOffice.WebApi.Data.SelectableMDOListItem.md)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Kananame">
  Kananame
</h3>

Contact kana name, used in Japanese versions only

```csharp theme={null}
public virtual string Kananame { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Name">
  Name
</h3>

Contact name

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_NoMailing">
  NoMailing
</h3>

Spam filter. Indicates if this contact should retrieve advertising.

```csharp theme={null}
public virtual bool NoMailing { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Number1">
  Number1
</h3>

Alphanumeric user field

```csharp theme={null}
public virtual string Number1 { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Number2">
  Number2
</h3>

Alphanumeric user field

```csharp theme={null}
public virtual string Number2 { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_OrgNr">
  OrgNr
</h3>

VAT number or similar

```csharp theme={null}
public virtual string OrgNr { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Persons">
  Persons
</h3>

The persons belonging to the contact.

```csharp theme={null}
public virtual Person[] Persons { get; set; }
```

#### Property Value

[Person](SuperOffice.WebApi.Data.Person.md)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Phones">
  Phones
</h3>

The contact's phone numbers

```csharp theme={null}
public virtual EntityElement[] Phones { get; set; }
```

#### Property Value

[EntityElement](SuperOffice.WebApi.Data.EntityElement.md)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Source">
  Source
</h3>

How did we get this contact? For future integration needs

```csharp theme={null}
public virtual short Source { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_SupportAssociate">
  SupportAssociate
</h3>

\<p>Use MDO List name "associate" to get list items.\</p>

```csharp theme={null}
public virtual Associate SupportAssociate { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_SupportPerson">
  SupportPerson
</h3>

```csharp theme={null}
public virtual Person SupportPerson { get; set; }
```

#### Property Value

[Person](SuperOffice.WebApi.Data.Person.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_TicketPriority">
  TicketPriority
</h3>

\<p>Use MDO List name "ticketpriority" to get list items.\</p>

```csharp theme={null}
public virtual TicketPriority TicketPriority { get; set; }
```

#### Property Value

[TicketPriority](SuperOffice.WebApi.Data.TicketPriority.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_UpdatedBy">
  UpdatedBy
</h3>

The user that last updated the contact

```csharp theme={null}
public virtual Associate UpdatedBy { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_UpdatedDate">
  UpdatedDate
</h3>

Date last updated

```csharp theme={null}
public virtual DateTime UpdatedDate { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Urls">
  Urls
</h3>

The contact's internet adresses

```csharp theme={null}
public virtual EntityElement[] Urls { get; set; }
```

#### Property Value

[EntityElement](SuperOffice.WebApi.Data.EntityElement.md)\[]

<h3 id="SuperOffice_WebApi_Data_ContactEntity_UserDefinedFields">
  UserDefinedFields
</h3>

Deprecated: Use \<xref href="SuperOffice.WebApi.Data.ContactEntity.CustomFields" data-throw-if-not-resolved="false">\</xref> instead.
Dictionary of user defined field data.
The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:\[UdefFieldIdentity]", e.g. "SuperOffice:1234"
The value string is the encoded value: "\[I:123]" or "\[DT:2019-09-11]".

```csharp theme={null}
public virtual StringDictionary UserDefinedFields { get; set; }
```

#### Property Value

[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_UtmParameters">
  UtmParameters
</h3>

Utm parameters when creating first person and contact, readonly field

```csharp theme={null}
public virtual SavedUtmParameters UtmParameters { get; set; }
```

#### Property Value

[SavedUtmParameters](SuperOffice.WebApi.Data.SavedUtmParameters.md)

<h3 id="SuperOffice_WebApi_Data_ContactEntity_Xstop">
  Xstop
</h3>

STOP flag

```csharp theme={null}
public virtual bool Xstop { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

## See Also

[ContactAgent](SuperOffice.WebApi.Agents.ContactAgent.md),
[ArchiveAgent](SuperOffice.WebApi.Agents.ArchiveAgent.md),


## Related topics

- [SuperOffice.WebApi.Agents.ContactAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ContactAgent.md)
- [SuperOffice.WebApi.Agents.IContactAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IContactAgent.md)
- [SuperOffice.WebApi.Data.Contact EnrichContactEntityRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Contact_EnrichContactEntityRequest.md)
- [SuperOffice.WebApi.Data.Contact ValidateContactEntityRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Contact_ValidateContactEntityRequest.md)
- [SuperOffice.WebApi.Data.Contact ChangeCountryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Contact_ChangeCountryRequest.md)
- [SuperOffice.WebApi.Data.BizCard](/en/api/reference/webapi/SuperOffice.WebApi.Data.BizCard.md)