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

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

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

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

EquipmentType Resource
In Equipment Module

Equipment types (make/model style classifications) used when creating equipment records. Charge-out rates: use charge_out_rates_json (current). Shape example: {"hour":{"enabled":true,"rate":200},"day":{"enabled":false,"rate":112}}. Prefer enabled unit rates from that JSON when comparing cost/price. Legacy fields charge_out_rate and charge_out_rate_unit are fallbacks only when the JSON has no enabled rate for the unit.

Endpoints

Endpoints URI Access Control Description
delete POST /api/EquipmentType/delete Admin or Module WRITE
get GET /api/EquipmentType/get Admin or Module READ
find GET /api/EquipmentType/find Admin or Module READ
save POST /api/EquipmentType/save Admin or Module WRITE
save-batch POST /api/EquipmentType/save-batch Admin or Module WRITE

Properties

Property Type Description
id number
slug string
category_id number
name string
charge_out_rate number
charge_out_rate_unit string
charge_out_rates_json string

Current multi-unit charge-out rates for this equipment type. JSON object keyed by unit, for example:

{
  "hour": {"enabled": true, "rate": "185.00"},
  "day": {"enabled": false, "rate": 0},
  "week": {"enabled": false, "rate": 0},
  "month": {"enabled": false, "rate": 0}
}

Prefer an enabled unit rate when comparing price or billing. Legacy fields charge_out_rate and charge_out_rate_unit are fallbacks when this JSON has no enabled rate for the unit.
default_cost_hr number
odo_unit string
custom_fields_json string

Definitions of custom fields for this equipment type (schema). Typically a JSON array of objects such as [{key, type, ...}]. Values for those keys on individual equipment live on Equipment.custom_fields_json.
color_hex string
icon string
created_at datetime
updated_at datetime
updated_by number

Settings

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

Relationships

Related Resource Key Relationship to EquipmentType Property
Equipment type_id Owns Many Equipment
EquipmentCategory category_id Belongs To EquipmentCategory
EquipmentMaintenanceEventType maintenance_event_id Owns Many EquipmentMaintenanceEventType