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

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

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

JobBidComponent Resource
In Jobs Module

Endpoints

Endpoints URI Access Control Description
find GET /api/JobBidComponent/find Admin or Module READ
delete POST /api/JobBidComponent/delete Admin or Module WRITE
save POST /api/JobBidComponent/save Admin or Module WRITE
save-batch POST /api/JobBidComponent/save-batch Admin or Module WRITE
get-component-list GET /api/JobBidComponent/get-component-list Endpoint level permissions
clone-component POST /api/JobBidComponent/clone-component Endpoint level permissions Clones a component including its descendants @param parentComponentId (int): id of the parent the new component will belong to @param componentId (int): The id of the component to clone
get GET /api/JobBidComponent/get Admin or Module READ

Properties

Property Type Description
id number
slug string
bid_id number
bid_component_id number
copied_from_bid_component_id number
name string
description string
item_number string
spec_number string
order_index number
can_have_time_log boolean
hours_cap number
qty number
qty_unit string
direct_labour_hrs number
direct_value number
is_reverse_calculated boolean
created_at datetime
updated_at datetime
updated_by number

Settings

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

Relationships

Related Resource Key Relationship to JobBidComponent Property
JobBid bid_id Belongs To JobBid
JobBidComponent copied_from_bid_component_id Belongs To JobBidComponentCopiedFrom
JobBidComponent bid_component_id Owns Many JobBidComponent
JobBidComponent bid_component_id Belongs To ParentJobBidComponent
JobBidComponentObject bid_component_id Owns Many JobBidComponentObject
TimeLogDetailedClaim job_bid_component_id Owns Many TimeLogDetailedClaim