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

AssetMaintenanceLog CustomerAsset CustomerAssetCategory CustomerAssetFile CustomerAssetTemplate CustomerAssetTemplateCategory UserAsset UserAssetCategory

Equipment

Equipment EquipmentCategory EquipmentFile EquipmentFormAlert EquipmentGeoData EquipmentMaintenanceEventReminder EquipmentMaintenanceEventType EquipmentMaintenanceLog EquipmentType TrackingDevice

Expenses

Expense ReceiptImage

Job Checklists

JobChecklist

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

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

JobBid Resource
In Jobs Module

Endpoints

Endpoints URI Access Control Description
find GET /api/JobBid/find Admin or Module READ
get GET /api/JobBid/get Admin or Module READ
save POST /api/JobBid/save Admin or Module WRITE
renderSingleMainBranch GET /api/JobBid/renderSingleMainBranch Endpoint level permissions
getParentComponent GET /api/JobBid/getParentComponent Endpoint level permissions
getTopLevelComponent GET /api/JobBid/getTopLevelComponent Endpoint level permissions
get-whole-bid GET /api/JobBid/get-whole-bid Endpoint level permissions
clone-bid POST /api/JobBid/clone-bid Endpoint level permissions
delete POST /api/JobBid/delete Admin or Module WRITE
send POST /api/JobBid/send Endpoint level permissions
pdf GET /api/JobBid/pdf Endpoint level permissions
save-batch POST /api/JobBid/save-batch Admin or Module WRITE
checkManualInvoiceNumberIsUnique GET /api/JobBid/checkManualInvoiceNumberIsUnique Endpoint level permissions
payment GET /api/JobBid/payment Endpoint level permissions
partial-payment GET /api/JobBid/partial-payment Endpoint level permissions
sendNotice GET /api/JobBid/sendNotice Endpoint level permissions
updateViewedLog GET /api/JobBid/updateViewedLog Endpoint level permissions
calcTotalTaxes GET /api/JobBid/calcTotalTaxes Endpoint level permissions
setDueDateFromTerms GET /api/JobBid/setDueDateFromTerms Endpoint level permissions

Properties

Property Type Description
id number
slug string
job_id number
is_template boolean
template_category_id number
template_is_structure_only boolean
is_active boolean
status string
name string
revision_num string
issue_date date
date_first_issued datetime
last_issued datetime
last_emailed datetime
grand_total number
internal_notes string
notes_top string
notes_bottom string
display_depth number
hide_prices boolean
is_finalized boolean
is_portal_document boolean
applied_sales_tax_json string
submitted_log_json string
seen_log_json string
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 JobBid Property
Job job_id Belongs To Job
JobBidComponent bid_id Owns Many JobBidComponent