| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
The internal id of the client. |
integer |
- |
| ClientName |
The name of the client. |
string |
- |
| EmployeeId |
The internal id of the employee who owns the appointment. |
integer |
Nullable |
| EmployeeName |
The name of the employee who owns the appointment. |
string |
- |
| StatusChangedByName |
The name of the employee who changed the status of the appointment. |
string |
- |
| StatusChangedById |
The id of the employee who changed the status of the appointment. |
integer |
- |
| CreatedByName |
The name of the employee who created the appointment. |
string |
- |
| CreatedById |
The id of the employee who created the appointment. |
integer |
- |
| StartDate |
The start date of the appointment. |
date |
- |
| EndDate |
The end date of the appointment. |
date |
- |
| Subject |
The subject of the appointment. |
string |
- |
| AppointmentType |
The type of the appointment. |
string |
- |
| Reason |
The given reason when the appointment is completed or cancelled. |
string |
- |
| Remarks |
Remarks made to the appointment. |
string |
- |
| Status |
The status of the appointment. |
string |
- |
| ParentPlannedItemId |
The internal id of the parent appointment. |
integer |
Nullable |
| OccurrenceIndex |
The index of the occurrence of the appointment when part of an recurrence. |
integer |
Nullable |
| Id |
The internal id of the planned appointment. |
integer |
- |
| StartTime |
The start time of the appointment. |
date |
Deprecated (unavailable from 21.01.1P): Please use 'StartDate' instead. |
| EndTime |
The end time of the appointment. |
date |
Deprecated (unavailable from 21.01.1P): Please use 'EndDate' instead. |
| Location |
The location of the appointment. |
string |
- |
| MovesToNextDay |
Determines whether the appointment will be moved to the next day when not completed. |
boolean |
- |
| IsAllDay |
Is the appointment created as an all-day appointment. |
boolean |
- |
| RecursionText |
Description of the recurrence of the appointment. Empty when the appointment is not recurring. |
string |
- |
| Actions |
List of related actions. |
Collection of Action |
- |
| WorkTypeId |
The id of the worktype. |
integer |
Nullable |
| EmploymentId |
The internal id of the employee's employment. |
integer |
Nullable |
| WeekPlanningId |
The Id of the WeekPlanning. |
integer |
Nullable |