Event Objects
Each time an event happens, we create an event object and send it to the target URL that you have configured either via the API or UI.
There are twelve object types:
WorkOrderCheckInAndOutInvoiceProposalPrivate Invitation EventsLocationSubscriberServiceProvider/ContractChecklistIssueListAssetLeakRecord
The structure of each event depends on the object type. Also, depending on the event, some fields of the event object can be null or absent.
Use the object examples and tables below to interpret the webhook events. All examples are provided for reference.
WorkOrder
A work order is a task for a provider to perform some services.
WorkOrderCreated
{
"Object": {
"LinkedWorOrderIds": [],
"Id": 182191991,
"Number": "182191991",
"PurchaseNumber": "182191991",
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"ProviderName": "LF Incorporated LLC",
"LocationId": 2006516537,
"LocationName": "Test API multivendor",
"LocationStoreId": "110",
"Status": {
"Primary": "OPEN",
"Extended": ""
},
"Caller": "SC-Dev1",
"CreatedBy": "SC-Dev1",
"UpdatedBy": {
"Id": 1543802
},
"CallDate": "2021-07-07T07:38:59",
"Priority": "P2 - 8 HOURS",
"Trade": "GLASS",
"ScheduledDate": "2021-07-07T15:38:59",
"AreaId": 3,
"AssetType": "Glass, Windows, Mirrors",
"ProblemType": "Glass, Windows, Mirrors",
"ScheduledDate_DTO": "2021-07-07T15:38:59-04:00",
"ExpirationDate": "2021-07-07T15:38:59",
"Description": "SALES FLOOR / Glass, Windows, Mirrors / Glass, Windows, Mirrors / Cracked /Chipped/Broken / Broken windows",
"Category": "REPAIR",
"Nte": 1000.0,
"CurrencyAlphabeticalCode": "USD",
"ProblemCode": "Cracked /Chipped/Broken",
"AssetId": 4861236,
"Source": "dashboard1775",
"Attachments": []
},
"EventType": "WorkOrderCreated"
}
WorkOrderNoteAdded
{
"Object": {
"LinkedWorOrderIds": [],
"Id": 182190844,
"Number": "182190844",
"PurchaseNumber": "182190844",
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"ProviderName": "LF Incorporated LLC",
"LocationId": 2006516537,
"LocationName": "Test API multivendor",
"LocationStoreId": "110",
"Status": {
"Primary": "COMPLETED",
"Extended": ""
},
"Caller": "SC-Dev1",
"CreatedBy": "SC-Dev1",
"CallDate": "2021-07-06T09:13:23",
"Priority": "P4 - 72 HOURS",
"Trade": "LANDSCAPING",
"ScheduledDate": "2021-07-09T09:13:23",
"UpdatedDate": "2021-07-06T09:22:18.7",
"ScheduledDate_DTO": "2021-07-09T09:13:23-04:00",
"CompletedDate": "2021-07-06T09:22:10",
"ExpirationDate": "2021-07-09T09:13:23",
"Description": "EXTERIOR / Parking Lot / Landscaping / Grass Not Cut / Grass is taller than it should be",
"Category": "REPAIR",
"Nte": 500.0,
"CurrencyAlphabeticalCode": "USD",
"Source": "dashboard1775",
"Notes": [
{
"Id": 1087561588,
"Number": 4,
"NoteData": "Attachment 'check-out_2021.07.06_13:22:16.jpg' has been added.",
"DateCreated": "2021-07-06T09:22:00",
"ScheduledDate": "2021-07-09T09:13:23",
"ActionRequired": false,
"CreatedBy": "TestApi",
"CreatedByUser": {
"UserName": "TestApi1",
"ProviderId": 2000090505
}
}
],
"Attachments": []
},
"EventType": "WorkOrderNoteAdded"
}
WorkOrderStatusChanged
{
"Object": {
"LinkedWorOrderIds": [],
"Id": 182190823,
"Number": "182190823",
"PurchaseNumber": "182190823",
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"ProviderName": "LF Incorporated LLC",
"LocationId": 2006516537,
"LocationName": "Test API multivendor",
"LocationStoreId": "110",
"Status": {
"Primary": "COMPLETED",
"Extended": "CONFIRMED"
},
"Caller": "SC-Dev1",
"CreatedBy": "SC-Dev1",
"UpdatedBy": {
"UserName": "TestApi1",
"ProviderId": 2000090505
},
"CallDate": "2021-07-06T08:35:05",
"Priority": "P4 - 72 HOURS",
"Trade": "ELECTRICAL",
"ScheduledDate": "2021-07-09T08:35:05",
"UpdatedDate": "2021-07-06T09:07:36.297",
"ScheduledDate_DTO": "2021-07-09T08:35:05-04:00",
"CompletedDate": "2021-07-06T09:07:08",
"ExpirationDate": "2021-07-09T08:35:05",
"Description": "SALES FLOOR / Electrical / Ceiling Fan / Ceiling fan not working / Ceiling fan is out of order",
"Category": "PARTS ORDER",
"Nte": 500.0,
"CurrencyAlphabeticalCode": "USD",
"Source": "dashboard1775",
"Attachments": []
},
"EventType": "WorkOrderStatusChanged"
}
WorkOrderAttachmentAdded
{
"Object": {
"Id": 182190732,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2005952373,
"Trade": "DOORS",
"Category": "REPAIR",
"Attachments": [
{
"Id": 106312265,
"Description": "broken door lock",
"Name": "door_lock.jpg",
"Uri": "https://scitappssb2.blob.core.windows.net/workorders/46593982-afd1-453f-b2da-001b64f79b61?sv=2019-02-02&sr=b&sig=RNikgsruGGdcERYax%2F9N6rmFNPCTINiPRJ1hAYqpThU%3D&se=2021-07-06T12%3A11%3A37Z&sp=r",
"CreatedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "SC-Dev1",
"Email": "",
"SubscriberId": 2014917243
},
"Type": 1
}
]
},
"EventType": "WorkOrderAttachmentAdded",
"Version": 1
}
WorkOrderPriorityChanged
{
"Object": {
"Id": 182190732,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2006516537,
"UpdatedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "SC-Dev1",
"Email": "",
"SubscriberId": 2014917243
},
"Priority": "P1 - 4 Hours",
"Trade": "DOORS",
"Category": "REPAIR"
},
"EventType": "WorkOrderPriorityChanged"
}
WorkOrderScheduledDateChanged
{
"Object": {
"Id": 182190732,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2006516537,
"UpdatedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "SC-Dev1",
"Email": "",
"SubscriberId": 2014917243
},
"Trade": "DOORS",
"ScheduledDate_DTO": "2021-07-12T05:31:59-04:00",
"Category": "REPAIR"
},
"EventType": "WorkOrderScheduledDateChanged"
}
WorkOrderTradeChanged
{
"Object": {
"Id": 182190828,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2006516537,
"UpdatedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "SC-Dev1",
"Email": "",
"SubscriberId": 2014917243
},
"Trade": "GENERAL REPAIRS",
"Category": "REPAIR"
},
"EventType": "WorkOrderTradeChanged"
}
WorkOrderNteChanged
{
"Object": {
"Id": 182190732,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2006516537,
"UpdatedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "SC-Dev1",
"Email": "",
"SubscriberId": 2014917243
},
"Trade": "DOORS",
"Category": "REPAIR",
"Nte": 500.0,
"CurrencyAlphabeticalCode": "USD"
},
"EventType": "WorkOrderNteChanged"
}
WorkOrderCategoryChanged
{
"Object": {
"Id": 182190823,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2006516537,
"UpdatedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "SC-Dev1",
"Email": "",
"SubscriberId": 2014917243
},
"Trade": "ELECTRICAL",
"Category": "PARTS ORDER"
},
"EventType": "WorkOrderCategoryChanged"
}
WorkOrderTechnicianAssigned
{
"Object": {
"Id": 218810198,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005862796,
"UpdatedBy": {
"AuthUserId": 2831,
"UserName": "ifixxservices@gmail.com",
"FullName": "Xavier Brown",
"LoginType": 0
},
"UpdatedDate_DTO": "2022-10-17T11:41:22.2714851-04:00",
"Technician": {
"Id": 1758,
"AuthUserId": 2831
}
},
"EventType": "WorkOrderTechnicianAssigned",
"Version": 1
}
WorkOrderTechnicianUnassigned
{
"Object": {
"Id": 218810198,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005862796,
"UpdatedBy": {
"AuthUserId": 2831,
"UserName": "ifixxservices@gmail.com",
"FullName": "Xavier Brown",
"LoginType": 0
},
"UpdatedDate_DTO": "2022-10-17T11:56:57.3022049-04:00",
"Technician": {
"Id": 1758,
"AuthUserId": 2831
}
},
"Type": "WoRootNotification",
"Action": "UPDATE",
"EventType": "WorkOrderTechnicianUnassigned",
"Version": 1
}
WorkOrderTechnicianAccepted
{
"Object": {
"Id": 218810198,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005862796,
"UpdatedBy": {
"AuthUserId": 2831,
"UserName": "ifixxservices@gmail.com",
"FullName": "Xavier Brown",
"LoginType": 0
},
"UpdatedDate_DTO": "2022-10-17T11:56:57.3022049-04:00",
"Technician": {
"Id": 1758,
"AuthUserId": 2831
}
},
"EventType": "WorkOrderTechnicianAccepted",
"Version": 1
}
WorkOrderLinksAdded
{
"Object": {
"WorkOrderId": 212848464,
"LinkedWorkOrdersIds": [
206424750
],
"UnlinkLinkedWorkOrders": true,
"User": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
},
"DateDTO": "2023-07-19T07:51:38.0126425-05:00",
"LocationId": 2005952373
},
"EventType": "WorkOrderLinksAdded",
"Version": 1
}
WorkOrderLinksDeleted
{
"Object": {
"WorkOrderId": 212848464,
"UnlinkLinkedWorkOrders": true,
"User": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
},
"DateDTO": "2023-07-19T08:17:30.0717108-05:00",
"LocationId": 2005952373
},
"EventType": "WorkOrderLinksDeleted",
"Version": 1
}
WorkOrderLabelAdded
{
"Object": {
"Id": 212848464,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005944822,
"Status": {
"Primary": "IN PROGRESS",
"Extended": "DISPATCH CONFIRMED"
},
"UpdatedBy": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
},
"Trade": "DISH WASHER",
"UpdatedDate_DTO": "2022-08-29T16:12:05.7356666-04:00",
"Labels": [
{
"Id": 5751,
"Text": "kitchen"
}
]
},
"EventType": "WorkOrderLabelAdded",
"Version": 1
}
WorkOrderLabelDeleted
{
"Object": {
"Id": 212848464,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005944822,
"Status": {
"Primary": "IN PROGRESS",
"Extended": "DISPATCH CONFIRMED"
},
"UpdatedBy": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
},
"Trade": "DISH WASHER",
"UpdatedDate_DTO": "2022-08-29T16:21:34.1304226-04:00",
"Labels": [
{
"Id": 5751,
"Text": "kitchen"
}
]
},
"EventType": "WorkOrderLabelDeleted",
"Version": 1
}
WorkOrderDescriptionChanged
{
"Object": {
"Id": 212848464,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005944822,
"UpdatedBy": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
},
"Trade": "DISH WASHER",
"UpdatedDate_DTO": "2022-08-29T16:30:34.5667234-04:00",
"Description": "The dish washer isn't working. The display shows error 4.",
"Category": "REPAIR"
},
"EventType": "WorkOrderDescriptionChanged",
"Version": 1
}
WorkOrderResolutionCreated
{
"Object": {
"Id": 212848464,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005944822,
"UpdatedBy": {
"Id": 978389,
"AuthUserId": 2831,
"UserName": "ifixxservices@gmail.com",
"FullName": "Xavier Brown",
"Email": "ifixxservices@gmail.com",
"ProviderId": 2000069665
},
"Trade": "DISH WASHER",
"UpdatedDate_DTO": "2022-08-31T10:41:11.1215563-04:00",
"ResolutionCodes": [
{
"Id": 8508
},
{
"Id": 8494
}
]
},
"EventType": "WorkOrderResolutionCodeCreated",
"Version": 1
}
WorkOrderResolutionUpdated
{
"Object": {
"Id": 212848464,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005944822,
"UpdatedBy": {
"Id": 978389,
"AuthUserId": 2831,
"UserName": "ifixxservices@gmail.com",
"FullName": "Xavier Brown",
"Email": "ifixxservices@gmail.com",
"ProviderId": 2000069665
},
"Trade": "DISH WASHER",
"UpdatedDate_DTO": "2022-08-31T10:41:11.1215563-04:00",
"ResolutionCodes": [
{
"Id": 8508
},
{
"Id": 8494
}
]
},
"EventType": "WorkOrderResolutionCodeUpdated",
"Version": 1
}
WorkOrderRootCauseCodeCreated
{
"Object": {
"Id": 212848464,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005944822,
"UpdatedBy": {
"Id": 978389,
"AuthUserId": 2831,
"UserName": "ifixxservices@gmail.com",
"FullName": "Xavier Brown",
"Email": "ifixxservices@gmail.com",
"ProviderId": 2000069665
},
"Trade": "DISH WASHER",
"UpdatedDate_DTO": "2022-08-31T10:41:11.1371828-04:00",
"RootCauses": [
{
"Id": 1261
}
]
},
"EventType": "WorkOrderRootCauseCodeCreated",
"Version": 1
}
WorkOrderRootCauseCodeUpdated
{
"Object": {
"Id": 212848464,
"SubscriberId": 2014916940,
"ProviderId": 2000069665,
"LocationId": 2005944822,
"UpdatedBy": {
"Id": 978389,
"AuthUserId": 2831,
"UserName": "ifixxservices@gmail.com",
"FullName": "Xavier Brown",
"Email": "ifixxservices@gmail.com",
"ProviderId": 2000069665
},
"Trade": "DISH WASHER",
"UpdatedDate_DTO": "2022-08-31T10:41:11.1371828-04:00",
"RootCauses": [
{
"Id": 1261
}
]
},
"EventType": "WorkOrderRootCauseCodeUpdated",
"Version": 1
}
Field descriptions
| Attribute | Data type | Description |
|---|---|---|
| LinkedWorkOrderIds | Integer | The unique IDs of work orders that are linked to an existing work order. Generated automatically and cannot be modified. |
| Id | Integer | The unique work order ID, also known as Tracking Number. Generated automatically and cannot be modified. |
| Number | String | The work order number. Can be modified by providers and subscribers. |
| PurchaseNumber | String | The purchase number. Can be modified only by subscribers. |
| Description | String | The detailed description of the problem, for example, The coffee machine is broken so I can’t start working. May contain automatically generated data, such as info on the Issue List or original WO ID in case of a recall. |
| SubscriberId | Integer | The unique subscriber’s ID. |
| ProviderId | Integer | The unique provider’s ID. |
| ProviderName | String | The official provider’s company name. |
| LocationId | Integer | The unique ID of the subscriber’s location. |
| LocationName | String | The location name. |
| LocationStoreId | String | The numeric identifier of the store in the client’s system. Assigned by and unique per subscriber. |
| Status | Object | The stage the work order (WO) is in. |
| Status.Primary | String | The primary stage the WO is in, for example, OPEN or IN PROGRESS. |
| Status.Extended | String | The detailed stage the WO is in, for example, PARTS ON ORDER or ON SITE. |
| Caller | String | The username or full name of the person who submitted the WO. |
| CreatedBy | String | The employee’s login account used to create the WO. |
| CallDate | String (date-time) | The date and time specified during the creation of the work order by the user. |
| UpdatedBy | Object | The information on the user who updated the work order. |
| UpdatedBy.Id | Integer | The user ID of the person who updated the work order. |
| UpdatedBy.AuthUserId | Integer | The single sign-on (SSO) ID of the person who updated the work order. |
| UpdatedBy.UserName | String | The username of the person who updated the work order. |
| UpdatedBy.FullName | String | The first and last name of the person who updated the work order. |
| UpdatedBy.Email | String | The email of the person who updated the work order. |
| UpdatedBy.LoginType | String | Login type. Possible values: 0 - a login with a username and a password or with SSO; 1 - a login with a PIN. |
| ReassignDate | String (date-time) | The date and time when the WO was reassigned to another provider. |
| Priority | String | The importance of the WO in relation to other WOs, for example, Normal or Emergency, or the period during which a provider should complete the work, for example, P1 - 4 Hours or P2 - 8 Hours. |
| Trade | String | The type of work a provider should perform, for example, CARPENTRY or PLUMBING. Has a narrower definition than Category. |
| ScheduledDate | String (date-time) | The scheduled date and time when a provider is expected to be on site. May differ from ExpirationDate if a provider or subscriber adjusts the scheduled date and time. |
| ScheduledDate_DTO | String (date-time) | The scheduled date and time indicated with the UTC offset. |
| UpdatedDate | String (date-time) | The date and time the last work order update took place. |
| AreaId | Integer | The numeric identifier of the area where provider’s services are needed. |
| AssetType | String | The type of the asset that should be repaired or installed. Dependent on Area and Problem Type. |
| ProblemType | String | The type of the problem, for example, Electrical, Plumbing, that should be addressed. Dependent on Area. |
| CompletedDate | String (date-time) | The date and time when the WO was completed. |
| ExpirationDate | String (date-time) | The default ETA when the provider was expected to be on site. |
| Category | String (date-time) | The overall classification of the WO, for example, MAINTENANCE or REPAIR. |
| Nte | Number | The maximum monetary amount that a provider may charge for the service. Stands for not-to-exceed. |
| CurrencyAlphabeticalCode | String | The WO currency three-letter alphabetic code, for example, USD. |
| ProblemCode | String | The short problem description, for example, Freight Elevator not working or Interior door not opening. Unlike Description, ProblemCode has predefined values. |
| Resolution | String | The description of how a provider solved the problem. |
| AssetId | Integer | The ID of the asset that should be repaired or installed. |
| Source | String | The source from where the WO was submitted, for example, Web API Client, PM, or Dashboard. |
| RecallWorkOrder | Integer | The Id of the original WO. Means that the WO is marked as a recall. Used when a subscriber is not satisfied with work done or when the problem reoccurs. |
| Notes | Array of objects | The latest WO note details. |
| Notes.Id | Integer | The unique ID of the note. |
| Notes.Number | Integer | The note order number. |
| Notes.NoteData | String | The note text and automatically generated description of what was changed. |
| Notes.DateCreated | String (date-time) | The date and time when the note was created. |
| Notes.ScheduledDate | String (date-time) | The scheduled date and time when a provider is expected to be on site. |
| Notes.Visibility | Integer | Note visibility. Possible values: 1 - hidden from Client; 2 - hidden from Provider; 3 - hidden from both Client and Provider. |
| Notes.FollowUpDate | String (date-time) | The date and time by which the recipients of the note should respond. |
| Notes.ActionRequired | Boolean | Determines if further action should be taken on the WO. |
| Notes.MailedTo | String | The emails of the people to notify of the WO update. |
| Notes.CreatedBy | String | The full name of the person who created the note. |
| Notes.CreatedByUser | Object | The username and ID of the user who created the note for the work order. |
| Notes.CreatedByUser.UserName | String | The username of the person who created the note for the work order. |
| Attachments | Array of objects | The information on the list of work order attachments. |
| Attachments.Id | Integer | The unique ID of the work order attachment. |
| Attachments.Description | String | The description of the work order attachment. The maximum is 200 characters. |
| Attachments.Name | String | The file name of the work order attachment. |
| Attachments.Uri | String | The URI to the work order attachment. |
| Attachments.CreatedBy | Object | The information on the user who added the attachment. |
| Attachemnts.CreatedBy.Id | Integer | The user ID of the person who added the attachment. |
| Attachemnts.CreatedBy.AuthUserId | Integer | The single sign-on (SSO) ID of the person who added the attachment. |
| Attachemnts.CreatedBy.UserName | String | The username of the person who added the attachment. |
| Attachemnts.CreatedBy.FullName | String | The first and last name of the person who added the attachment. |
| Attachemnts.CreatedBy.Email | String | The email of the person who added the attachment. |
| Attachments.Visibility | Integer | Attachment visibility. Possible values: 1 - hidden from Client; 2 - hidden from Provider; 3 - hidden from both Client and Provider. |
| Technician | Object | Information about the technician. |
| Technician.Id | Integer | Unique numeric identifier of the technician. |
| Technician.AuthUserId | Integer | The single sign-on (SSO) ID of the technician. |
| LinkedWorkOrdersIds | Object | Array of unique numeric identifiers of the work orders linked with the current work order. |
| UnlinkLinkedWorkOrders | Boolean | Shows whether the user has the permission to unlink work orders from the current work order. Possible values: true (if a user has the permission), false (if a user has no such permission). |
| Labels | Object | Information about labels associated with the work order. |
| Labels.Id | Integer | Unique numeric identifier of the label associated with the work order. |
| Labels.Text | String | Name of the label associated with the work order. |
| Description | String | Problem description of a work order. |
| ResolutionCodes | Object | Array of unique numeric identifiers of the resolution codes added to the current work order. |
| RootCauses | Object | Array of unique numeric identifiers of the root codes added to the current work order. |
CheckInAndOut
Check-in is when technicians report that they have arrived at the location and started working. Check-out is when technicians report that they have departed from the location or finished working.
WorkOrderCheckIn
{
"Object": {
"CheckInNotes": {
"OutsideOperationalHours": "Check-in is outside the location’s operational hours",
"OutsideAcceptableTimeframe": "Check-in is outside the work order’s acceptable hours"
},
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2006516537,
"CheckinAction": 0,
"WorkOrderId": 182191991,
"Date": "2021-07-07T09:18:36.4534517",
"DateDTO": "2021-07-07T09:18:36.4534517-04:00",
"User": {
"Id": 1544987,
"AuthUserId": 204451,
"UserName": "TestApi1",
"FullName": "TestApi",
"Email": "",
"LoginType": 0,
"SubscriberId": -1,
"ProviderId": 2000090505
},
"CallerId": "GPS(41.936339000,-72.024533000)",
"Action": "CheckIn",
"WorkType": "Repair",
"WorkorderStatus": {
"Primary": "IN PROGRESS",
"Extended": "ON SITE"
},
"ProviderName": "LF INCORPORATED LLC",
"Trade": "GLASS",
"Category": "REPAIR",
"Source": "contractor_tools",
"TradeId": 90481,
"TechsCount": 1
},
"EventType": "WorkOrderCheckIn"
}
WorkOrderCheckOut
{
"Object": {
"CheckInNotes": {
"AllTechniciansCheckedOut": "All technicians have been checked out"
},
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"LocationId": 2006516537,
"CheckinAction": 1,
"WorkOrderId": 182190844,
"Date": "2021-07-06T09:22:10.1356339",
"DateDTO": "2021-07-06T09:22:10.1356339-04:00",
"User": {
"Id": 1544987,
"AuthUserId": 204451,
"UserName": "TestApi1",
"FullName": "TestApi",
"Email": "",
"LoginType": null,
"SubscriberId": -1,
"ProviderId": 2000090505
},
"CallerId": "GPS(53.914788617,27.425447451)",
"Action": "CheckOut",
"WorkType": "Repair",
"WorkorderStatus": {
"Primary": "COMPLETED",
"Extended": ""
},
"ProviderName": "LF INCORPORATED LLC",
"Trade": "LANDSCAPING",
"Category": "REPAIR",
"Source": "contractor_tools",
"TradeId": 90475,
"TechsCount": 1
},
"EventType": "WorkOrderCheckOut"
}
Field descriptions
| Attribute | Data type | Description |
|---|---|---|
| CheckInNotes | Object | The additional notes on the check-in/out. |
| CheckInNotes.OutsideOperationalHours | String | The note states that a technician checked into the WO outside of business hours. |
| CheckInNotes.OutsideAcceptableTimeframe | String | The note states that a technician checked into the WO outside of the acceptable timeframe. |
| CheckInNotes.OutsideGeolocationParameters | String | The note states that a technician checked into the WO outside of the acceptable geographical boundary. |
| CheckInNotes.AllTechniciansCheckedOut | String | The note defines that all technicians have been checked out from the WO. |
| SubscriberId | Integer | The unique subscriber’s ID. |
| ProviderId | Integer | The unique provider’s ID. |
| LocationId | Integer | The unique ID of the subscriber’s location. |
| CheckinAction | Integer | The action type. 0 for the check-in and 1 for check-out. |
| WorkOrderId | Integer | The work order (WO) identifier, also known as Tracking Number. |
| Date | String (date-time) | The date and time of the check-in/out. |
| DateDTO | String (date-time) | The date and time of the check-in/out indicated with the UTC offset. |
| User | Object | The information on the technician who reported the check-in/out. |
| User.Id | Integer | The technician’s user ID. |
| User.AuthUserId | Integer | The single sign-on (SSO) ID of the technician. |
| User.UserName | String | The username of the technician. |
| User.FullName | String | The first and last name of the technician. |
| User.Email | String | The email of the technician. |
| User.LoginType | String | The type of the credentials used by the technician. Usually, either User ID and password combination or PIN. |
| CallerId | String | The telephone number for check-in/out via IVR or GPS coordinates for check-in/out via the SC Provider mobile app or API. |
| Action | String | Determines if a check-in or check-out was reported. Possible values: CheckIn, CheckOut. |
| WorkType | String | The type of the work performed, for example, Repair or Travel. |
| WorkorderStatus | Object | The stage the WO was in during check-in/out. |
| WorkorderStatus.Primary | String | The primary stage the WO was in, for example, OPEN or IN PROGRESS. |
| WorkorderStatus.Extended | String | The detailed stage the WO was in, for example, PARTS ON ORDER or ON SITE. |
| ProviderName | String | The provider’s company name. |
| Trade | String | The type of work a provider performs, for example, CARPENTRY or PLUMBING. |
| Category | String | The overall classification of the WO, for example, MAINTENANCE or REPAIR. |
| Source | String | The source from where the check-in/out has been reported. |
| TradeId | Integer | The unique ID of the trade. |
| TechsCount | Integer | The number of technicians working on site. |
Invoice
An invoice is a financial document specifying labor, material, and other charges as well as the tax and invoice total amounts.
InvoiceCreated
{
"Object": {
"Id": 46848182,
"Number": "N-987654321",
"BatchNumber": "",
"InvoiceTax": 130,
"PostedTaxRate": null,
"VendorPayeeId": 523710,
"InvoiceTotal": 790,
"CurrencyAlphabeticalCode": "USD",
"ApprovedDateDTO": null,
"ApprovalCode": 123456,
"PostedDateDTO": "2018-04-02T05:10:00-04:00",
"Subtotal": 660,
"Status": "OPEN",
"Trade": "HVAC",
"StarredBy": null,
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "Cut grass, cleared weeds in flower bed and trimmed shrubs",
"InvoiceDateDTO": "2018-04-02T05:10:28-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeDate": "2018-04-02T05:10:28.027",
"StatusChangeUser": "test-username",
"StatusChangeUserid": "",
"WoTrackingNumber": 96563798,
"Terms": null,
"Comments": null,
"PaidDateDTO": null,
"TransferredDate": null,
"LastActionDateDTO": "2018-04-02T05:10:28.2-04:00",
"UpdatedDateDTO": "2018-04-02T09:10:28-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006071467,
"ProviderName": "LF INCORPORATED LLC",
"Labors": [
{
"SkillLevel": 2,
"LaborType": 1,
"NumOfTech": 1,
"HourlyRate": 10,
"Hours": 10,
"Amount": 100
}
],
"Materials": [
{
"Description": "Wall tiles",
"PartNum": "4585D",
"UnitType": 0,
"UnitPrice": 10,
"Quantity": 30,
"Amount": 300
}
],
"Category": "CAPEX"
},
"EventType": "InvoiceCreated"
}
InvoiceOpen
{
"Object": {
"Id": 92623812,
"Number": "INV0070721",
"BatchNumber": "",
"InvoiceTax": 25.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 540.0,
"ApprovalCode": "R103",
"PostedDateDTO": "2021-07-07T01:13:41-04:00",
"Subtotal": 515.0,
"Status": "Open",
"Trade": "GLASS",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-07T01:13:41-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182191737,
"Comments": "",
"LastActionDateDTO": "2021-07-07T01:23:38.29-04:00",
"UpdatedDateDTO": "2021-07-07T01:23:38.29665-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "",
"Email": "",
"SubscriberId": 2014917243
}
},
"EventType": "InvoiceOpen"
}
InvoiceApproved
{
"Object": {
"Id": 92623812,
"Number": "INV0070721",
"BatchNumber": "",
"InvoiceTax": 25.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 540.0,
"ApprovedDateDTO": "2021-07-07T01:29:21.367-04:00",
"ApprovalCode": "R103",
"PostedDateDTO": "2021-07-07T01:13:41-04:00",
"Subtotal": 515.0,
"Status": "Approved",
"Trade": "GLASS",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-07T01:13:41-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182191737,
"Comments": "",
"LastActionDateDTO": "2021-07-07T01:29:21.367-04:00",
"UpdatedDateDTO": "2021-07-07T01:29:21.3791105-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "",
"Email": "",
"SubscriberId": 2014917243
}
},
"EventType": "InvoiceApproved"
}
InvoiceOnHold
{
"Object": {
"Id": 92623812,
"Number": "INV0070721",
"BatchNumber": "",
"InvoiceTax": 25.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 540.0,
"ApprovalCode": "R103",
"PostedDateDTO": "0001-01-01T00:00:00-05:00",
"Subtotal": 515,
"Status": "On Hold",
"Trade": "GLASS",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-07T01:13:41-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182191737,
"Comments": "",
"LastActionDateDTO": "2021-07-07T01:21:16.67-04:00",
"UpdatedDateDTO": "2021-07-07T01:21:16.7395334-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"Id": 2306862,
"AuthUserId": 938563,
"UserName": "SC-Dev1",
"FullName": "",
"Email": "",
"SubscriberId": 2014917243
}
},
"EventType": "InvoiceOnHold"
}
InvoiceReviewed
{
"Object": {
"Id": 92623816,
"Number": "INV789515",
"BatchNumber": "",
"InvoiceTax": 25.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 575.0,
"ApprovalCode": "PM100",
"PostedDateDTO": "2021-07-07T05:44:25-04:00",
"Subtotal": 550.0,
"Status": "Reviewed",
"Trade": "DOORS",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-07T01:13:41-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 181966456,
"Comments": "",
"LastActionDateDTO": "2021-07-07T05:44:41.687-04:00",
"UpdatedDateDTO": "2021-07-07T05:44:41.6922849-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "MAINTENANCE",
"ChangedBy": {
"Id": 2306862,
"AuthUserId": 938563,
"UserName": "SC-Dev1",
"FullName": "",
"Email": "",
"SubscriberId": 2014917243
}
},
"EventType": "InvoiceReviewed"
}
InvoiceRejected
{
"Object": {
"Id": 92623788,
"Number": "23423",
"BatchNumber": "",
"InvoiceTax": 24.8,
"VendorPayeeId": 523710,
"InvoiceTotal": 272.8,
"ApprovalCode": "",
"PostedDateDTO": "2021-07-06T09:24:03-04:00",
"Subtotal": 248.0,
"Status": "Rejected",
"Trade": "ELECTRICAL",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-06T09:24:03-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182190823,
"Comments": "Unsatisfactory work",
"LastActionDateDTO": "2021-07-06T14:39:52.66-04:00",
"UpdatedDateDTO": "2021-07-06T14:39:52.6671217-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"Id": 1543802,
"AuthUserId": 907761,
"UserName": "SC-Dev1",
"FullName": "",
"Email": "",
"SubscriberId": 2014917243
}
},
"EventType": "InvoiceRejected"
}
InvoiceApprovalCodeChanged
{
"Object": {
"Id": 92623813,
"Number": "INV53424",
"BatchNumber": "",
"InvoiceTax": 25.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 825.0,
"ApprovalCode": "M342",
"PostedDateDTO": "2021-07-07T01:36:19-04:00",
"Subtotal": 800.0,
"Status": "OPEN",
"Trade": "GLASS",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-07T01:36:18-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182191756,
"Comments": "",
"LastActionDateDTO": "2021-07-07T01:36:18.573-04:00",
"UpdatedDateDTO": "2021-07-07T01:36:47.8767481-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"UserName": "SC-Dev1",
"FullName": ""
}
},
"EventType": "InvoiceApprovalCodeChanged"
}
InvoiceVoided
{
"Object": {
"Id": 92623790,
"Number": "INV150692",
"BatchNumber": "",
"InvoiceTax": 50.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 500.0,
"ApprovalCode": "R103",
"PostedDateDTO": "2021-07-06T14:48:45-04:00",
"Subtotal": 450.0,
"Status": "OPEN",
"Trade": "ELECTRICAL",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-06T14:48:44-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182190823,
"Comments": "",
"LastActionDateDTO": "2021-07-06T14:48:44.68-04:00",
"UpdatedDateDTO": "2021-07-06T14:48:44.6986368-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"UserName": "SC-Dev1",
"FullName": ""
}
},
"EventType": "InvoiceVoided"
}
InvoiceStarAdded
{
"Object": {
"Id": 92623812,
"Number": "INV0070721",
"BatchNumber": "",
"InvoiceTax": 25.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 540.0,
"PostedDateDTO": "2021-07-07T01:13:41-04:00",
"Subtotal": 515.0,
"Status": "OPEN",
"Trade": "GLASS",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "test",
"InvoiceDateDTO": "2021-07-07T01:13:41-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182191737,
"Comments": "",
"LastActionDateDTO": "",
"UpdatedDateDTO": "2021-07-07T01:13:41.3626607-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"UserName": "SC-Dev1",
"FullName": ""
}
},
"EventType": "InvoiceStarAdded"
}
InvoiceStarRemoved
{
"Object": {
"Id": 92623789,
"Number": "123456789",
"BatchNumber": "",
"InvoiceTax": 0.0,
"VendorPayeeId": 523710,
"InvoiceTotal": 472.0,
"PostedDateDTO": "2021-07-06T13:49:46-04:00",
"Subtotal": 472.0,
"Status": "OPEN",
"Trade": "HVAC",
"StarredBy": "",
"IsStarred": false,
"StarredDate": "0001-01-01T00:00:00",
"Description": "",
"InvoiceDateDTO": "2021-07-06T13:49:45-04:00",
"LaborTaxIncluded": false,
"TravelTaxIncluded": false,
"MaterialsTaxIncluded": false,
"FreightTaxIncluded": false,
"OtherTaxIncluded": false,
"StatusChangeUser": "SC-Dev1",
"StatusChangeUserid": "",
"WoTrackingNumber": 182190884,
"Comments": "",
"LastActionDateDTO": "2021-07-06T14:30:40.407-04:00",
"UpdatedDateDTO": "2021-07-06T14:30:40.4942578-04:00",
"ProviderId": 2000090505,
"SubscriberId": 2014917243,
"LocationId": 2006516537,
"Labors": [],
"Materials": [],
"Category": "REPAIR",
"ChangedBy": {
"UserName": "SC-Dev1",
"FullName": ""
}
},
"EventType": "InvoiceStarRemoved"
}
Field descriptions
| Attribute | Data type | Description |
|---|---|---|
| Id | Integer | The unique invoice ID. Generated automatically and cannot be modified. |
| Number | String | The invoice number. |
| BatchNumber | String | The invoice batch number. |
| InvoiceTax | Number | The monetary amount of the tax. |
| PostedTaxRate | Number | The percent of the tax. |
| VendorPayeeId | Integer | The provider’s payee ID assigned by the subscriber for invoicing purposes. |
| InvoiceTotal | Number | The total monetary amount of the invoice. |
| CurrencyAlphabeticalCode | String | The invoice currency three-letter alphabetic code. |
| ApprovedDateDTO | String (date-time) | The date and time when the invoice was approved indicated with the UTC offset. |
| ApprovalCode | String | The invoice approval code. |
| PostedDateDTO | String (date-time) | The automatically generated date and time when the invoice was posted into the system indicated with the UTC offset. |
| Subtotal | Number | The monetary amount of the invoice excluding the tax. |
| Status | String | The status the invoice is currently in. |
| Trade | String | The type of work a provider performed, for example, CARPENTRY or PLUMBING. |
| StarredBy | String | The username of the person who marked the invoice with a star. |
| IsStarred | Boolean | Defines if the invoice was marked with a star. |
| StarredDate | String (date-time) | The date and time when the invoice was marked with a star. |
| Description | String | A detailed description of the work done by the provider. |
| InvoiceDateDTO | String (date-time) | The date and time when the invoice was issued. Idicated with the UTC offset. May differ from PostedDateDTO. |
| LaborTaxIncluded | Boolean | Defines if the labor tax is included. |
| TravelTaxIncluded | Boolean | Defines if the travel tax is included. |
| MaterialsTaxIncluded | Boolean | Defines if the materials tax is included. |
| FreightTaxIncluded | Boolean | Defines if the freight tax is included. |
| OtherTaxIncluded | Boolean | Defines if the tax for other charges is included. |
| StatusChangeDate | String (date-time) | The date and time of the invoice latest status update. |
| StatusChangeUser | String | The username or full name of the person who updated the invoice status. |
| StatusChangeUserid | String | The user ID of the person who updated the invoice status. |
| WoTrackingNumber | Integer | The unique ID of the work order associated with the invoice. |
| Terms | String | The source that created the invoice. Empty when created manually or InvoiceAgent when created by the background process. |
| Comments | String | The comment added to the invoice. |
| PaidDateDTO | String (date-time) | The date and time when the invoice was paid indicated with the UTC offset. |
| TransferredDate | String (date-time) | The invoice transferred date and time. |
| LastActionDateDTO | String (date-time) | The date and time of the last action performed on the invoice indicated with the UTC offset. |
| UpdatedDateDTO | String (date-time) | The date and time of the last invoice update indicated with the UTC offset. |
| ProviderId | Integer | The unique provider’s ID. |
| SubscriberId | Integer | The unique subscriber’s ID. |
| LocationId | Integer | The unique ID of the subscriber’s location. |
| ProviderName | String | The provider’s company name. |
| Labors | Array of objects | The information on labor. |
| Labors.SkillLevel | Integer | The skill level of a worker. Possible values: 1 — Supervisor; 2 — Technician; 3 — Helper. |
| Labors.LaborType | Integer | The type of the pay rate. Possible values: 1 — Regular; 2 — Overtime; 3 — Double time. |
| Labors.NumOfTech | Integer | The number of workers. |
| Labors.HourlyRate | Number | The worker hourly rate. |
| Labors.Hours | Number | Total hours the worker spent to complete the work order. |
| Labors.Amount | Number | The monetary amount of the labor charge. |
| Materials | Array of objects | The information on the materials used. |
| Materials.Description | String | The name or description of the material. |
| Materials.PartNum | String | The part, serial, or manufacturer number of the material. |
| Materials.UnitType | Integer | A unit of measurement. Possible values: 1 — Each; 2 — Box; 3 — Feet; 4 — Sqft; 5 — Lbs; 6 — Gal; 7 — Oz. |
| Materials.UnitPrice | Number | The price per unit. |
| Materials.Quantity | Number | The quantity of the material. |
| Materials.Amount | Number | The monetary amount of the material cost. |
| Category | String | The overall classification of the WO, for example, MAINTENANCE or REPAIR. |
| CreatedBy | Object | The information on the user who created the invoice. |
| CreatedBy.Id | Integer | The user ID of the person who created the invoice. |
| CreatedBy.AuthUserId | Integer | The single sign-on (SSO) ID of the person who created the invoice. |
| CreatedBy.UserName | String | The username of the person who created the invoice. |
| CreatedBy.FullName | String | The first and last name of the person who created the invoice. |
| CreatedBy.Email | String | The email of the person who created the invoice. |
Proposal
A proposal is an offer from a provider to a subscriber detailing costs required to complete a job.
ProposalCreated
{
"Object": {
"Id": 6973063,
"Number": "987654321",
"Description": "New air conditioner",
"Comments": null,
"Trade": "HVAC",
"LocationId": 2006071467,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"WorkOrderId": null,
"WorkOrderNumber": null,
"RfpId": null,
"CurrencyAlphabeticalCode": "USD",
"CreatedBy": {
"Id": 1388819,
"AuthUserId": null,
"UserName": null,
"FullName": null,
"Email": null,
"LoginType": null
},
"UpdatedBy": null,
"AssignedTo": null,
"RequestedBy": "Anastasia Uberoy",
"ScheduledDate": null,
"Status": "open",
"Attachments": null,
"Amount": 644,
"AmountCategories": [
{
"Id": 6012,
"Name": "Materials",
"TotalCost": 45
},
{
"Id": 6013,
"Name": "Installation Labor",
"TotalCost": 26
},
{
"Id": 6014,
"Name": "Non-Installation Expenses",
"TotalCost": 7.5
},
{
"Id": 6015,
"Name": "Freight",
"TotalCost": 5
},
{
"Id": 6016,
"Name": "Tax",
"TotalCost": 10.5
},
{
"Id": 6017,
"Name": "Costs incurred to date",
"TotalCost": 550
}
],
"Asset": [
{
"Id": "125468",
"Action": "REPLACE",
"Area": "BACK DOOR",
"BrandId": "560",
"TypeId": "7524",
"IsNew": false,
"Attributes": [
{
"Name": "Tag ID",
"Value": "111"
}
]
},
{
"Id": "433854",
"Action": "REPLACE",
"Area": "FRONT DOOR",
"BrandId": "1878",
"TypeId": "7524",
"IsNew": true,
"Attributes": [
{
"Name": "Tag ID",
"Value": "222"
}
]
}
],
"Category": null
},
"EventType": "ProposalCreated"
}
ProposalOpen
{
"Object": {
"Id": 12364334,
"Number": "prp70621150717667-0",
"Comments": "",
"Trade": "HVAC",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"UpdatedBy": {
"Id": 1543802,
"UserName": "SC-Dev1",
"FullName": "",
"Email": ""
},
"Status": "Open",
"Category": "REPAIR"
},
"EventType": "ProposalOpen"
}
ProposalApproved
{
"Object": {
"Id": 12364335,
"Number": "prp70721051115800",
"Comments": "",
"Trade": "GLASS",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"UpdatedBy": {
"Id": 1543802,
"UserName": "SC-Dev1",
"FullName": "",
"Email": ""
},
"Status": "Approve",
"Category": "REPAIR"
},
"EventType": "ProposalApproved"
}
ProposalOnHold
{
"Object": {
"Id": 12364334,
"Number": "prp70621150717667-0",
"Comments": "The invoice requires further review before being approved or rejected.",
"Trade": "HVAC",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"UpdatedBy": {
"Id": 1543802,
"UserName": "SC-Dev1",
"FullName": "",
"Email": ""
},
"Status": "OnHold",
"Category": "REPAIR"
},
"EventType": "ProposalOnHold"
}
ProposalRejected
{
"Object": {
"Id": 12364332,
"Number": "150692",
"Comments": "",
"Trade": "DOORS",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"UpdatedBy": {
"Id": 1543802,
"UserName": "SC-Dev1",
"FullName": "",
"Email": ""
},
"Status": "Reject",
"Category": "REPAIR"
},
"EventType": "ProposalRejected"
}
ProposalUserAssigned
{
"Object": {
"Id": 12364334,
"Number": "prp70621150717667-0",
"Trade": "HVAC",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"UpdatedBy": {
"Id": 1543802,
"UserName": "SC-Dev1",
"FullName": "",
"Email": ""
},
"AssignedTo": {
"Id": 1431539,
"UserName": "SC_API_test",
"FullName": "",
"Email": ""
},
"Category": "REPAIR"
},
"EventType": "ProposalUserAssigned"
}
ProposalWorkOrderAssigned
{
"Object": {
"Id": 12364334,
"Number": "prp70621150717667-0",
"Trade": "HVAC",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"WorkOrderId": 177892428,
"UpdatedBy": {
"Id": 1543802,
"UserName": "SC-Dev1",
"FullName": "",
"Email": ""
},
"Category": "MAINTENANCE"
},
"EventType": "ProposalWorkOrderAssigned"
}
ProposalVoided
{
"Object": {
"Id": 12364334,
"Number": "prp70621150717667-0",
"Trade": "HVAC",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"UpdatedBy": {
"Id": 1544987,
"UserName": "TestApi",
"FullName": "",
"Email": ""
},
"Status": "Void"
},
"EventType": "ProposalVoided"
}
ProposalScheduled
{
"Object": {
"Id": 12364334,
"Number": "prp70621150717667-0",
"Trade": "HVAC",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"WorkOrderId": 180435269,
"UpdatedBy": {
"Id": 1544987,
"UserName": "TestApi",
"FullName": "",
"Email": ""
},
"ScheduledDate": "2021-07-09T00:00:00",
"Category": "MAINTENANCE"
},
"EventType": "ProposalScheduled"
}
ProposalAttachmentAdded
{
"Object": {
"Id": 12364334,
"Trade": "HVAC",
"LocationId": 2006516537,
"SubscriberId": 2014917243,
"ProviderId": 2000090505,
"Attachments": [
{
"Id": 3424133,
"Description": "",
"Name": "AC.jfif",
"Date": "2021-07-06T15:09:09.6306691Z",
"Uri": "https://scitappssb2.blob.core.windows.net/proposals/d9265841-6b00-43a3-97d9-eea181718cca?sv=2019-02-02&sr=b&sig=4RgprgZqAbLqAAIfO32HD0494kZtRcOraP%2BMTN1hRko%3D&se=2021-07-06T15%3A39%3A09Z&sp=r&rsct=image%2Fpjpeg&rscd=attachment%3Bfilename*%3DUTF-8''AC.jfif",
"Type": 0
}
]
},
"EventType": "ProposalAttachmentAdded"
}
Field descriptions
| Attribute | Data type | Description |
|---|---|---|
| Id | Integer | The proposal unique ID. Generated automatically and cannot be modified. |
| Number | String | The proposal number. |
| Description | String | The proposal detailed description. |
| Comments | String | The comment added to the proposal. |
| Trade | String | The type of work a provider performs, for example, CARPENTRY or PLUMBING. |
| LocationId | Integer | The unique ID of the subscriber’s location. |
| SubscriberId | Integer | The unique subscriber’s ID. |
| ProviderId | Integer | The unique provider’s ID. |
| WorkOrderId | Integer | The unique ID of the work order connected to the proposal. |
| WorkOrderNumber | String | The number of the work order connected to the proposal. |
| RfpId | Integer | The unique ID of the request for proposal (RFP) associated with the proposal. |
| CurrencyAlphabeticalCode | String | The proposal currency three-letter alphabetic code, for example, USD. |
| CreatedBy | Object | The information on the user who created the proposal. |
| CreatedBy.Id | Integer | The user ID of the person who created the proposal. |
| CreatedBy.AuthUserId | Integer | The single sign-on (SSO) ID of the person who created the proposal. |
| CreatedBy.UserName | String | The username of the person who created the proposal. |
| CreatedBy.FullName | String | The first and last name of the person who created the proposal. |
| CreatedBy.Email | String | The email of the person who created the proposal. |
| CreatedBy.LoginType | String | The type of the credentials used by the person that created the proposal. Usually, either User ID and password combination or PIN. |
| AssignedTo | Object | The information on the person the proposal was assigned to. |
| AssignedTo.Id | Integer | The user ID of the person the proposal was assigned to. |
| AssignedTo.UserName | String | The username of the person the proposal was assigned to. |
| AssignedTo.FullName | String | The first and last name of the person the proposal was assigned to. |
| RequestedBy | String | The name of the person that requested the proposal. |
| ScheduledDate | String | The scheduled date and time when a provider is expected to be on site. |
| Status | String | The stage the proposal is currently in. |
| Attachments | Object | The information on the proposal attachments. |
| Attachments.Id | Integer | The unique ID of the proposal attachment. |
| Attachments.Description | String | The description of the proposal attachment. |
| Attachments.Name | String | The file name of the proposal attachment. |
| Attachments.Date | String (date-time) | The date and time when the attachment was added to the proposal. |
| Attachments.Uri | String | The URI to the proposal attachment. |
| Amount | Number | The total monetary amount of the proposal. |
| AmountCategories | Array of objects | The information on the proposal items. |
| AmountCategories.Id | Integer | The unique ID of the proposal item. |
| AmountCategories.Name | String | The name of the proposal item. |
| AmountCategories.TotalCost | Number | The total cost of the proposal item. |
| Asset | Array of objects | The information on assets associated with the proposal. |
| Asset.Id | String | The ID of the asset. |
| Asset.Action | String | The recommendation for action a provider needs to perform on the asset. Possible values: REPAIR, REPLACE, NEW, REMOVE. |
| Asset.Area | String | The exact place within one location the asset belongs to. |
| Asset.BrandId | String | The ID of the asset brand. |
| Asset.TypeId | String | The ID of the asset type. |
| Asset.IsNew | Boolean | Defines if the asset is new or existing. |
| Asset.Attributes | Array of objects | Additional fields that describe the asset. |
| Asset.Attributes.Name | String | The name of the field. |
| Asset.Attributes.Value | String | The value of the field. |
| Category | String | The overall classification of the WO, for example, MAINTENANCE or REPAIR. |
| UpdatedBy | Object | The information on the user who updated the proposal. |
| UpdatedBy.Id | Integer | The user ID of the person who updated the proposal. |
| UpdatedBy.UserName | String | The username of the person who updated the proposal. |
| UpdatedBy.FullName | String | The first and last name of the person who updated the proposal. |
| UpdatedBy.Email | String | The email of the person the proposal was updated by. |
Private Invitation Events
A Fixxbook invitation is an invitation sent to a provider to join a subscriber’s Private Network.
FbInvitationAccepted
{
"Object": {
"ClientId": 28011,
"ContractorId": 57037,
"ScProviderId": 2000075120,
"ScSubscriberId": 2014916762,
"Status": "Accepted"
},
"EventType": "FbInvitationAccepted"
}
Field descriptions
| Attribute | Data type | Description |
|---|---|---|
| ClientId | Integer | The unique subscriber’s company ID in Fixxbook. |
| ContractorId | Integer | The unique provider’s company ID in Fixxbook. |
| ScProviderId | Integer | The unique provider’s ID in the ServiceChannel system. |
| ScSubscriberId | Integer | The unique subscriber’s ID in the ServiceChannel system. |
| Status | String | The status of the invitation. Always Accepted for the FbInvitationAccepted event. |
Location
Locations are places where subscriber’s facilities (buildings, stores, restaurants, offices, etc.) are geographically situated.
LocationCreated
{
"Object": {
"StoreId": "047",
"Id": 2007357125,
"SubscriberId": 2014916940,
"ShortName": "Absecon (CSR)",
"FullName": "Absecon (CSR)",
"Address2": "1 Cajun Soul Way",
"City": "Absecon",
"State": "CA",
"Country": "US",
"Zip": "11751",
"NotesCount": 0,
"Latitude": 38.47495,
"Longitude": 54.64325,
"UpdatedUserName": "sc-smoore",
"UpdatedDate": "2022-09-02T19:24:09.7748402Z"
},
"EventType": "LocationCreated",
"Version": 1
}
LocationUpdated
{
"Object": {
"StoreId": "047",
"Id": 2007357125,
"SubscriberId": 2014916940,
"ShortName": "Absecon (CSR)",
"FullName": "Absecon (CSR)",
"Address1": "1 Cajun Soul Way",
"Address2": "1 Cajun Soul Way",
"City": "Absecon",
"Country": "US",
"Zip": "11751",
"NotesCount": 0,
"Latitude": 38.47495,
"Longitude": 54.64325,
"UpdatedUserName": "sc-smoore",
"UpdatedDate": "2022-09-02T19:38:57.5889061Z"
},
"EventType": "LocationUpdated",
"Version": 1
}
LocationDeleted
{
"Object": {
"StoreId": "047",
"Id": 2007357125,
"SubscriberId": 2014916940,
"ShortName": "Absecon (CSR)",
"FullName": "Absecon (CSR)",
"Address1": "1 Cajun Soul Way",
"Address2": "1 Cajun Soul Way",
"City": "Absecon",
"State": "CA",
"Country": "US",
"StoreOpen": "2022-09-01T00:00:00",
"Zip": "11751",
"NotesCount": 0,
"Latitude": 38.47495,
"Longitude": 54.64325,
"TimeZoneId": "Pacific Standard Time (Mexico)",
"UpdatedUserName": "sc-smoore",
"UpdatedDate": "2022-09-02T16:17:43.597"
},
"EventType": "LocationDeleted",
"Version": 1
}
LocationNoteHeaderCreated
{
"Object": {
"Id": 40689,
"SubscriberId": 2014916940,
"Name": "Supply Manager",
"SearchType": "None",
"Access": "Public",
"User": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
}
},
"EventType": "LocationNoteHeaderCreated",
"Version": 1
}
LocationNoteHeaderUpdated
{
"Object": {
"Id": 12812,
"SubscriberId": 2014916940,
"Name": "District Manager",
"SearchType": "Contains",
"Access": "Public",
"User": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
}
},
"EventType": "LocationNoteHeaderUpdated",
"Version": 1
}
LocationNoteHeaderDeleted
{
"Object": {
"Id": 40689,
"SubscriberId": 2014916940,
"Name": "Supply Manager",
"SearchType": "None",
"Access": "Public",
"User": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
}
},
"EventType": "LocationNoteHeaderDeleted",
"Version": 1
}
LocationNotesChanged
{
"Object": {
"SubscriberId": 2014916940,
"LocationId": 2007136049,
"ChangedValues": [
{
"Name": "Brand",
"Value": "CSR"
}
],
"User": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
}
},
"EventType": "LocationNotesChanged",
"Version": 1
}
Field descriptions
| Attribute | Data type | Description |
|---|---|---|
| SubscriberId | Integer | Unique numeric identifier of the subscriber. |
| LocationId | Integer | Unique numeric identifier of the location. |
| StoreId | Integer | Alphanumeric identifier of the store in the subscriber’s system. Assigned by and unique per subscriber. |
| ShortName | String | Location shortened name. |
| FullName | String | Location name. |
| Address1 | String | Additional location address. |
| Address2 | String | Main location address. |
| City | String | Location city. |
| State | String | State where the location is situated. |
| Country | String | Location country. |
| Zip | String | Location ZIP or postal code. |
| NotesCount | Integer | Number of location note headers within the specified location. |
| Latitude | Number | Global position of the location. Latitude. |
| Longitude | Number | Global position of the location. Longitude. |
| UpdatedUserName | String | Name of the user who created, updated, or deleted a location. |
| UpdatedDate | String | Date when location was changed (created, updated, or deleted). |
| ChangedValues | Object | Information about location notes that have been changed by a user. |
| ChangedValues.Name | String | The name of a location note header. |
| ChangedValues.Value | String | The value of a location note header. |
| User | Object | Information about the user who has performed actions with location note headers or location notes. |
| User.Id | Integer | Unique numeric identifier of the user. |
| User.AuthUserId | Integer | The single sign-on (SSO) ID of the user. |
| User.UserName | String | Name of the user. |
| User.FullName | String | Full name of the user. |
| User.Email | String | Email of the user. |
| User.SubscriberId | Integer | Unique numeric identifier of the subscriber the user relates to. |
| LocationNoteHeader | Object | Information about the location note header. |
| LocationNoteHeader.Id | Integer | Unique numeric identifier of the location note header. |
| LocationNoteHeader.SubscriberId | Integer | Unique numeric identifier of the subscriber a location note header relates to. |
| LocationNoteHeader.Name | String | Name of the location note header. |
| LocationNoteHeader.SearchType | String | Type of searching a location when filtering by the location note header. Possible values: None - The location note header will not be available as a search criterion across the platform. Exact - A user will be able to search for work orders, proposals, locations, and more by this location note header but they should always enter the exact location note value to get the search results. Contains - A user will be able to search for work orders, proposals, locations, and more by this location note header using a keyword. |
| LocationNoteHeader.Access | String | Type of access to the location note header. Possible values: Public - The location note header is visible for all users and everywhere across the platform. Private - The location note header is not visible for providers and dashboard users. |
Subscriber
A subscriber is a company whose buildings, stores, restaurants, or offices are subject to facility service rendered by a service provider.
A category is the overall classification of a work order, such as Maintenance, Repair, or CAPEX.
A trade is a bucket in which work orders are placed for further categorization, for example, HVAC, refrigeration, janitorial, lighting.
A priority is the period during which a service provider should complete the work.
Status is the state of the work order at a particular time, for example, OPEN, IN PROGRESS, or COMPLETED.
SubscriberCategoryCreated
{
"Object": {
"Id": 20697,
"SubscriberId": 2014916940,
"Name": "MAINTENANCE",
"PrimaryCategoryId": 6
},
"EventType": "SubscriberCategoryCreated",
"Version": 1
}
SubscriberCategoryUpdated
{
"Object": {
"Id": 20697,
"SubscriberId": 2014916940,
"Name": "MAINTENANCE",
"PrimaryCategoryId": 5
},
"EventType": "SubscriberCategoryUpdated",
"Version": 1
}
SubscriberCategoryDeleted
{
"Object": {
"Id": 20697,
"SubscriberId": 2014916940
},
"EventType": "SubscriberCategoryDeleted",
"Version": 1
}
SubscriberTradeCreated
{
"Object": {
"Id": 136467,
"SubscriberId": 2014916940,
"Name": "GLASS",
"NamePrimary": "GLASS & MIRRORS"
},
"EventType": "SubscriberTradeCreated",
"Version": 1
}
SubscriberTradeUpdated
{
"Object": {
"Id": 136467,
"SubscriberId": 2014916940,
"Name": "GLASS",
"NamePrimary": "GLASS & MIRRORS"
},
"EventType": "SubscriberTradeUpdated",
"Version": 1
}
SubscriberTradeDeleted
{
"Object": {
"Id": 136467,
"SubscriberId": 2014916940,
"Name": "GLASS",
"NamePrimary": "GLASS & MIRRORS"
},
"EventType": "SubscriberTradeDeleted",
"Version": 1
}
SubscriberPriorityCreated
{
"Object": {
"Id": 12306,
"SubscriberId": 2014916940,
"PriorityName": "Normal-48 Hours",
"Eta": 2880,
"SkipNights": true,
"SkipWeekends": true,
"SkipWhenClosed": true,
"ShiftScheduledTimeTo": "09:00:00",
"IsNonSelectable": false
},
"EventType": "SubscriberPriorityUpdated",
"Version": 1
}
SubscriberPriorityUpdated
{
"Object": {
"Id": 12306,
"SubscriberId": 2014916940,
"PriorityName": "Normal-48 Hours",
"Eta": 2880,
"SkipNights": true,
"SkipWeekends": false,
"SkipWhenClosed": false,
"ShiftScheduledTimeTo": "10:00:00",
"IsNonSelectable": false
},
"EventType": "SubscriberPriorityUpdated",
"Version": 1
}
SubscriberPriorityDeleted
{
"Object": {
"Id": 12306,
"SubscriberId": 2014916940
},
"EventType": "SubscriberPriorityDeleted",
"Version": 1
}
SubscriberStatusCreated
{
"Object": {
"Id": 39825,
"SubscriberId": 2014916940,
"Primary": "IN PROGRESS",
"Extended": "PARTS ON ORDER",
"SubscriberOptions": {
"NotToExceedAmount": 200,
"AdminCanSelect": true,
"CanSelect": true
},
"ProviderOptions": {
"CanSelect": false,
"CanSelectForCompleted": false,
"ResolutionTextRequired": false,
"ResolutionCodesRequired": false,
"ShippingInfoRequired": false,
"ScheduledDateIsRequired": false,
"ResetNotToExceedToZero": false,
"AskForReviews": false,
"CanCreateProposal": true
}
},
"EventType": "SubscriberStatusCreated",
"Version": 1
}
SubscriberStatusUpdated
{
"Id": 39825,
"SubscriberId": 2014916940,
"Primary": "IN PROGRESS",
"Extended": "PARTS ON ORDER",
"SubscriberOptions": {
"NotToExceedAmount": 200,
"AdminCanSelect": true,
"CanSelect": true
},
"ProviderOptions": {
"CanSelect": true,
"CanSelectForCompleted": false,
"ResolutionTextRequired": false,
"ResolutionCodesRequired": false,
"ShippingInfoRequired": true,
"ScheduledDateIsRequired": false,
"ResetNotToExceedToZero": false,
"AskForReviews": false,
"CanCreateProposal": true
}
},
"EventType": "SubscriberStatusUpdated",
"Version": 1
}
SubscriberStatusDeleted
{
"Object": {
"Id": 39825,
"SubscriberId": 2014916940
},
"EventType": "SubscriberStatusDeleted",
"Version": 1
}
Field Descriptions
| Attribute | Data Type | Desciption |
|---|---|---|
| Id | Integer | Unique numeric identifier of the category/trade/priority/status. |
| SubscriberId | Integer | Unique numeric identifier of the subscriber. |
| Name | String | Name of the category/trade/ status. |
| NamePrimary | String | Primary trade name. |
| PrimaryCategoryId | String | Unique numeric identifier of the primary category. |
| PriorityName | String | Priority name. |
| Eta | Integer | Estimated time of arrival. |
| SkipNights | Boolean | When true, nights should be skipped while calculating the scheduled date. |
| SkipWeekends | Boolean | When true, weekends should be skipped while calculating the scheduled date. |
| SkipWhenClosed | Boolean | When true, closing hours should be skipped while calculating the scheduled date. |
| ShiftScheduledTimeTo | String (time) | Scheduled time shifts to the time specified in ShiftScheduledTimeTo. |
| IsNonSelectable | Boolean | When true, the priority is no longer selectable while creating work orders. |
| Primary | String | Primary status of the work order, for example, IN PROGRESS. |
| Extended | String | Extended status of the work order, for example, PARTS ON ORDER. |
| SubscriberOptions | Array of objects | Options available for subscribers. |
| SubscriberOptions.NotToExceedAmount | Integer | NTE amount will be set to the value specified in ‘NotToExceedAmount’ once a subscriber user selects this status. |
| SubscriberOptions.AdminCanSelect | Boolean | When true, subscriber users with admin permissions can move work orders to this status. |
| SubscriberOptions.CanSelect | Boolean | When true, non-admin subscriber users can assign this status to work orders. |
| ProviderOptions | Array of objects | Options available for providers. |
| ProviderOptions.CanSelect | Boolean | When true, providers can set this status for Open and In Progress work orders. |
| ProviderOptions.CanSelectForCompleted | Boolean | When true, providers can set this status for Completed work orders. |
| ProviderOptions.ResolutionTextRequired | Boolean | When true, providers are required to enter a resolution text for this status. |
| ProviderOptions.ShippingInfoRequired | Boolean | When true, providers are required to enter shipping information for parts for this status: destination, carrier, and shipping tracking number. |
| ProviderOptions.ScheduledDateIsRequired | Boolean | When true, the Scheduled Date value will be checked if it’s empty or not for this status. |
| ProviderOptions.ResetNotToExceedToZero | Boolean | When true, the NTE amount of a work order will be set to 0 once a provider moves it to this status. |
| ProviderOptions.AskForReviews | Boolean | When true, the star review process is active for Completed work orders. |
| ProviderOptions.CanCreateProposal | Boolean | When true, providers can create proposals for work orders in this status. |
ServiceProvider/Contract
A service provider (or ‘provider’) is a company that renders facility services to subscribers.
A trade is a bucket that work orders are placed in for further categorization, for example, HVAC, refrigeration, janitorial, lighting.
ProviderTradeAssigned
{
"Object": {
"ProviderId": 2000069665,
"TradedId": 73419,
"SubscriberId": 2014916940,
"LocationIds": [
2007357125
],
"UpdatedBy": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
}
},
"EventType": "ProviderTradeAssigned",
"Version": 1
}
ProviderTradeUnassigned
{
"Object": {
"ProviderId": 2000069665,
"TradedId": 73419,
"SubscriberId": 2014916940,
"LocationIds": [
2007357125
],
"UpdatedBy": {
"Id": 907823,
"AuthUserId": 677015,
"UserName": "sc-smoore",
"FullName": "Sharon Moore",
"Email": "cajunsoulrestaurant@gmail.com",
"SubscriberId": 2014916940
}
},
"EventType": "ProviderTradeUnassigned",
"Version": 1
}
Field Descriptions
| Attribute | Data Type | Description |
|---|---|---|
| ProviderId | Integer | Unique numeric identifier of the provider. |
| TradeId | Integer | Numeric identifier of the primary trade of an asset. |
| SubscriberId | Integer | Unique numeric identifier of the subscriber. |
| LocationIds | Object | Array of unique numeric identifiers of the locations for which the provider is assigned to the specific trade. |
| UpdatedBy | Object | Information about the user who assigned the provider to the trade. |
| UpdatedBy.Id | Integer | Unique numeric identifier of the user. |
| UpdatedBy.AuthUserId | Integer | The single sign-on (SSO) ID of the user. |
| UpdatedBy.UserName | String | Name of the user. |
| UpdatedBy.FullName | String | Full name of the user. |
| UpdatedBy.Email | String | Email of the user. |
| UpdatedBy.SubscriberId | Integer | Unique numeric identifier of the subscriber the user relates to. |
Checklist
A checklist is a list of questions that a technician is supposed to answer during an onsite visit.
CheckListCreated
{
"Object": {
"Id": 741,
"Name": "Checklist name",
"IsActive": true,
"CreatedDate": "2022-07-07T18:19:36.36",
"UpdatedDate": "2022-07-07T18:19:36.36",
"CreatedBy": 907823,
"UpdatedBy": 907823,
"Locations": [
2007346835
],
"Trades": [
124732,
99202
],
"Categories": [
6886,
15864,
6887
],
"Questions": [
{
"Id": 6974,
"CheckListId": 741,
"Question": "Are you wearing protective gear?",
"AnswerRequired": true,
"PictureFlag": 0,
"Sequence": 0,
"QuestionType": 1,
"CheckListQuestionOptions": [
{
"Id": 7783,
"Answer": "Yes",
"IsConditionalFollowUp": false
},
{
"Id": 7784,
"Answer": "No",
"IsConditionalFollowUp": false
}
],
"AnswerCanPersist": false,
"CheckListTimingType": 1
}
],
"SubscriberId": 2014916940
},
"EventType": "CheckListCreated",
"Version": 1
}
CheckListUpdated
{
"Object": {
"Id": 741,
"Name": "Checklist name",
"IsActive": true,
"CreatedDate": "2022-07-07T18:19:36.36",
"UpdatedDate": "2022-07-07T18:24:34.987",
"CreatedBy": 907823,
"UpdatedBy": 907823,
"Locations": [
2007346835
],
"Trades": [
124732,
99202
],
"Categories": [
6886,
6887,
15864
],
"Questions": [
{
"Id": 6974,
"CheckListId": 741,
"Question": "Are you wearing protective gear?",
"AnswerRequired": true,
"PictureFlag": 0,
"Sequence": 0,
"QuestionType": 1,
"CheckListQuestionOptions": [
{
"Id": 7783,
"Answer": "Yes",
"IsConditionalFollowUp": false
},
{
"Id": 7784,
"Answer": "No",
"IsConditionalFollowUp": false
}
],
"AnswerCanPersist": false,
"CheckListTimingType": 1
},
{
"Id": 6975,
"CheckListId": 741,
"Question": "How many people worked on the issue today?",
"AnswerRequired": true,
"PictureFlag": 1,
"Sequence": 0,
"QuestionType": 4,
"CheckListQuestionOptions": [],
"AnswerCanPersist": false,
"CheckListTimingType": 2
}
],
"SubscriberId": 2014916940
},
"EventType": "CheckListUpdated",
"Version": 1
}
CheckListDeleted
{
"Object": {
"Id": 741,
"Name": "Checklist name2",
"IsActive": false,
"CreatedDate": "2022-07-15T18:19:36.36",
"UpdatedDate": "2022-07-15T18:25:33.023",
"CreatedBy": 907823,
"UpdatedBy": 907823,
"Locations": [
2007346835
],
"Trades": [
124732,
99202],
"Categories": [
6886,
6887,
15864
],
"Questions": [
{
"Id": 6974,
"CheckListId": 741,
"Question": "Are you wearing protective gear?",
"AnswerRequired": true,
"PictureFlag": 0,
"Sequence": 0,
"QuestionType": 1,
"CheckListQuestionOptions": [
{
"Id": 7783,
"Answer": "Yes",
"IsConditionalFollowUp": false
},
{
"Id": 7784,
"Answer": "No",
"IsConditionalFollowUp": false
}
],
"AnswerCanPersist": false,
"CheckListTimingType": 1
},
{
"Id": 6975,
"CheckListId": 741,
"Question": "How many people worked on the issue today?",
"AnswerRequired": true,
"PictureFlag": 1,
"Sequence": 0,
"QuestionType": 4,
"CheckListQuestionOptions": [],
"AnswerCanPersist": false,
"CheckListTimingType": 2
}
],
"SubscriberId": 2014916940
},
"EventType": "CheckListDeleted",
"Version": 1
}
CheckListResponseAdded
{
"Object": {
"CheckListResponse": {
"CheckListQuestionId": 7266,
"ProviderId": 2000069665,
"TechnicianId": 117835,
"Id": 4449916,
"Answer": "1",
"EntityId": 214433714,
"EntityTypeId": 0,
"Attempt": 1,
"UpdatedDate": "2022-09-06T17:01:12.393",
"UpdatedDateDto": "2022-09-06T17:01:12.393-04:00"
},
"CheckListResponsePicture": {
"Id": 0,
"CheckListResponseId": 0,
"UpdatedBy": 2338972
},
"SubscriberId": 2014916940,
"UpdatedBy": {
"Id": 2338972,
"AuthUserId": 278302,
"UserName": "g.b.technician@gmail.com",
"FullName": "George Joseph Byron",
"Email": "g.b.technician@gmail.com",
"ProviderId": 2000069665
}
},
"EventType": "CheckListResponseAdded",
"Version": 1
}
CheckListResponseUpdated
{
"Object": {
"CheckListResponse": {
"CheckListQuestionId": 7266,
"ProviderId": 2000069665,
"TechnicianId": 117835,
"Id": 728,
"Answer": "2",
"EntityId": 214433714,
"EntityTypeId": 0,
"Attempt": 1,
"UpdatedDate": "2022-09-06T17:06:57.003",
"UpdatedDateDto": "2022-09-06T17:06:57.003-04:00"
},
"CheckListResponsePicture": {
"Id": 0,
"CheckListResponseId": 0,
"UpdatedBy": 2338972
},
"SubscriberId": 2014916940,
"UpdatedBy": {
"Id": 2338972,
"AuthUserId": 278302,
"UserName": "g.b.technician@gmail.com",
"FullName": "George Joseph Byron",
"Email": "g.b.technician@gmail.com",
"ProviderId": 2000069665
}
},
"EventType": "CheckListResponseUpdated",
"Version": 1
}
Field descriptions
| Attribute | Data type | Description |
|---|---|---|
| Id | String | Unique numeric identifier of the checklist. |
| Name | String | Checklist name. |
| IsActive | Boolean | Defines whether the checklist is active or not. |
| CreatedDate | String | Date and time when the checklist was created. |
| UpdatedDate | String | Date and time when the checklist was last updated. |
| CreatedBy | Integer | Unique numeric identifier of the user who created the checklist. |
| UpdatedBy | Integer | Unique numeric identifier of the user who last updated the checklist. |
| Locations | Object | Array of unique numeric identifiers of the locations for which the checklist was created. |
| Trades | Object | Array of unique numeric identifiers of the trades for which the checklist was created. A trade means the type of work a provider performs, for example, CARPENTRY or PLUMBING. |
| Categories | Object | Array of unique numeric identifiers of the categories for which the checklist was created. A category means the overall classification of the work order, for example, MAINTENANCE or REPAIR. |
| Questions | Array of objects | Information on the questions a technician is prompted to answer when working on a service request. |
| Questions.Id | Integer | Unique numeric identifier of the question. |
| Questions.CheckListId | Integer | Unique numeric identifier of the checklist the question belongs to. |
| Questions.Question | String | Checklist question that a technician is prompted to answer when working on a service request. |
| Questions.AnswerRequired | Boolean | Defines whether answering this checklist question is mandatory. |
| Questions.PictureFlag | String | Defines whether a technician is required to upload an attachment when answering the question:0 — Adding an attachment is optional.1 — An attachment is not required.2 — Uploading an attachment is mandatory. |
| Questions.Sequence | Integer | Checklist question sequence number. |
| Questions.QuestionType | String | Checklist question type:0 — Acknowledgement: Represents an on/off toggle prompting a technician to give a positive or negative response to a question.1 — Selector: Provides multiple configured answer options to choose from.2 — Text Entry: Allows entering a text answer.4 — Numeric Input: Prompts to submit a number as a response. |
| Questions.CheckListQuestionOptions | Array of objects | Answer option configured for a checklist question of the Selector type. |
| Questions.CheckListQuestionOptions.Id | Integer | Unique numeric identifier of the answer option for a checklist question of the Selector type. |
| Questions.CheckListQuestionOptions.Answer | String | Answer option for a checklist question of the Selector type. A technician can select from a list of configured options when answering the question. |
| Questions.CheckListQuestionOptions.IsConditionalFollowUp | Boolean | Defines whether a technician is prompted to add a comment to the selected answer option. A comment is mandatory if answering the checklist question is required. |
| Questions.AnswerCanPersist | Boolean | Defines whether the answer to this question can persist. If the answer is persistent, the last submitted response populates on the question upon every further onsite visit for the work order. A technician can either opt for the current response or update it. |
| Questions.CheckListTimingType | String | Defines the checklist segment the question belongs to: 1 — check-in segment, 2 — check-out segment. |
| SubscriberId | String | Unique numeric identifier of the subscriber. |
| CheckListResponse | Object | Information about the response to the checklist question. |
| CheckListResponse.CheckListQuestionId | Integer | Unique numeric identifier of the question the response belongs to. |
| CheckListResponse.ProviderId | Integer | Unique numeric identifier of the provider whose technician has answered the question. |
| CheckListResponse.TechnicianId | Integer | Unique numeric identifier of the technician who has answered the question. |
| CheckListResponse.Id | Integer | Unique numeric identifier of the response. |
| CheckListResponse.Answer | String / Integer / Boolean | Answer to a checklist question. Checklist question type defines the response type: Acknowledgement. A choice answer. Possible values: on, off, 1, 0, true, false, yes, no.Text Entry. A text answer. The maximum length is 500 characters. Numeric Input. A numeric answer. |
| CheckListResponse.EntityId | Integer | Unique numeric identifier of the work order the technician works on while answering the checklist questions. |
| CheckListResponse.EntityTypeId | Integer | Entity type for which the response is given. A work order entity type is defined as 0. |
| CheckListResponse.Attempt | Integer | Order of a technician’s on-site visit to submit a checklist response for. |
| CheckListResponse.UpdatedDate | String | Date and time when the checklist response was last updated. |
| CheckListResponse.UpdatedDateDto | String | Date and time in UTC format when the checklist response was last updated. |
| CheckListResponsePicture | Object | Information about the image attached to the response. |
| CheckListResponsePicture.Id | Integer | Unique numeric identifier of the image attached to the checklist response. |
| CheckListResponsePicture.CheckListResponseId | Integer | Unique numeric identifier of the response. |
| CheckListResponsePicture.UpdatedBy | Integer | Unique numeric identifier of the user who last updated the image. |
| UpdatedBy | Object | Information about the user who updated the checklist response. |
| UpdatedBy.Id | Integer | Unique numeric identifier of the user. |
| UpdatedBy.AuthUserId | Integer | The single sign-on (SSO) ID of the user. |
| UpdatedBy.UserName | String | Name of the user. |
| UpdatedBy.FullName | String | Full name of the user. |
| UpdatedBy.Email | String | Email of the user. |
| UpdatedBy.ProviderId | Integer | Unique numeric identifier of the provider the user relates to. |
IssueList
An issue list is a list of exact issues and problem types that help dashboard users create work orders in an efficient way.
IssueListAssigned
{
"Object": {
"SubscriberId": 2014916940,
"SetupId": 3102
},
"EventType": "IssueListAssigned",
"Version": 1
}
Field descriptions
| Attribute | Data Type | Description |
|---|---|---|
| SubscriberID | String | Unique numeric identifier of the subscriber. |
| SetupID | String | Unique numeric identifier of the dashboard to which the issue list is added. |
Asset
An asset is an item of property owned by a subscriber company, for example, an oven, HVAC, elevator.
AssetCreated
{
"Object": {
"Id": 5803841,
"Tag": "573648-H",
"AssetTypeId": 5220,
"TradeId": 104025,
"BrandId": 3846,
"Active": true,
"AssetTag": "12345678901234",
"AssetStatus": 0,
"LocationId": 2005901195
},
"EventType": "AssetCreated",
"Version": 1
}
AssetUpdated
{
"Object": {
"Id": 5803841,
"Tag": "573648-H",
"AssetTypeId": 5220,
"TradeId": 104025,
"BrandId": 3846,
"Active": true,
"AssetTag": "12345678901234",
"AssetStatus": 3,
"LocationId": 2005901195
},
"EventType": "AssetUpdated",
"Version": 1
}
Field descriptions
| Attribute | Data Type | Description |
|---|---|---|
| Id | Integer | Unique numeric identifier of the asset. |
| Tag | String | Alphanumeric asset identifier assigned by the client. |
| AssetTypeId | Integer | Unique numeric identifier of an asset type. |
| TradeId | Integer | Numeric identifier of the primary trade of an asset. |
| BrandId | Integer | Unique numeric identifier of a manufacturer that produces an asset. |
| Active | Boolean | Shows whether an asset is still in use. Possible values: true, false. |
| AssetTag | String | Unique alphanumeric decoded value contained in a barcode, QR code, or NFC tag of an asset. It is used to scan assets via ServiceChannel Mobile and ServiceChannel Provider. |
| AssetStatus | Integer | Defines an asset repair status. Possible values: 0 - In Use, 1 - Out For Repair, 2 - Replacement Recommended, 3 - Repaired. |
| LocationId | Integer | Unique numeric identifier of a location an asset is assigned to. |
LeakRecord
A leak is a loss of the refrigerant from the appliance (HVAC or refrigerant equipment). A leak event, or leak record, is generated automatically, whenever a leak is discovered and reported.
LeakRecordCreated
{
"Object": {
"Id": 77580,
"Note": "Leak record was created. Trigger quantity = 123 lbs. 2 oz.; Charge = 260 lbs.; Leak Rate = 2880.81, CalculationMethod = Annualized",
"InitialMethod": "Unknown",
"FollowUpMethod": "Unknown",
"WorkOrderId": 212539386,
"SubscriberId": 2014916940
},
"EventType": "LeakRecordCreated",
"Version": 1
}
LeakRecordUpdated
{
"Object": {
"Id": 77580,
"Note": "Repair Date is changed to 'Aug 24 2022'. Initial Verification Date is changed to 'Aug 24 2022'. Followup Verification Date is changed to 'Aug 24 2022'. ",
"RepairDate": "2022-08-24T00:00:00",
"InitialDate": "2022-08-24T00:00:00",
"InitialMethod": "ElectronicLeakDetection",
"FollowUpDate": "2022-08-24T00:00:00",
"FollowUpMethod": "PressureTest",
"LocationId": 29,
"FaultCodeId": 5,
"ActionCodeId": 4,
"AreaId": 4,
"WorkOrderId": 212539387,
"SubscriberId": 2014916940
},
"EventType": "LeakRecordUpdated",
"Version": 1
}
LeakRecordedDeleted
{
"Object": {
"Id": 77580,
"RepairDate": "2022-08-24T00:00:00",
"InitialDate": "2022-08-24T00:00:00",
"InitialMethod": "ElectronicLeakDetection",
"FollowUpDate": "2022-08-24T00:00:00",
"FollowUpMethod": "PressureTest",
"LocationId": 29,
"FaultCodeId": 5,
"ActionCodeId": 4,
"AreaId": 4,
"WorkOrderId": 212539387,
"SubscriberId": 2014916940
},
"EventType": "LeakRecordDeleted",
"Version": 1
}
Field descriptions
| Attribute | Data Type | Description |
|---|---|---|
| Leak Record ID | Integer | Unique numeric identifier of the leak event (record). |
| Note | String | Note that providers or subscribers add to a leak record providing additional information about the leak that happened and the way it has been fixed. |
| RepairDate | String (date-time) | Date when the leak was repaired. |
| InitialDate | String (date-time) | Date when the provider verified the first time that the leak event was repaired (initial verification). |
| InitialMethod | String | Method used to verify the first time that the leak was repaired (initial verification). |
| FollowUpDate | String (date-time) | Date when the provider verified the second time that the leak event was repaired (follow-up verification). |
| FollowUpMethod | String | Method used to verify the second time that the leak was repaired (follow-up verification). |
| LeakAreaId | Integer | Unique numeric identifier of the leak area. A leak area is a specific area within the HVAC or refrigeration appliance, where the leak occurred, for example, a receiver, evaporator, suction line. There is a system-defined list of leak areas. |
| LeakLocationID | Integer | Unique numeric identifier of the location where the leak occured. A leak location is a specific place within the particular leak area where the leak occurred, for example, level indicator alarm, pressure relief valve, header piping. There is a system-defined list of leak locations. |
| FaultCodeId | Integer | Unique numeric identifier of the possible cause of the leak. Possible values: 1 - Accidental Damage; 2 - Braze of Joint Failure; 3 - Corrosion; 4 - Defrost Heater Failure; 5 - Faulty Part; 6 - Forklift Damage; 7 - Gasket Seal Failure; 8 - Ice Build Up; 9 - Line Break; 10 - Manufacture Defect; 11 - Missing Part; 12 - Natural Disaster; 13 - Normal Mechanical Wear; 14 - Other (Must explain in comments); 15 - Vandalism; 16 - Vibration Related; 17 - Project Related Loss. |
| ActionCodeId | Integer | Unique numeric identifier of the action that fixed the leak. Possible values: 1 - Isolated Leaking Part from System; 2 - Re-soldered; 3 - Replaced Gasket or Seal; 4 - Replaced Part; 5 - Replaced Unit; 6 - Retroifitted Refrigerant; 7 - Retired “Shutdown System” Removed Refrigerant; 8 - Tightened Connection; 9 - Top off from previous repair; 10 - Under repair; 11 - Welded line. |
| CurrentTrackingNumber | Integer | Tracking number of the work order currently associated with the leak event. |