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

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

Activity BusinessType CertificateUpload Checklist Company CompanyCustomer CompanyLink CompanyUser DrawCanvas EmailList Engagement ErrorLog FeedPost FeedPostComment FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

ServiceContract Resource
In Contracts Module

Endpoints

Endpoints URI Access Control Description
save POST /api/ServiceContract/save Admin or Module WRITE
delete POST /api/ServiceContract/delete Admin or Module WRITE
find GET /api/ServiceContract/find Admin or Module READ
get GET /api/ServiceContract/get Admin or Module READ
save-batch POST /api/ServiceContract/save-batch Admin or Module WRITE
compileCachedRelations GET /api/ServiceContract/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
contract_num string
customer_reference_num string
customer_reference_label string
contract_description string
start_date date
end_date date
customer_id number
contract_type string
pays_mileage boolean
pays_perdiem boolean
category_id number
revenue_code_id number
detailed_description string
price number
has_automatic_invoicing boolean
billing_interval_months number
initial_billing_date date
invoice_recipients_json string
collective_agreements_json string
message_thread_id number
created_at datetime
updated_at datetime
updated_by number

Settings

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

Relationships

Related Resource Key Relationship to ServiceContract Property
Service contract_id Owns Many Service
ServiceContractTask contract_id Owns Many ServiceContractTask
Material material_id Owns Many Material
Category category_id Belongs To Category
RevenueCode revenue_code_id Belongs To RevenueCode
Contact customer_id Belongs To Customer
ServiceProduct product_id Owns Many ServiceProduct
User user_id Owns Many User
MessageThread message_thread_id Belongs To MessageThread
ServiceContractFile service_service_contract_id Owns Many ServiceContractFile