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

AssetMaintenanceLog CustomerAsset CustomerAssetCategory CustomerAssetFile CustomerAssetTemplate CustomerAssetTemplateCategory UserAsset UserAssetCategory

Equipment

Equipment EquipmentCategory EquipmentFile EquipmentFormAlert EquipmentGeoData EquipmentMaintenanceEventReminder EquipmentMaintenanceEventType EquipmentMaintenanceLog EquipmentType TrackingDevice

Expenses

Expense ReceiptImage

Job Checklists

JobChecklist

Job Invoices

JobInvoice JobInvoiceTask

Jobs

ChangeOrderSnapshot ChangeWorksheet Job JobActualCostDatapoint JobBid JobBidComponent JobBidComponentObject JobChangeOrder JobChangeOrderObject JobContact JobEstimate JobFile JobNote JobNoteFile JobReport JobTask JobUser Rfi RfiFile RfiResponse

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

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

ServiceUser Resource
In Services Module

Assignment of a user (employee) to a service with a role. Product language: who is on a service. Same idea as JobUser but for Service records.

Endpoints

Endpoints URI Access Control Description
get GET /api/ServiceUser/get Admin or Module READ
find GET /api/ServiceUser/find Admin or Module READ
report GET /api/ServiceUser/report Endpoint level permissions

Server-side aggregates over filtered rows (same-table filters only). Response data keys:

  • record_count: count of id
  • distinct_service_count: count_distinct of service_id
save POST /api/ServiceUser/save Admin or Module WRITE
save-batch POST /api/ServiceUser/save-batch Admin or Module WRITE
delete POST /api/ServiceUser/delete Admin or Module WRITE

Properties

Property Type Description
id number
service_id number
service_contract_id number
user_id number
personnel_role_id number
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order By insertion order

Relationships

Related Resource Key Relationship to ServiceUser Property
Service service_id Belongs To Service
User user_id Belongs To User
JobPersonnelRole personnel_role_id Belongs To JobPersonnelRole