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

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

Activity BusinessType CertificateUpload Checklist Company CompanyCustomer CompanyLink CompanyUser DrawCanvas EmailList Engagement ErrorLog FeedPost FeedPostComment FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

PurchaseOrder Resource
In Purchase Orders Module

Endpoints

Endpoints URI Access Control Description
save POST /api/PurchaseOrder/save Admin or Module WRITE
pdf GET /api/PurchaseOrder/pdf Authentication only
get-attached-files GET /api/PurchaseOrder/get-attached-files Endpoint level permissions
send GET /api/PurchaseOrder/send Endpoint level permissions
find GET /api/PurchaseOrder/find Admin or Module READ
get GET /api/PurchaseOrder/get Admin or Module READ
save-batch POST /api/PurchaseOrder/save-batch Admin or Module WRITE
delete POST /api/PurchaseOrder/delete Admin or Module WRITE
compileCachedRelations GET /api/PurchaseOrder/compileCachedRelations Endpoint level permissions

Properties

Property Type Description
id number
slug string
job_id number
service_id number
po_num number
line_items_json string
subject string
attached_files_json string
po_date date
supplier_id number
supplier_contact_id number
site_contact_id number
issued_by_id number
attn_contact_id number
ship_to_address_json string
instructions string
terms string
status string
is_finalized boolean
is_closed boolean
last_emailed datetime
message_thread_id number
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) 50 per page
Default Sort Order By insertion order

Relationships

Related Resource Key Relationship to PurchaseOrder Property
JobEstimate estimate_id Belongs To JobEstimate
Contact supplier_id Belongs To Supplier
Contact supplier_contact_id Belongs To SupplierContact
User site_contact_id Belongs To SiteContact
User issued_by_id Belongs To IssuedBy
PurchaseOrderFile po_id Owns Many PurchaseOrderFile
Job job_id Belongs To Job
Service service_id Belongs To Service
MessageThread message_thread_id Belongs To MessageThread
Expense purchase_order_id Owns Many Expense