Jobs
Overview
A unit of work undertaken by one or more Resources for a customer.
System fields
System fields are read-only fields found on most objects. These fields are automatically updated during API operations. To learn more see System Fields.
Standard fields
| Field Name | Details | Required |
|---|---|---|
| AbortReason | Type Picklist Description The reason why the Job was cancelled. Valid values are: - Customer no show - Cancelled by customer - Appointment missed ImportantThis field and associated functionality is referred to in our products and documentation as Job Cancellation Reasons.Where possible, we’ve changed non-inclusive and offensive terms to align with our company value of Equality. We’ve maintained certain terms in a limited amount places to avoid any effect on customer implementations. |
No |
| Account | Type Lookup (Accounts) Description The Account associated with the Job. |
No |
| AccountId | Type ID Description The Account associated with the Job. |
No |
| ActualEnd | Type DateTime Description The timestamp of when all related Job Allocations have a status of ‘Complete’. |
No |
| ActualStart | Type DateTime Description The timestamp of when all related Job Allocations have a status of ‘In Progress’. |
No |
| Address | Type Text Description The physical location where the work will be undertaken. Must be between 0 and 255 characters |
No |
| CanBeDeclined | Type Checkbox Description Indicates whether or not the allocated are able to decline the work. |
Yes |
| CompletionNotes | Type Text Description Additional information related to the completion of the work. Must be between 0 and 32768 characters |
No |
| Contact | Type Lookup (Contacts) Description The Contact associated with the Job. |
No |
| ContactId | Type ID Description The Contact associated with the Job. |
No |
| CopiedFrom | Type Lookup (Jobs) Description The original Job that was the source of this Job (if any). |
No |
| CopiedFromId | Type ID Description The original Job that was the source of this Job (if any). |
No |
| CustomerConfirmationStatus | Type Picklist Description Indicates if the customer has confirmed that the scheduled work can take place or not. This field is automatically populated as a result of requesting confirmation via the /sms/confirmation_request api endpoint. Valid values are: - Pending - Confirmed - Declined - Error WarningThe values for this field are not able to be modified. |
No |
| Description | Type Text Description A brief summary of the work. Must be between 0 and 255 characters |
No |
| Duration | Type Duration Description The length of time scheduled (in minutes) to complete the work. |
Yes |
| End | Type DateTime Description The timestamp of when the work is scheduled to end. |
No |
| EstimatedEnd | Type DateTime Description The timestamp of when the work is estimated to end. |
No |
| EstimatedStart | Type DateTime Description The timestamp of when the work is estimated to start. |
No |
| FollowupReason | Type Picklist Description The reason why additional work is required to be scheduled. Valid values are: - Not Ready - Needs more time Custom valuesThe values for this field may be modified via the Skedulo web app or via the Skedulo REST API. |
No |
| GeoLatitude | Type Decimal Description The latitude of the physical location where the work will be undertaken. Must be a decimal with precision 9 and scale 6 |
No |
| GeoLongitude | Type Decimal Description The longitude of the physical location where the work will be undertaken. Must be a decimal with precision 9 and scale 6 |
No |
| IsGroupEvent | Type Checkbox Description Indicates whether or not the Job has related Attendees. |
Yes |
| JobAllocationCount | Type Integer Description The count of related Job Allocations without the status of ‘Deleted’. |
Yes |
| JobAllocationTimeSource | Type Checkbox Description Indicates whether or not the ‘start’ and ’end’ times on the Job Allocation take precedence over the Job’s ‘start’ and ’end’ times. |
Yes |
| JobStatus | Type Picklist Description The status of the Job. Valid values are: - Queued - Pending Allocation - Pending Dispatch - Dispatched - Ready - En Route - On Site - In Progress - Complete - Cancelled WarningThe values for this field are not able to be modified. |
Yes |
| Location | Type Lookup (Locations) Description The Location associated with the Job. |
No |
| LocationId | Type ID Description The Location associated with the Job. |
No |
| Locked | Type Checkbox Description Indicates whether or not it is possible to update the record. |
Yes |
| MaxAttendees | Type Integer Description The maximum number of attendees the job can accommodate. |
No |
| MinAttendees | Type Integer Description The minimum number of attendees, excluding resources, that are required. |
No |
| Name | Type Text Description The generated name of the Job. For example, JOB-1234. Must be between 0 and 80 characters |
Yes |
| NotesComments | Type Text Description Additional information regarding the Job. Must be between 0 and 32768 characters |
No |
| Parent | Type Lookup (Jobs) Description The preceding Job when created as a follow-up Job. |
No |
| ParentId | Type ID Description The preceding Job when created as a follow-up Job. |
No |
| Quantity | Type Integer Description The number of resources required to be allocated. |
No |
| RecurringSchedule | Type Lookup (RecurringSchedules) Description The Recurring Schedule associated with the Job. |
No |
| RecurringScheduleId | Type ID Description The Recurring Schedule associated with the Job. |
No |
| Region | Type Lookup (Regions) Description The Region associated with the Job. |
Yes |
| RegionId | Type ID Description The Region associated with the Job. |
Yes |
| Start | Type DateTime Description The timestamp of when the work is scheduled to begin. |
No |
| Timezone | Type Text Description The timezone of the associated Region. Must be between 0 and null characters |
Yes |
| Type | Type Picklist Description The type of Job. Valid values are: - Installation ( Installation Job Type ) - Upgrade - Break Fix - Maintenance Custom valuesThe values for this field may be modified via the Skedulo web app or via the Skedulo REST API. |
No |
| Urgency | Type Picklist Description An indication of the time sensitivity associated with the Job. Valid values are: - Normal - Urgent - Critical Custom valuesThe values for this field may be modified via the Skedulo web app or via the Skedulo REST API. |
No |
| VirtualMeetingId | Type Text Description The unique identifier of the associated virtual meeting. Must be between 0 and 255 characters |
No |
| VirtualMeetingInfo | Type Text Description Additional information regarding the associated virtual meeting. Must be between 0 and 10000 characters |
No |
| VirtualMeetingURL | Type Text Description The URL of the associated virtual meeting. Must be between 0 and 255 characters |
No |
Related objects
This object has the following related objects.
| Name | Details |
|---|---|
| Attendees | Object Has many (Attendees) Description Attendees associated with the Job. |
| Followups | Object Has many (Jobs) Description Preceding Jobs associated with the Job. |
| JobAllocations | Object Has many (JobAllocations) Description Resources allocated to the Job. |
| JobDependenciesFrom | Object Has many (JobDependencies) Description The Job Dependencies where the Job serves as the starting point for the dependency. |
| JobDependenciesTo | Object Has many (JobDependencies) Description The Job Dependencies where the Job is the destination point for the dependency. |
| JobOffers | Object Has many (JobOffers) Description Job Offers associated with the Job. |
| JobProducts | Object Has many (JobProducts) Description Job Products associated with the Job. |
| JobTags | Object Has many (JobTags) Description Job Tags associated with the Job. |
| JobTasks | Object Has many (JobTasks) Description Job Tasks associated with the Job. |
| JobTimeConstraints | Object Has many (JobTimeConstraints) Description Job Time Constraints associated with the Job. |
| ResourceRequirements | Object Has many (ResourceRequirements) Description Resource Requirements associated with the Job. |
Deprecated fields
This section lists fields that are marked as deprecated and are maintained for backwards compatibility purposes only. It’s recommended not to use them in new implementations, as they may be removed in future releases.
- AutoSchedule
- NotifyBy
- NotifyPeriod
Feedback
Was this page helpful?