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

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

`Expense` Resource
In `Expenses` Module

Endpoints

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

Properties

Property	Type	Description
`id`	number
`slug`	string
`user_id`	number
`job_id`	number
`service_id`	number
`group_id`	number
`code_id`	number
`invoice_num`	string
`cost`	number
`tax`	number
`tip`	number
`description`	string
`vendor`	string
`payment_method`	string
`purchase_date`	date
`image_id`	number
`message_thread_id`	number
`created_at`	datetime
`reviewed_by`	number
`reviewed_at`	datetime
`approved`	boolean
`denied`	boolean
`processed`	boolean
`denied_reason`	string
`qbo_tax_id`	number
`qbo_account_id`	string
`qbo_id`	string
`attachment_pushed_to_qbo`	boolean
`updated_at`	datetime
`updated_by`	number
`last_4`	number
`purchase_order_id`	number
`supplier_id`	number

Settings

Setting
Pagination Limit (when `page` parameter is set)	50 per page
Default Sort Order	`purchase_date` DESC

Relationships

Related Resource	Key	Relationship to Expense	Property
User	`user_id`	Belongs To	User
Job	`job_id`	Belongs To	Job
Service	`service_id`	Belongs To	Service
User	`reviewed_by`	Belongs To	ReviewedBy
ReceiptImage	`image_id`	Belongs To	ReceiptImage
ExpenseGroup	`group_id`	Belongs To	ExpenseGroup
ExpenseCode	`code_id`	Belongs To	ExpenseCode
User	`updated_by`	Belongs To	UpdatedBy
MessageThread	`message_thread_id`	Belongs To	MessageThread
Contact	`supplier_id`	Belongs To	Supplier
PurchaseOrder	`purchase_order_id`	Belongs To	PurchaseOrder