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

Users

EmployeeSetting LibraryAcknowledgement User UserLocation WorkHistory

Other

Activity BusinessType CertificateUpload Checklist Company CompanyCustomer CompanyLink CompanyUser DrawCanvas EmailList Engagement ErrorLog FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

TimeLog Resource
In TimeLogs Module

Endpoints

Endpoints URI Access Control Description
transfer-hours GET /api/TimeLog/transfer-hours Endpoint level permissions Transfers overtime hours for an employee to be transfered from one project to another @param test @param bums
transfer-request GET /api/TimeLog/transfer-request Open Handles response from email button links to approve or deny the overtime transfer requests
punch-clock POST /api/TimeLog/punch-clock Endpoint level permissions

Either clocks the user IN or OUT, depending on his current state.

Clock IN Params:
  • job_id (int)
  • service_id (int)
  • user_id (int) optional, if blank, requesting user himself is clocked in
  • reason_not_on_site (string)
  • time_in_notes (string)
  • onSiteEstimateMin (int) minutes
  • currentLat
  • currentLong
  • position_accuracy
Clock IN On-site Params:
  • id (int): time log id
  • currentLat
  • currentLong
  • position_accuracy
Clock OUT Params:
  • id (int): time log id
  • request (string): should be "clockOut". This is what triggers the clock OUT request state, instead of a clock in on site
  • payBoosts: (obj) {payBoostId : 1 or 2, otherpayboostId : 1 or 2}
  • regular_hours
  • overtime_hours_15x
  • overtime_hours_2x
  • overtime_hours_2.5x
  • time_out_notes
  • currentLat
  • currentLong
  • position_accuracy
save POST /api/TimeLog/save Admin or Module WRITE Save time log. This should not be used for clock INs or OUTs. Only for modifying timelogs
delete POST /api/TimeLog/delete Admin or Module WRITE
save-batch POST /api/TimeLog/save-batch Admin or Module WRITE
get GET /api/TimeLog/get Admin or Module READ
count-reviewable-logs GET /api/TimeLog/count-reviewable-logs Endpoint level permissions Accepts a user_id, and determines if they need to review any time logs or expenses
get-reviewable-logs GET /api/TimeLog/get-reviewable-logs Endpoint level permissions
find GET /api/TimeLog/find Admin or Module READ

Properties

Property Type Description
id number
slug string
user_id number
job_id number
service_id number
equipment_id number
job_bid_component_id 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
submitted_at datetime
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) 50 per page
Default Sort Order time_in DESC

Relationships

Related Resource Key Relationship to TimeLog Property
User user_id Belongs To User
Job job_id Belongs To Job
Service service_id Belongs To Service
Equipment equipment_id Belongs To Equipment
TimeLogDetailedClaim timelog_id Owns Many TimeLogDetailedClaim
User updated_by Belongs To UpdatedBy
User reviewed_by Belongs To ReviewedBy
User submitted_by Belongs To SubmittedBy
PayBoost payboost_id Owns Many PayBoost
PendingOvertimeTransfer to_log_id Owns Many PendingOvertimeTransfer
CollectiveAgreement collective_agreement_id Belongs To CollectiveAgreement
MessageThread message_thread_id Belongs To MessageThread