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 FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

PayPeriod Resource
In TimeLogs Module

Endpoints

Endpoints URI Access Control Description
trimLogs GET /api/PayPeriod/trimLogs Endpoint level permissions
save POST /api/PayPeriod/save Admin or Module WRITE Checks that all pay period logs are submitted, then compiles all into a JSON PayPeriod object and saves it as a record @param $data = [ 'period_start' => 'YYYY-MM-DD' (string) ]
csv GET /api/PayPeriod/csv Endpoint level permissions
pdf GET /api/PayPeriod/pdf Endpoint level permissions
delete POST /api/PayPeriod/delete Admin or Module WRITE
summary GET /api/PayPeriod/summary Endpoint level permissions
find GET /api/PayPeriod/find Admin or Module READ
get GET /api/PayPeriod/get Admin or Module READ
compileCachedRelations GET /api/PayPeriod/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
start date
end date
total_reg_hrs number
total_ot_hrs number
total_labour_paid number
total_per_diem_paid number
total_mileage_paid number
period_json string
user_list_json string
created_by number
system_generated boolean
generation_completed_at datetime
processed boolean
created_at datetime
updated_at datetime
updated_by number
slug string

Settings

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

Relationships

Related Resource Key Relationship to PayPeriod Property
User created_by Belongs To User
PayPeriodUserReport period_id Owns Many PayPeriodUserReport