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

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

Equipment Resource
In Equipment Module

Endpoints

Endpoints URI Access Control Description
get GET /api/Equipment/get Admin or Module READ
delete POST /api/Equipment/delete Admin or Module WRITE
find GET /api/Equipment/find Admin or Module READ
save POST /api/Equipment/save Admin or Module WRITE
save-batch POST /api/Equipment/save-batch Admin or Module WRITE
compileCachedRelations GET /api/Equipment/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
type_id number
description string
serial_num string
date_acquired date
charge_out_rate number
next_service_date date
next_service_description string
next_service_mileage_or_time number
last_service_date date
last_service_mileage_or_time number
last_service_description string
parts_json string
custom_fields_json string
location_type string
address string
suite string
city string
province string
country string
postal_code string
lat number
long number
message_thread_id number
color_hex string
archived boolean
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order description ASC

Relationships

Related Resource Key Relationship to Equipment Property
EquipmentType type_id Belongs To EquipmentType
EquipmentMaintenanceLog equipment_slug Owns Many EquipmentMaintenanceLog
MessageThread message_thread_id Belongs To MessageThread
EquipmentFile equipment_id Owns Many EquipmentFile