API Documentation

Modules

Calendar

Event

Certificates

CompanyCertificate UserCertificate UserCompanyCertificate

CollectiveAgreements

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

ChangeOrderSnapshot 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

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

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

CollectiveAgreement Resource
In CollectiveAgreements Module

Endpoints

Endpoints URI Access Control Description
save POST /api/CollectiveAgreement/save Admin or Module WRITE
migrate POST /api/CollectiveAgreement/migrate Endpoint level permissions

Migrates references from one collective agreement to another. Use this when a union adopts a new agreement (e.g. after contract renewal) and you need to switch jobs, services, contracts, and optionally time logs from the old agreement to the new one.

Required parameters:

  • old_ca_id: (int) ID of the collective agreement to migrate from
  • new_ca_id: (int) ID of the collective agreement to migrate to

Optional parameters:

  • effective_date: (date) If provided, time logs on or after this date that reference the old agreement are updated to the new one. Must be a valid past date.

What it does: Jobs, services, and service contracts that reference the old agreement (or the union default) are updated to the new agreement. If the old agreement was the default for its union, the new one becomes the default. When effective_date is sent, qualifying time logs are also updated.
find GET /api/CollectiveAgreement/find Admin or Module READ
get GET /api/CollectiveAgreement/get Admin or Module READ
report GET /api/CollectiveAgreement/report Endpoint level permissions
save-batch POST /api/CollectiveAgreement/save-batch Admin or Module WRITE
delete POST /api/CollectiveAgreement/delete Admin or Module WRITE

Properties

Property Type Description
id number
title string
per_diem number
per_diem_range number
mileage_settings string
use_zone_mileage boolean
distance_calculation_method string
distance_is_one_way boolean
mileage_trigger_address string
mileage_trigger_distance number
mileage_zones_json string
mileage_deductable number
pay_scales string
start_address_id number
expiry_date date
archived boolean
created_at datetime
updated_at datetime
updated_by number
union_id number
is_default boolean

Settings

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

Relationships

Related Resource Key Relationship to CollectiveAgreement Property
Job collective_agreement_id Owns Many Job
Union union_id Belongs To Union
User updated_by Belongs To UpdatedBy