API Documentation

Modules

Calendar

Event

Certificates

CompanyCertificate UserCertificate UserCompanyCertificate

CollectiveAgreements

CollectiveAgreement

Company Forms

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

Service ServiceChecklist 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

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

CompanyForm Resource
In Company Forms Module

Endpoints

Endpoints URI Access Control Description
start-log POST /api/CompanyForm/start-log Endpoint level permissions
send POST /api/CompanyForm/send Endpoint level permissions
save POST /api/CompanyForm/save Allowed with an active employment connection
find GET /api/CompanyForm/find Open
get GET /api/CompanyForm/get Allowed with an active employment connection
delete POST /api/CompanyForm/delete Admin or Module WRITE
compileCachedRelations GET /api/CompanyForm/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
child_template_id number
form_template_id number
form_template_category_id number
job_id number
service_id number
equipment_id number
customer_asset_id number
worksheet_id number
expiry datetime
is_deactivated boolean
form_json string
form_num number
is_visible_externally boolean
created_by number
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) 25 per page
Default Sort Order created_at DESC

Relationships

Related Resource Key Relationship to CompanyForm Property
Company tenant_id Belongs To Company
Job job_id Belongs To Job
Service service_id Belongs To Service
User updated_by Belongs To UpdatedBy
FormTemplate form_template_id Belongs To FormTemplate
FormChildTemplate child_template_id Belongs To FormChildTemplate
CompanyFormAcknowledgement form_id Owns Many CompanyFormAcknowledgement
Equipment equipment_id Belongs To Equipment
EquipmentFormAlert company_form_id Owns Many EquipmentFormAlert
CustomerAsset customer_asset_id Belongs To CustomerAsset
ServiceWorksheet worksheet_id Belongs To ServiceWorksheet