> ## Documentation Index
> Fetch the complete documentation index at: https://superofficeas-worktree-351-fix-webapi-escaped-anchors.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.AppointmentEntity

<h1 id="SuperOffice_WebApi_Data_AppointmentEntity">
  Class AppointmentEntity
</h1>

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

Carrier object for AppointmentEntity.
Appointments appear in the diary, and have links to a Contact/Person and possibly a Project or Sale. They have start and end time+date.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.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 AppointmentEntity 123 using the WebApi client:
\<pre>\<code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new AppointmentAgent(configuration);
var appointmentEntity = agent.GetAppointmentEntity( 123 );\</code>\</pre>

## Remarks

Use \<xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false">\</xref>:
All AppointmentEntity: \<pre>\<code class="lang-csharp">"FindAppointment"\</code>\</pre>
Participants: \<pre>\<code class="lang-csharp">"Participants"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"appointmentRestrictionId eq " + id\</code>\</pre>.
Links: \<pre>\<code class="lang-csharp">"Links"\</code>\</pre> with restriction \<pre>\<code class="lang-csharp">"sourceAppointmentRestrictionId eq " + id\</code>\</pre>.

## Constructors

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity__ctor">
  AppointmentEntity()
</h3>

Default constructor - defaults any enum props to 0.

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

## Properties

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_ActiveDate">
  ActiveDate
</h3>

The date to be used for searching & showing

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_ActiveLinks">
  ActiveLinks
</h3>

Number of active links to sale, document, appointment.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Agenda">
  Agenda
</h3>

The agenda of the appointment.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_AlarmLeadTime">
  AlarmLeadTime
</h3>

Alarm lead time.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_AppointmentId">
  AppointmentId
</h3>

Primary key

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_AssignedBy">
  AssignedBy
</h3>

Who assigned this appointment to this user? Whose diary did the appointment come from?

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus">
  AssignmentStatus
</h3>

Status if this appointment is in the process of being assigned to someone else
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public AssignmentStatus? AssignmentStatus { get; set; }
```

#### Property Value

[AssignmentStatus](SuperOffice.WebApi.Data.AssignmentStatus.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[AssignmentStatus\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus_String">
  AssignmentStatus\_String
</h3>

Status if this appointment is in the process of being assigned to someone else
Raw string enum value.

```csharp theme={null}
[JsonProperty("AssignmentStatus")]
public string AssignmentStatus_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[AssignmentStatus](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_AssignmentStatus)

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

The owner of the appointment - the associate whose diary/checklist the appointment is in.
\<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_AppointmentEntity_BookingType">
  BookingType
</h3>

The type of booking the appointment represents
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public BookingType? BookingType { get; set; }
```

#### Property Value

[BookingType](SuperOffice.WebApi.Data.BookingType.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[BookingType\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_BookingType_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_BookingType_String">
  BookingType\_String
</h3>

The type of booking the appointment represents
Raw string enum value.

```csharp theme={null}
[JsonProperty("BookingType")]
public string BookingType_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[BookingType](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_BookingType)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_CautionWarning">
  CautionWarning
</h3>

Status field to indicate appointments that have some sort of problem
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public AppointmentCautionWarning? CautionWarning { get; set; }
```

#### Property Value

[AppointmentCautionWarning](SuperOffice.WebApi.Data.AppointmentCautionWarning.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[CautionWarning\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_CautionWarning_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_CautionWarning_String">
  CautionWarning\_String
</h3>

Status field to indicate appointments that have some sort of problem
Raw string enum value.

```csharp theme={null}
[JsonProperty("CautionWarning")]
public string CautionWarning_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[CautionWarning](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_CautionWarning)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_CentralserviceVideomeetId">
  CentralserviceVideomeetId
</h3>

GUID for video meeting in central services – this is set when we create meetings from SuperOffice. It is blank for incoming meetings created from inbox.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_ColorIndex">
  ColorIndex
</h3>

Appointment colour, used only in Japanese versions. Western versions take colour from Task

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Completed">
  Completed
</h3>

