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

OpenTimeLog PayPeriod PayPeriodUserReport PendingOvertimeTransfer TimeLog TimeLogDetailedClaim

Users

EmployeeSetting LibraryAcknowledgement User UserLocation WorkHistory

Other

Subscription Resource

Endpoints

Endpoints URI Access Control Description
plans GET /api/Subscription/plans Authentication only
getActiveSubscription GET /api/Subscription/getActiveSubscription Endpoint level permissions
payments GET /api/Subscription/payments Endpoint level permissions
setAsFreemiumTier GET /api/Subscription/setAsFreemiumTier Endpoint level permissions
cancel GET /api/Subscription/cancel Endpoint level permissions Cancels a company's subscription to tradetraks
stopPartnerPayments GET /api/Subscription/stopPartnerPayments Endpoint level permissions
create POST /api/Subscription/create Endpoint level permissions Creates a Stripe subscription to tradetraks
find GET /api/Subscription/find Admin or Module READ
get GET /api/Subscription/get Authentication only
compileCachedRelations GET /api/Subscription/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
type string
stripe_id string
stripe_sub_id string
is_active boolean
price_cad number
plan_level number
user_limit number
expiry date
last_payment_status string
last_payment_update date
card_last_4 string
card_brand string
card_expiry string
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order is_active DESC
expiry DESC

Relationships

Related Resource Key Relationship to Subscription Property
Company tenant_id Belongs To Company