| Name | Description | Type | Additional information |
|---|---|---|---|
| AppointmentId |
Appointment Id (typically do not use this) |
integer |
None. |
| CaseId |
Case Id - Use as the public facing booking reference (1:1 with Appointment Id) |
integer |
None. |
| ProcessId |
Process Id - Use as Primary Key for appointments (typically 1:1 with Case Id) |
integer |
None. |
| ProcessGuid | globally unique identifier |
None. |
|
| CreatedDate |
Date/Time when appointment was created (server time zone) |
date |
None. |
| AppointmentDate |
Appointment Date/Time (relative to the appointments time zone) |
date |
None. |
| ArrivalDate |
Date/Time customer arrived (if appointment is in the past) |
date |
None. |
| TimeZoneOffset |
Time Zone Offset in minutes from the server (-120 = 2 hours behind server) |
integer |
None. |
| AppointmentTypeId |
Appointment Type Id |
integer |
None. |
| AppointmentTypeName |
Appointment Type Name |
string |
Max length: 50 |
| Duration |
Appointment Type Duration in minutes |
integer |
None. |
| AppointmentTypeExtRef |
Appointment Type External Reference |
string |
Max length: 200 |
| CaseExtRef |
Case Custom External Reference |
string |
Max length: 200 |
| Subject |
Case Subject field |
string |
Max length: 150 |
| CurrentEntityStatus | integer |
None. |
|
| CurrentEntityStatusDesc |
Process Current Entity Status Description |
string |
Max length: 150 |
| Resolution |
Process Resolution Id. Null=Not resolved; 0=Complete; 1=Cancelled; 2=NoShow; 3=Abandoned; 4=Aborted; 5=Rescheduled |
integer |
Range: inclusive between 0 and 5 |
| ResolutionDesc |
Process Resolution Description |
string |
Max length: 150 |
| ServiceId |
Service Id |
integer |
None. |
| ServiceName |
Service Name |
string |
Max length: 50 |
| ServiceExtRef |
Service Custom External Reference |
string |
Max length: 200 |
| UnitId |
Unit Id |
integer |
None. |
| UnitName |
Unit Name |
string |
Max length: 50 |
| UnitPath |
Unit Name Path similar to a directory (ie \Org Name\State\Location) |
string |
Max length: 150 |
| UnitExtRef |
Unit Custom External Reference |
string |
Max length: 200 |
| UnitAddress |
Unit address |
string |
Max length: 250 |
| Customer |
Associated Customer record |
Customer |
None. |
| CustomProperties |
Collection of all custom properties for this appointment process |
Dictionary of string [key] and string [value] |
None. |