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

ChangeWorksheet Job JobActualCostDatapoint JobBid JobBidComponent JobBidComponentObject JobChangeOrder JobChangeOrderObject 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

Projects

ChangeOrderSnapshot

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

Service ServiceContact ServiceFile ServiceSnapshot ServiceUser ServiceWorksheet ServiceWorksheetImage

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

JobPersonnelRole Resource

Endpoints

Endpoints URI Access Control Description
save POST /api/JobPersonnelRole/save Admin or Module WRITE
find GET /api/JobPersonnelRole/find Allowed with an active employment connection
get GET /api/JobPersonnelRole/get Allowed with an active employment connection
delete POST /api/JobPersonnelRole/delete Admin or Module WRITE

Properties

Property Type Description
id number
slug string
title string
abbreviation string
write_perms boolean
read_perms boolean
review_timelogs boolean
review_expenses boolean
read_financials boolean
write_invoices boolean
write_timelogs boolean
see_open_threads boolean
tailboard_notices boolean
company_form_notices boolean
display_on_listings boolean
created_at datetime
updated_at datetime
updated_by number
role_required boolean
role_required_service boolean
payboost_is_percent boolean
payboost_amount number
is_field_ops_lead boolean
is_management_lead boolean

Settings

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

Relationships

Related Resource Key Relationship to JobPersonnelRole Property
EmployeeClassification job_personnel_role_id Owns Many EmployeeClassification
User user_id Belongs To User