Description
Work performed related to scheduled services that are created once an opportunity is won. Click Work Ticket for more information.
Resource Overview
| Endpoint | Definition |
|---|
| GET /WorkTickets | Retrieve a list of work tickets. |
| POST /WorkTickets/CreateAsNeededWorkTickets | Automatically generates work tickets based on opportunity services that need them. |
Attributes
| Attribute | Type | Description |
|---|
| WorkTicketID | integer | Unique ID of the work ticket. |
| OpportunityServiceID | integer | null | Linked opportunity service. |
| ContractYear | integer | null | Contract year this work ticket is associated with. |
| Occur | integer | null | Number of occurrences for the service. |
| PartialOccurrence | number | null | Indicates a partial completion of a service occurrence. |
| SubPartialOccurrence | number | Additional sub-occurrence detail. |
| AnticStartDate, ScheduledStartDate, CompleteDate, etc. | string (ISO 8601 date) | Key dates in the work ticket lifecycle. |
| WorkTicketStatusID, WorkTicketStatusName | integer / string | Status ID and name. |
| CrewLeaderName, ApprovedUserName, LastModifiedByUserName, etc. | string | User-assigned roles throughout the ticket lifecycle. |
| HoursEst, HoursAct, HoursScheduled, HoursUnscheduled | number | Estimated, actual, and scheduled labor hours. |
| MaterialCostEst, LaborCostAct, TotalCostAct, etc. | number | Various cost breakdowns. |
| Revenue, EarnedRevenue, RealizeRateRevenue, etc. | number | Financial metrics tied to job performance. |
| WorkTicketRevenues | array | Nested objects for period-based revenue tracking. |
| VisitsScheduled | integer | null | Total number of visits scheduled against the ticket. |