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

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

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

JobInvoice Resource
In Job Invoices Module

Endpoints

Endpoints URI Access Control Description
delete POST /api/JobInvoice/delete Admin or Module WRITE
save POST /api/JobInvoice/save Admin or Module WRITE
activate-revision POST /api/JobInvoice/activate-revision Endpoint level permissions
send POST /api/JobInvoice/send Endpoint level permissions
save-holdback-values GET /api/JobInvoice/save-holdback-values Endpoint level permissions
pdf GET /api/JobInvoice/pdf Endpoint level permissions
save-batch POST /api/JobInvoice/save-batch Admin or Module WRITE
get GET /api/JobInvoice/get Admin or Module READ
find GET /api/JobInvoice/find Admin or Module READ
compileCachedRelations GET /api/JobInvoice/compileCachedRelations Endpoint level permissions
updateInvoiceTotals GET /api/JobInvoice/updateInvoiceTotals Endpoint level permissions
payment GET /api/JobInvoice/payment Endpoint level permissions
partial-payment POST /api/JobInvoice/partial-payment Endpoint level permissions
sendNotice GET /api/JobInvoice/sendNotice Endpoint level permissions
updateViewedLog GET /api/JobInvoice/updateViewedLog Endpoint level permissions
calcTotalTaxes GET /api/JobInvoice/calcTotalTaxes Endpoint level permissions
setDueDateFromTerms GET /api/JobInvoice/setDueDateFromTerms Endpoint level permissions

Properties

Property Type Description
id number
slug string
job_id number
invoice_num number
revision_num number
manual_invoice_number string
is_active_version number
issue_date date
date_first_issued datetime
submitted_log_json string
seen_log_json string
editing_log_json string
payments_json string
bottom_text string
customer_notes string
holdback_percentage number
holdback_release number
pretax_total number
grand_total number
applied_sales_tax_json string
custom_payment_links_json string
custom_payment_required boolean
is_finalized boolean
last_issued datetime
last_emailed datetime
is_portal_document boolean
due_date date
payment_terms number
attn string
is_processed boolean
is_paid boolean
amount_paid number
qbo_id number
qbo_id_history_json string
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 created_at ASC

Relationships

Related Resource Key Relationship to JobInvoice Property
Job job_id Belongs To Job
JobInvoiceTask invoice_id Owns Many JobInvoiceTask
Company tenant_id Belongs To Company