API Documentation

Modules

Calendar

Event

Certificates

CompanyCertificate UserCertificate UserCompanyCertificate

CollectiveAgreements

CollectiveAgreement

Company Forms

CompanyForm CompanyFormAcknowledgement CompanyFormRecurring FormMarketplaceCategory FormMarketplaceTemplate FormShareGroup

Company Forms Management

FormChildTemplate FormTemplate FormTemplateCategory

Contacts

Contact ContactFile ContactLocation

Contracts

ServiceContract ServiceContractFile ServiceContractProduct ServiceContractTask ServiceProduct

Customer Assets

CustomerAsset CustomerAssetCategory CustomerAssetFile CustomerAssetTemplate CustomerAssetTemplateCategory UserAsset UserAssetCategory

Equipment

Equipment EquipmentCategory EquipmentFile EquipmentFormAlert EquipmentMaintenanceEventReminder EquipmentMaintenanceEventType EquipmentMaintenanceLog EquipmentType

Expenses

Expense ReceiptImage

Job Invoices

JobInvoice JobInvoiceTask

Jobs

Job JobActualCostDatapoint JobBid JobBidComponent JobBidComponentObject JobChangeQuote JobChangeQuoteObject JobContact JobEstimate JobFile JobNote JobReport JobTask JobUser

Labour Actions

LabourAction LabourActionCategory

Library

LibraryFile

Locates

Locate LocateTicket

Materials

AssemblyTag Material MaterialAssembly MaterialAssemblyItem MaterialCategory

Messages

Message MessageThread MessageThreadUser

Purchase Orders

PurchaseOrder PurchaseOrderFile

Safety

SafetyControl SafetyForm SafetyFormTemplate SafetyHazard SafetyHazardCategory SafetyJobTask

Schedule

ScheduleEvent ScheduleLog

Service Quotes/Invoices

ServiceInvoice ServiceInvoiceObject ServiceQuoteTemplate ServiceQuoteTemplateObject

Service Requests

ServiceRequest

Services

Settings

AddonApp AddonAppInstalled Category ClassificationGroup CompanyAddress CompanySetting EmployeeClassification ExpenseCode ExpenseGroup FileTag JobFileTag PayBoost PermissionTemplate RevenueCode TimeLogSetting Union

TimeLogs

OpenTimeLog PayPeriod PayPeriodUserReport PendingOvertimeTransfer TimeLog TimeLogDetailedClaim

Users

EmployeeSetting LibraryAcknowledgement User UserLocation WorkHistory

Other

Activity BusinessType CertificateUpload Checklist Company CompanyCustomer CompanyLink CompanyUser DrawCanvas EmailList Engagement ErrorLog FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

ServiceWorksheet Resource
In Services Module

Endpoints

Endpoints URI Access Control Description
save POST /api/ServiceWorksheet/save Admin or Module WRITE
delete POST /api/ServiceWorksheet/delete Admin or Module WRITE
userIsServiceTechOrAssigned GET /api/ServiceWorksheet/userIsServiceTechOrAssigned Endpoint level permissions
checkJobPerm GET /api/ServiceWorksheet/checkJobPerm Endpoint level permissions
checkJobIsArchivable GET /api/ServiceWorksheet/checkJobIsArchivable Endpoint level permissions
save-batch POST /api/ServiceWorksheet/save-batch Admin or Module WRITE
get GET /api/ServiceWorksheet/get Admin or Module READ
find GET /api/ServiceWorksheet/find Admin or Module READ
get-estimated-drive-time GET /api/ServiceWorksheet/get-estimated-drive-time Endpoint level permissions
notify-customer-eta GET /api/ServiceWorksheet/notify-customer-eta Endpoint level permissions
compileCachedRelations GET /api/ServiceWorksheet/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
service_id number
customer_asset_id number
work_type string
work_completed_by number
work_completed_description string
parts_used_json string
tasks_completed_json string
equipment_used_json string
service_tasks_completed_json string
is_change_quote_work boolean
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) 50 per page
Default Sort Order created_at ASC

Relationships

Related Resource Key Relationship to ServiceWorksheet Property
Service service_id Belongs To Service
User work_completed_by Belongs To WorkCompletedBy
ServiceWorksheetImage worksheet_id Owns Many ServiceWorksheetImage
CustomerAsset customer_asset_id Belongs To CustomerAsset
CompanyForm worksheet_id Owns Many CompanyForm