API Documentation | Tradetraks

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

Property	Type	Description
`id`	number
`slug`	string
`customer_id`	number
`customer_po`	string
`job_num`	string	This will be auto-generated on new jobs if left blank
`job_name`	string
`date_landed`	date
`permit_needed`	boolean
`inspector_num`	string
`inspector_name`	string
`inspector_email`	string
`permit_notification_number`	string
`permit_cost`	number
`address`	string
`suite`	string
`city`	string
`province`	string
`country`	string
`postal_code`	string
`lat`	number
`long`	number
`distance_from_office`	number
`hospital_json`	string
`address_hash`	string
`location_type`	string
`check_in_tolerance`	number
`description`	string
`collective_agreement_id`	number
`pays_mileage`	boolean
`pays_perdiem`	boolean
`archived`	boolean
`is_lead`	boolean	Denotes whether the project is in "Lead" status, as opposed to "Active"
`lead_source`	string
`is_bonded`	boolean
`has_locates`	boolean
`category_id`	number
`revenue_code_id`	number
`customer_name_cache`	string
`notes`	string
`estimate_locked`	boolean
`holdback_percentage`	number
`read_restricted`	boolean
`write_restricted`	boolean
`is_internal_project`	boolean
`is_draft`	boolean
`schedule_of_values_finalized`	boolean
`schedule_of_values_by_percent`	boolean
`actual_project_cost`	number
`detailed_timelogs`	boolean
`detailed_timelogs_depth`	number
`total_holdback_to_date`	number
`total_holdback_release_to_date`	number
`qbo_id`	number
`created_at`	datetime
`updated_at`	datetime
`updated_by`	number
`date_completed`	date
`collective_agreements_json`	string
`mileage_zones_json`	string

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

Related Resource	Key	Relationship to Job	Property
Company	`tenant_id`	Belongs To	Company
Contact	`customer_id`	Belongs To	Customer
User	`user_id`	Owns Many	User
PayBoost	`payboost_id`	Owns Many	PayBoost
Category	`category_id`	Belongs To	Category
RevenueCode	`revenue_code_id`	Belongs To	RevenueCode
JobPersonnelRole	`personnel_role_id`	Owns Many	JobPersonnelRole
MessageThread	`job_id`	Owns Many	MessageThread
JobContact	`job_id`	Owns Many	JobContact
Contact	`contact_id`	Owns Many	Contact
User	`updated_by`	Belongs To	UpdatedBy
TimeLog	`job_id`	Owns Many	TimeLog
JobFile	`job_id`	Owns Many	JobFile
JobEstimate	`job_id`	Owns Many	JobEstimate
PurchaseOrder	`job_id`	Owns Many	PurchaseOrder
CompanyForm	`job_id`	Owns Many	CompanyForm
JobNote	`job_id`	Owns Many	JobNote
LocateTicket	`job_id`	Owns Many	LocateTicket
JobTask	`job_id`	Owns Many	JobTask
JobInvoice	`job_id`	Owns Many	JobInvoice
JobChangeQuote	`job_id`	Owns Many	JobChangeQuote
SafetyForm	`tailboard_id`	Owns Many	ActiveSafetyForms
JobActualCostDatapoint	`job_id`	Owns Many	JobActualCostDatapoint
ScheduleEvent	`job_id`	Owns Many	ScheduleEvent
JobBid	`job_id`	Owns Many	JobBid

Job Resource In Jobs Module