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

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

JobReport Resource
In Jobs Module

Endpoints

Endpoints URI Access Control Description
get-range GET /api/JobReport/get-range Endpoint level permissions

Returns job report data for a date range. The shape of the data depends on report_type.

Required parameters:

  • report_type: (string) One of: revenue-expenses-monthly, revenue-expenses-yearly, total-monthly-billing
  • from_year: (int)
  • to_year: (int)

If report_type is revenue-expenses-monthly, also required:

  • job_id: (int)
  • from_month: (int) 1–12
  • to_month: (int) 1–12

If report_type is revenue-expenses-yearly, also required:

  • job_id: (int)

If report_type is total-monthly-billing, also required:

  • from_month: (int) 1–12
  • to_month: (int) 1–12
save POST /api/JobReport/save Admin or Module WRITE

Creates or fetches a job report. If a report exists for the given report_type, year, job_id, and (when applicable) month, it is returned; otherwise a new report is created and returned.

Required parameters:

  • report_type: (string) One of: revenue-expenses-monthly, revenue-expenses-yearly
  • year: (int)
  • job_id: (int)

If report_type is revenue-expenses-monthly, also required:

  • month: (int) 1–12
delete POST /api/JobReport/delete Admin or Module WRITE
get GET /api/JobReport/get Admin or Module READ
find GET /api/JobReport/find Admin or Module READ
report GET /api/JobReport/report Endpoint level permissions

Properties

Property Type Description
id number
job_id number
service_id number
customer_id number
year number
month number
date date
report_type string
report_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 JobReport Property
Job job_id Belongs To Job
Service service_id Belongs To Service
Customer customer_id Belongs To Customer