| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceTicketId |
Sedona internal autonumber for the Service Ticket record (SV_Service_Ticket table); required for PUT (updates) |
integer |
None. |
| TicketStatus |
Two letter code of status where: CL = Closed, DP = Dispatched, IP = In Progress, OP = Open, RS = Resolved, SC = Scheduled |
string |
Required |
| TicketStatusName |
Full name of status where: CL = Closed, DP = Dispatched, IP = In Progress, OP = Open, RS = Resolved, SC = Scheduled |
string |
None. |
| TicketNumber |
Service Ticket Number; will be created when adding a new service ticket; |
integer |
None. |
| CustomerId |
Foreign key from AR_Customer table |
integer |
Required |
| CustomerNumber |
Customer_Number field from the AR_Customer table |
string |
None. |
| CustomerName |
Customer_Name field from the AR_Customer table |
string |
None. |
| SiteName |
Site Name |
string |
None. |
| CustomerSiteId |
Foreign key from AR_Customer_Site table |
integer |
Required |
| City | string |
None. |
|
| State | string |
None. |
|
| CustomerSiteAddress |
Site information from the AR_Customer_Site table |
string |
None. |
| CustomerSystemId |
Foreign key from AR_Customer_System table |
integer |
Required |
| AlarmAccount |
Alarm_Account field from the AR_Customer_System table |
string |
None. |
| SystemCode |
Value from SY_System table; must be a valid value, and cannot be set to N/A; list of valid options can be retrieved from GET: api/systemtype |
string |
None. |
| MultipleSystems |
Designates whether there are multiple systems; defaults to false |
boolean |
None. |
| CreationDate |
Date the Service Ticket was created |
date |
None. |
| RequestedBy |
Name of the person who requested the ticket |
string |
String length: inclusive between 0 and 200 |
| RequestedByPhone |
Phone number of the person who requested the ticket |
string |
String length: inclusive between 0 and 15 |
| RequestedByPhoneExt | string |
String length: inclusive between 0 and 5 |
|
| AutoNotify |
Email to notify |
string |
String length: inclusive between 0 and 320 |
| ProblemCode |
Value from SV_Problem table; list of valid options can be retrieved from GET: api/serviceproblem |
string |
String length: inclusive between 0 and 25 |
| SubProblemCode |
Value from SV_Problem table; list of valid options can be retrieved from GET: api/serviceproblem |
string |
String length: inclusive between 0 and 25 |
| ScheduledFor |
Date/time the service ticket is scheduled for |
date |
None. |
| ServiceTechCode |
Value of Employee_Code from SY_Employee table referenced by the SV_Service_Tech table; list of valid options can be retrieved from GET: api/servicetech |
string |
String length: inclusive between 0 and 25 |
| EstimatedLength |
Estimated length of the appointment in minutes (i.e. 30, 60, etc.) |
integer |
None. |
| ResolutionCode |
Value from OE_Resolution table; set to N/A if not applicable; list of valid options can be retrieved from GET: api/resolution |
string |
String length: inclusive between 0 and 25 |
| Billable |
The service ticket is billable |
boolean |
None. |
| Billed |
The service ticket has been billed |
boolean |
None. |
| EquipmentCharge |
Equipment Charge |
decimal number |
None. |
| LaborCharge |
Labor Charge |
decimal number |
None. |
| OtherCharge |
Other Charge |
decimal number |
None. |
| TaxTotal |
Tax Total |
decimal number |
None. |
| CustomerComments |
Customer Comments |
string |
String length: inclusive between 0 and 255 |
| RegularHours |
Regular Hours |
decimal number |
None. |
| OvertimeHours |
Overtime Hours |
decimal number |
None. |
| HolidayHours |
Holiday Hours |
decimal number |
None. |
| TripCharge |
Trip Charge |
decimal number |
None. |
| InvoiceNumber |
Value from SV_Problem table; Note: This is not the InvoiceId |
integer |
None. |
| RegularRate |
Regular Rate on this ticket |
decimal number |
None. |
| OvertimeRate |
Overtime Rate on this ticket |
decimal number |
None. |
| HolidayRate |
Holiday Rate on this ticket |
decimal number |
None. |
| BypassWarranty |
By-pass any warranties |
boolean |
None. |
| BypassServiceLevel |
By-pass the service service level |
boolean |
None. |
| IsInspection |
The service ticket is related to an inspection |
boolean |
None. |
| ClosedDate |
Date the Ticket was closed |
date |
None. |
| DaysToClosed |
Number of days from Created to Closed |
integer |
None. |
| ManualLabor |
Includes manual labor |
boolean |
None. |
| ServiceCompanyCode |
Value from SV_Service_Company table; Provider of Service for this System; list of valid options can be retrieved from GET: api/servicecompany |
string |
String length: inclusive between 0 and 25 |
| ServiceCompanyID |
Value from SV_Service_Company table; Provider of Service for this System; list of valid options can be retrieved from GET: api/servicecompany; used only by the GETs |
integer |
None. |
| Priority |
Foreign key from SS_Priority table corresponding to Low, Medium, High, or Critical; defaults to Medium is not supplied |
string |
None. |
| CategoryCode |
Category from AR_Category table; defaults to N/A if not supplied |
string |
String length: inclusive between 0 and 25 |
| ExpertiseLevel |
levels 1-5 |
integer |
None. |
| EnteredBy |
The user who entered the ticket |
string |
String length: inclusive between 0 and 20 |
| InvoiceContact |
name of contact for the Invoice |
string |
String length: inclusive between 0 and 200 |
| Signer |
name of the signer |
string |
None. |
| ServiceLevelCode |
Value from SV_Service_Level table; list of valid options can be retrieved from GET: api/servicelevel |
string |
String length: inclusive between 0 and 25 |
| UserCode |
user name of the user who updated this ticket |
string |
String length: inclusive between 0 and 30 |
| PONumber |
PO Number |
string |
String length: inclusive between 0 and 20 |
| RouteCode |
Value from SV_Routes table; list of valid options can be retrieved from GET: api/serviceroute |
string |
String length: inclusive between 0 and 25 |
| SubCustomerSiteId |
Foreign key from AR_Customer_Site table |
integer |
None. |
| CustomerCCId |
Foreign key from AR_Customer_CC table |
integer |
None. |
| CustomerBankId |
Foreign key from AR_Customer_Bank table |
integer |
None. |
| CustomerBillId |
Foreign key from AR_Customer_Bill table |
integer |
None. |
| CustomerContactId |
Foreign key from AR_Customer_Contact table |
integer |
None. |
| InspectionId |
Foreign key from SV_Inspection table |
integer |
None. |
| ServiceTicketGroupId |
Foreign key from SV_Service_Ticket_Group table |
integer |
None. |
| ServiceCoordinatorEmployeeId |
Foreign key from SY_Employee table |
integer |
None. |
| Notes | Collection of ServiceTicketNote |
None. |
|
| Parts | Collection of ServiceTicketPart |
None. |
|
| Customer | Customer |
None. |
|
| Site | CustomerSite |
None. |
|
| System | CustomerSystem |
None. |