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

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

JobChecklist Service ServiceContact ServiceFile ServiceSnapshot ServiceUser ServiceWorksheet ServiceWorksheetImage

Settings

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

CompanySetting Resource
In Settings Module

Endpoints

Endpoints URI Access Control Description
mine GET /api/CompanySetting/mine Endpoint level permissions
send-test-email POST /api/CompanySetting/send-test-email Endpoint level permissions
save POST /api/CompanySetting/save Admin or Module WRITE
delete POST /api/CompanySetting/delete Admin or Module WRITE

Properties

Property Type Description
id number
slug string
taxes_json string
default_price_adjustment number
default_markup number
default_pricing_json string
accept_stripe boolean
accept_paypal boolean
accept_square boolean
accept_custom_gateway boolean
stripe_public_key string
stripe_secret_key string
stripe_send_receipts boolean
paypal_email string
square_access_token string
square_location_id string
custom_payment_gateway_link string
max_credit_value number
auto_mark_paid boolean
paid_email_notices_json string
email_footer string
invoice_notes string
invoice_footer_image_id number
invoice_footer_image_scale number
quote_notes string
quote_expiry_days number
invoice_accent_color string
po_instructions string
wo_summary_terms string
po_terms string
setup_progress_json string
show_revenue_code_on_invoice boolean
job_defaults_json string
qbo_active boolean
mail_client_active boolean
mail_client_json string
vacation_reset_day number
vacation_reset_month number
editable_service_nums boolean
editable_job_nums boolean
schedule_defaults_json string
custom_service_list_fields_json string
service_list_role_column number
created_at datetime
updated_at datetime
updated_by number

Settings

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

Relationships

Related Resource Key Relationship to CompanySetting Property
Company tenant_id Belongs To Company
UploadImage invoice_footer_image_id Belongs To BillingDocumentFooterImage