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 FeedPost FeedPostComment FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

Service Resource
In Services Module

Endpoints

Endpoints URI Access Control Description
statuses GET /api/Service/statuses Endpoint level permissions Returns a list of status objects: { label: (status text), type: 'field' or 'office' }
find GET /api/Service/find Admin or Module READ
delete POST /api/Service/delete Admin or Module WRITE
my-list GET /api/Service/my-list Endpoint level permissions
get GET /api/Service/get Authentication only Strip all input fields, add customer_id filter, also return the company name as a field
archivable-services GET /api/Service/archivable-services Endpoint level permissions
archive-batch GET /api/Service/archive-batch Endpoint level permissions
save-batch POST /api/Service/save-batch Admin or Module WRITE Clean the input data and remove any banned fields Returns either the cleaned data array, OR a string representing an error that needs to be returned
save POST /api/Service/save Admin or Module WRITE
compileCachedRelations GET /api/Service/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
contract_id number
job_id number
customer_id number
assigned_to number
helper_techs_json string
is_emergency boolean
job_num string This will be auto-generated on new jobs if left blank
job_name string
date_landed date
due_date date
end_date date
description string
internal_notes string
pays_mileage boolean
pays_perdiem boolean
work_to_do_disabled boolean
work_orders_disabled boolean
archived boolean
category_id number
revenue_code_id number
customer_po string
permit_needed boolean
inspector_num string
inspector_name string
inspector_email string
permit_notification_number string
permit_cost number
has_locates boolean
location_type string
contact_location_id number
address string
suite string
city string
province string
country string
postal_code string
lat number
long number
address_hash string
distance_from_office number
check_in_tolerance number
estimated_time number
appointment_time number
status string
canceled_reason string
completed datetime
work_completed_description string
work_completed_by number
work_completed_at datetime
parts_used_json string
collective_agreements_json string
tasks_completed_json string
equipment_used_json string
total_material_costs number
total_equipment_costs number
total_labour_costs number
last_signed datetime
summary_total_hours number
summary_total_hours_ot number
customer_name_cache string
is_warranty_work boolean
invoice_id number
is_canceled boolean
is_draft boolean
qbo_id number
created_by number
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) 50 per page
Default Sort Order is_emergency DESC
due_date DESC
appointment_time DESC
job_num DESC

Relationships

Related Resource Key Relationship to Service Property
Contact customer_id Belongs To Customer
Category category_id Belongs To Category
RevenueCode revenue_code_id Belongs To RevenueCode
User user_id Owns Many User
CollectiveAgreement collective_agreement_id Belongs To CollectiveAgreement
MessageThread service_id Owns Many MessageThread
ServiceContact service_id Owns Many ServiceContact
Contact contact_id Owns Many Contact
ContactLocation contact_location_id Belongs To ContactLocation
User updated_by Belongs To UpdatedBy
User work_completed_by Belongs To WorkCompletedBy
ServiceFile service_id Owns Many ServiceFile
JobPersonnelRole personnel_role_id Owns Many JobPersonnelRole
ServiceContract contract_id Belongs To ServiceContract
ServiceInvoice service_id Owns Many ServiceInvoice
ServiceInvoice invoice_id Belongs To BatchInvoice
TimeLog service_id Owns Many TimeLog
User assigned_to Belongs To AssignedTo
Job job_id Belongs To Job
Expense service_id Owns Many Expense
ServiceWorksheet service_id Owns Many ServiceWorksheet
Locate service_id Owns Many Locate
CompanyForm service_id Owns Many CompanyForm
SafetyForm tailboard_id Owns Many SafetyForm
PayBoost payboost_id Owns Many PayBoost
ServiceSnapshot service_id Owns Many ServiceSnapshot
ScheduleEvent service_id Owns Many ScheduleEvent
ServiceChecklist service_id Owns Many ServiceChecklist
FormChildTemplate child_template_id Owns Many FormChildTemplate
Checklist checklist_id Owns Many Checklist
CustomerAsset customer_asset_id Owns Many CustomerAsset