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

Job Checklists

JobChecklist

Job Invoices

JobInvoice JobInvoiceTask

Jobs

ChangeOrderSnapshot ChangeWorksheet Job JobActualCostDatapoint JobBid JobBidComponent JobBidComponentObject JobChangeOrder JobChangeOrderObject 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 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

ReceiptImage Resource
In Expenses Module

Endpoints

Endpoints URI Access Control Description
predict POST /api/ReceiptImage/predict Allowed with an active employment connection

Extracts key data from a receipt image using AI—vendor, amounts, dates, expense category, payment method, and similar fields. Use the receipt record id from a prior upload. Subject to monthly usage limits per subscription plan.

Required parameters:

  • id: (int) ID of the receipt record

Errors: Returns an array with a message if id is missing, the record or file is not found, the file is 32MB or larger, the monthly AI limit is exceeded, or the service is unavailable.
save POST /api/ReceiptImage/save Admin or Module WRITE
rotate GET /api/ReceiptImage/rotate Endpoint level permissions

Rotates a receipt image 90° left or right. Also updates any draw layers attached to the image.

Required parameters:

  • id: (int) ID of the receipt image record
  • rotate_direction: (string) left or right

Errors: Returns an array with a message if id is missing.
getFileContentFromRecord GET /api/ReceiptImage/getFileContentFromRecord Endpoint level permissions
resolveLocalPathFromRecord GET /api/ReceiptImage/resolveLocalPathFromRecord Endpoint level permissions
cleanTempFile GET /api/ReceiptImage/cleanTempFile Endpoint level permissions
update GET /api/ReceiptImage/update Endpoint level permissions

Updates mutable metadata for a receipt file. Use this to change sharing or other updatable options without re-uploading.

Required parameters:

  • id: (int) ID of the receipt record

Optional parameters:

  • sharing_on: (boolean) Whether the receipt is shared

Errors: Returns an array with a message if id is missing or invalid, or if you attempt to update a receipt you don't have permission to modify.
delete POST /api/ReceiptImage/delete Admin or Module WRITE
find GET /api/ReceiptImage/find Admin or Module READ
get GET /api/ReceiptImage/get Admin or Module READ
report GET /api/ReceiptImage/report Endpoint level permissions
save-batch POST /api/ReceiptImage/save-batch Admin or Module WRITE

Properties

Property Type Description
id number
type string
original_filename string
cloud_path string
filename string
thumb_filename string
width number
height number
thumb_max_size number
file_size_kb number
slug string
do_not_clean boolean
meta_json string
sharing_on boolean
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 ReceiptImage Property
User uploaded_by Belongs To ReviewedBy
Expense image_id Belongs To Expense