| Name | Description | Type | Additional information |
|---|---|---|---|
| ActionId |
The id of the Action |
integer |
Required |
| ClientId |
The internal id of the client. |
integer |
Required |
| ClientName |
The name of the client. |
string |
None |
| EmployeeId |
The internal id of the employee who owns the appointment. |
integer |
None |
| EmployeeName |
The name of the employee who owns the appointment. |
string |
None |
| EmploymentId |
The internal id of the employment of the specified employee. |
integer |
None |
| ContractOfServiceId |
The internal id of the employment of the specified employee. |
integer |
Deprecated (unavailable from 21.01.1P): Please use 'EmploymentId' instead. |
| Start |
The start date and time of the appointment. |
date |
Required |
| End |
The end date and time of the appointment. |
date |
Required |
| Title |
The subject of the appointment. |
string |
Required |
| Reason |
The given reason when the appointment is completed or cancelled. |
string |
None |
| Status |
Defines the status of the appointment. A Recurrence appointment will always have the status 'Created'. |
PlannedItemStatus |
None |
| StatusChangedByName |
The name of the employee who changed the status of the appointment. |
string |
None |
| StatusChangedById |
The id of the employee who changed the status of the appointment. |
integer |
None |
| CreatedByName |
The name of the employee who created the appointment. |
string |
None |
| CreatedById |
The id of the employee who created the appointment. |
integer |
None |
| Remarks |
Remarks made to the appointment. |
string |
None |
| Id |
The internal id of the appointment. |
integer |
Conditional Required: Only required for existing appointments |
| Location |
The location of the appointment. |
string |
None |
| MovesToNextDay |
Determines whether the appointment will be moved to the next day when not completed. |
boolean |
Required |
| IsAllDay |
Is the appointment created as an all-day appointment. |
boolean |
Required |
| FriendlyRecurrenceInfo |
The user friendly description of the recurrence for the appointment. This description is readonly. Only set when type is Recurrence. |
string |
None |
| RecurrenceInfo |
Defines the recurrence for the appointment. Only set when type is Recurrence. When creating a appointment the RecurrenceStart property of RecurrenceInfo must be equal to the Start property. Can be left empty if you want to remove the recurrence. |
RecurrenceInfo |
None |
| RecurrenceOccurrences |
The list of occurrences if the appointment is recurrent. Only occurrences within the provided range are returned. Only set when type is Recurrence. |
Collection of OccurrenceAppointment |
None |
| Type |
Defines the type of the appointment, default type is normal. |
AppointmentType |
None |
| ShiftId |
The Id of the Shift. |
integer |
None |
| ContractInfo |
The appointment ContractInfo. |
string |
None |
| WeekPlanningId |
The Id of the WeekPlanning. |
integer |
None |