Appointment Completed state. This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public ActivityStatus? Completed { get; set; }
```

#### Property Value

[ActivityStatus](SuperOffice.WebApi.Data.ActivityStatus.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Completed\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Completed_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Completed_String">
  Completed\_String
</h3>

Appointment Completed state. This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Completed")]
public string Completed_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Completed](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Completed)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Contact">
  Contact
</h3>

The contact associated with the appointment. It may also be null if no contact is associated with the appointment.
\<p>Use MDO List name "contact\_new" to get list items.\</p>

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

#### Property Value

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

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

The associate that first created the appointment. The property is read-only.

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

#### Property Value

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

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

Registered date

```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_AppointmentEntity_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.AppointmentEntity.ExtraFields" data-throw-if-not-resolved="false">\</xref> and \<xref href="SuperOffice.WebApi.Data.AppointmentEntity.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_AppointmentEntity_Description">
  Description
</h3>

Description of the appointment.

```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_AppointmentEntity_EndDate">
  EndDate
</h3>

Date + end time planned

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

#### Property Value

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

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

Deprecated: Use \<xref href="SuperOffice.WebApi.Data.AppointmentEntity.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_AppointmentEntity_HasAlarm">
  HasAlarm
</h3>

Does this appointment have an alarm

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_HasConflict">
  HasConflict
</h3>

Does the appointment overlap with another appointment in the user's diary?

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_InternalNotes">
  InternalNotes
</h3>

Internal notes for the appointment.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_InvitationStatus">
  InvitationStatus
</h3>

Status if this appointment represents an invitation
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public InvitationStatus? InvitationStatus { get; set; }
```

#### Property Value

