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

Company Resource

Endpoints

Endpoints URI Access Control Description
mine GET /api/Company/mine Allowed with an active employment connection Returns the details of a user's active company
my-list GET /api/Company/my-list Allowed with an active employment connection Returns a list of all the companies a user ever worked for
get GET /api/Company/get Allowed with an active employment connection
find GET /api/Company/find Open
attachPartners GET /api/Company/attachPartners Endpoint level permissions
create POST /api/Company/create Authentication only

Used to create a new company.

Required fields:

  • company_name: string
save POST /api/Company/save Admin or Module WRITE
getTimezone GET /api/Company/getTimezone Endpoint level permissions
checkSetupProgress GET /api/Company/checkSetupProgress Endpoint level permissions
compileCachedRelations GET /api/Company/compileCachedRelations Endpoint level permissions
seedTimeLogSettings GET /api/Company/seedTimeLogSettings Endpoint level permissions
seedCompanySettings GET /api/Company/seedCompanySettings Endpoint level permissions
seedDefaultOfficeProject GET /api/Company/seedDefaultOfficeProject Endpoint level permissions
seedFileTags GET /api/Company/seedFileTags Endpoint level permissions
seedJobPersonnelRoles GET /api/Company/seedJobPersonnelRoles Endpoint level permissions
seedJobCategories GET /api/Company/seedJobCategories Endpoint level permissions
seedAssetCategories GET /api/Company/seedAssetCategories Endpoint level permissions
seedExampleChargeOutGroups GET /api/Company/seedExampleChargeOutGroups Endpoint level permissions
seedExampleEmployeeClassifications GET /api/Company/seedExampleEmployeeClassifications Endpoint level permissions
seedRevenueCodes GET /api/Company/seedRevenueCodes Endpoint level permissions
seedExpenseGroups GET /api/Company/seedExpenseGroups Endpoint level permissions
seedExpenseCodes GET /api/Company/seedExpenseCodes Endpoint level permissions
seedFormCategories GET /api/Company/seedFormCategories Endpoint level permissions
seedSafetyFormsAndHazards GET /api/Company/seedSafetyFormsAndHazards Endpoint level permissions

Properties

Property Type Description
id number
slug string
company_name string
managing_user_id number
secondary_contact_id number
safety_officer_id number
equipment_manager_id number
accounting_manager_id number
marketing_manager_id number
business_type string
phone string
email string
address string
city string
province string
country string
postal_code string
address_hash string
has_billing_address boolean
billing_address string
billing_city string
billing_postal_code string
billing_province string
billing_country string
description string
website string
linked_in string
instagram string
facebook string
twitter string
lat number
long number
timezone string
image_id number
is_suspended boolean
suspended_reason string
is_free_user boolean If true (1), company won't be subject to subscription plan limits.
created_at datetime
emails_sent_json string
settings_id number
setup_finished boolean
onboarding_finished boolean
last_setup_step number
total_paypal_payments number
total_stripe_payments number
total_square_payments number
onboarding_package_purchased_id number

Settings

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

Relationships

Related Resource Key Relationship to Company Property
User managing_user_id Belongs To ManagingUser
User secondary_contact_id Belongs To SecondaryContactUser
User user_id Owns Many Users
User safety_officer_id Belongs To SafetyOfficerUser
User accounting_manager_id Belongs To AccountingManagerUser
User equipment_manager_id Belongs To EquipmentManagerUser
User marketing_manager_id Belongs To MarketingManagerUser
ProfileImage image_id Belongs To ProfileImage
UserPermission tenant_id Owns Many UserPermission
CompanyUser tenant_id Owns Many CompanyUser
Subscription tenant_id Owns Many Subscription
CompanySetting settings_id Belongs To CompanySetting
BusinessType type_id Owns Many BusinessType
AddonApp app_id Owns Many AddonApp
Contact company_name Belongs To ContactLink