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

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

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

OpenTimeLog Resource
In TimeLogs Module

Forced filter of open time logs only

Endpoints

Endpoints URI Access Control Description
get GET /api/OpenTimeLog/get Admin or Module READ
compileCachedRelations GET /api/OpenTimeLog/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
user_id number
job_id number
service_id number
job_bid_component number
no_location_clockin boolean
lat number
long number
position_accuracy number
time_in datetime
clocked_in_offsite boolean
clocked_out_offsite boolean
time_on_site datetime
time_out datetime
lat_clockout number
long_clockout number
position_accuracy_clockout number
no_location_clockout boolean
regular_hours number
overtime_hours_15x number
overtime_hours_2x number
overtime_hours_25x number
regular_hours_original number
overtime_hours_15x_original number
overtime_hours_2x_original number
overtime_hours_25x_original number
reason_not_on_site string
timeout_reason_not_on_site string
clockout_notice_sent boolean
time_in_notes string
time_out_notes string
reviewed_by number
review_notes string
internal_notes string
submitted_by number
processed_at datetime
created_at datetime
updated_at datetime
updated_by number
realtime_log boolean
collective_agreement_id number
classification_json string
skip_mileage boolean
skip_perdiem boolean
message_thread_id number
calculated_cost number
qbo_ids_json string

Settings

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

Relationships

Related Resource Key Relationship to OpenTimeLog Property
User user_id Belongs To User
Job job_id Belongs To Job
Service service_id Belongs To Service