[InvitationStatus](SuperOffice.WebApi.Data.InvitationStatus.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[InvitationStatus\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_InvitationStatus_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_InvitationStatus_String">
  InvitationStatus\_String
</h3>

Status if this appointment represents an invitation
Raw string enum value.

```csharp theme={null}
[JsonProperty("InvitationStatus")]
public string InvitationStatus_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[InvitationStatus](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_InvitationStatus)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_InvitedPerson">
  InvitedPerson
</h3>

If the appointment is a booking, the invited persons may be your associates, but you are also able to invite contact persons from other companies to join your meeting. They do not receive an invitation, unless you send them one by email, but you can see in the appointment that persons other than your associates have been invited to a meeting. Each invited person will have an appointment slave record.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_IsAlldayEvent">
  IsAlldayEvent
</h3>

True if all day event

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_IsFree">
  IsFree
</h3>

True if free, false if busy

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_IsMileStone">
  IsMileStone
</h3>

Is this appointment a milestone?

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_IsPublished">
  IsPublished
</h3>

Publication is published

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_JoinVideomeetUrl">
  JoinVideomeetUrl
</h3>

Blank when not a video meeting. Filled with Join Meeting URL when created.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_LagTime">
  LagTime
</h3>

as leadtime, but after the end - time blocked for travel etc.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_LeadTime">
  LeadTime
</h3>

Time blocked (minutes) BEFORE starttime

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Links">
  Links
</h3>

List of all elements linked to the appointment.

```csharp theme={null}
public virtual Link[] Links { get; set; }
```

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Location">
  Location
</h3>

Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_MotherAssociate">
  MotherAssociate
</h3>

The owner of the mother appointment - the associate whose diary/checklist the mother appointment is in.  The mother appointment is the one identified by the mother\_id. If the mother\_id is 0 or the same as this appointment\_id, then the master associate will be the same as the 'ordinary' associate.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_MotherId">
  MotherId
</h3>

ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. However, if 0 and assoc\_id != reg\_id then this is an assigned appointment, indicated vt type = kBooking

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_OwnedExternally">
  OwnedExternally
</h3>

Set if an external system owns this appointment.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public AppointmentExternalOwner? OwnedExternally { get; set; }
```

#### Property Value

[AppointmentExternalOwner](SuperOffice.WebApi.Data.AppointmentExternalOwner.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[OwnedExternally\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_OwnedExternally_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_OwnedExternally_String">
  OwnedExternally\_String
</h3>

Set if an external system owns this appointment.
Raw string enum value.

```csharp theme={null}
[JsonProperty("OwnedExternally")]
public string OwnedExternally_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[OwnedExternally](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_OwnedExternally)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Participants">
  Participants
</h3>

List of id's of the participants to this appointment.

```csharp theme={null}
public virtual ParticipantInfo[] Participants { get; set; }
```

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Person">
  Person
</h3>

An appointment may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required.
\<p>Use MDO List name "person" to get list items.\</p>

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_PreferredTZLocation">
  PreferredTZLocation
</h3>

Appointments preferred timezone location.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_PreferredTZLocationData">
  PreferredTZLocationData
</h3>

Read-only timezone data for PreferredTZLocation.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Priority">
  Priority
</h3>

It's possible to give appointments different priorities. All the different priority types are saved in the priority table, and edited from the Admin. Client. An appointment does not require a priority.
\<p>Use MDO List name "priority" to get list items.\</p>

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Private">
  Private
</h3>

The confidentiality of appointments is shown as different types of “private” on the appointment. For an updated list of “private” types, see the database manual.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public AppointmentPrivate? Private { get; set; }
```

#### Property Value

[AppointmentPrivate](SuperOffice.WebApi.Data.AppointmentPrivate.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Private\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Private_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Private_String">
  Private\_String
</h3>

The confidentiality of appointments is shown as different types of “private” on the appointment. For an updated list of “private” types, see the database manual.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Private")]
public string Private_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Private](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Private)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Project">
  Project
</h3>

An appointment may also be connected to a project, so you see the appointment both on the company card, and on the project card. This does not mean however that a project is required.
\<p>Use MDO List name "project" to get list items.\</p>

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_PublishEventDate">
  PublishEventDate
</h3>

Publish event date

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_PublishFrom">
  PublishFrom
</h3>

Publication valid from (inclusive)

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_PublishTo">
  PublishTo
</h3>

Publication valid to (inclusive)

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Recurrence">
  Recurrence
</h3>

The appointment recurrence.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_RejectCounter">
  RejectCounter
</h3>

How many invitees have rejected this appointment

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_RejectReason">
  RejectReason
</h3>

Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here
\<p>Use MDO List name "rejectReason" to get list items.\</p>

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Sale">
  Sale
</h3>

An appointment may also be connected to a sale, so you see the appointment on the company card, on the project card and on the sale card. This does not mean however that a sale is required.
\<p>Use MDO List name "sale" to get list items.\</p>

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_StartDate">
  StartDate
</h3>

date + start time planned

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_SuggestedAppointmentId">
  SuggestedAppointmentId
</h3>

Suggested guide item that this appointment is an instance of (Note: NOT VALID for document-type appointments, they have their own link)

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Task">
  Task
</h3>

Task comprises the different types of activities, like “Phone call”, “Meeting” and so on.
\<p>Use MDO List name "task" to get list items.\</p>

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Title">
  Title
</h3>

The title of the appointment.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Type">
  Type
</h3>

The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. See the different types of appointments in the database manual.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public AppointmentType? Type { get; set; }
```

#### Property Value

[AppointmentType](SuperOffice.WebApi.Data.AppointmentType.md)?

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Type\_String](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Type_String)

<h3 id="SuperOffice_WebApi_Data_AppointmentEntity_Type_String">
  Type\_String
</h3>

The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. See the different types of appointments in the database manual.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Type")]
public string Type_String { get; set; }
```

#### Property Value

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

#### See Also

[AppointmentEntity](SuperOffice.WebApi.Data.AppointmentEntity.md).[Type](SuperOffice.WebApi.Data.AppointmentEntity.md#SuperOffice_WebApi_Data_AppointmentEntity_Type)

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

The person that last updated the appointment.

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

#### Property Value

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

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

Updated date

```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_AppointmentEntity_UserDefinedFields">
  UserDefinedFields
</h3>

Deprecated: Use \<xref href="SuperOffice.WebApi.Data.AppointmentEntity.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_AppointmentEntity_VisibleFor">
  VisibleFor
</h3>

The set of users or groups the record is visible for

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

#### Property Value

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

## See Also

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