Maps everyday Tradetraks product language to API resources and important fields. Use this when the resource name does not match what users say in the UI.
| Product term | API resource(s) | Notes |
|---|---|---|
| Project / Projects | Job |
There is no Project model. Soft-delete may apply. /report includes record_count, actual_project_cost_sum, holdback sums. |
| Service / Services / work order | Service |
Distinct from projects (Job). |
| Job / Jobs (casual) | Job and/or Service |
Often means both projects and services. Clarify or query both. |
| Employee / employees / team member | User |
Company membership via CompanyUser / UserPermission. For counts use User/get?count=true. Display names are first_name and last_name (no name field). |
| Customer / supplier / contact | Contact |
Locations on ContactLocation. |
| Training certificate / H&S certificate (on employee) | UserCertificate |
Per-employee certificate with expiry. Filter by cert_name or user_id. To list who holds a cert, include User (first_name, last_name) and dedupe user_id. |
| Certificate type / manage certificates | CompanyCertificate |
Company catalog of certificate types (e.g. First Aid). Link via UserCompanyCertificate. |
| On a project / assigned to project | JobUser |
Not JobPersonnelRole (that is role-type catalog only). |
| On a service / assigned to service | ServiceUser |
Same pattern as JobUser for services. |
| Vacation / time off / sick | ScheduleEvent |
Do not use legacy Event. Allotment: EmployeeSetting; company reset: CompanySetting. |
| Schedule / calendar assignment | ScheduleEvent |
Times stored in UTC. |
| Time log / hours / clock in | TimeLog, OpenTimeLog |
OpenTimeLog is open clocks only. /report may expose cost aggregates. |
| Expense / receipt | Expense |
/report for totals. Images via ReceiptImage. |
| Service invoice / service quote | ServiceInvoice |
Same table; filter is_quote. /report total_revenue sums pretax_total. |
| Project invoice / draw | JobInvoice |
/report includes total_revenue, total_holdback. |
| Purchase order / PO | PurchaseOrder |
/report for totals. |
| Equipment (fleet unit) | Equipment |
Individual asset. Charge-out rates come from its EquipmentType. |
| Equipment type / charge-out rate | EquipmentType |
Use charge_out_rates_json (enabled unit rates). Legacy: charge_out_rate. |
| Customer asset | CustomerAsset |
Customer-owned equipment/sites you service (not your fleet). |
| RFI | Rfi, RfiResponse |
Project requests for information. /report record_count; filter status. |
| Change order | JobChangeOrder |
Line items on JobChangeOrderObject. /report includes grand_total_sum, pretax_total_sum, record_count. |
| Bid / estimate (project) | JobBid (+ components) |
Prefer bidding module over deprecated JobEstimate. /report on JobBid (grand_total_sum) and JobBidComponent (direct_value_sum, direct_labour_hrs_sum). |
| Service contract | ServiceContract |
Recurring/subscription service agreements. /report price_sum (annual price book), record_count. |
| Library / company files | LibraryFile |
Acknowledgements on LibraryAcknowledgement. |
| Company form (filled) | CompanyForm |
Templates are FormTemplate. |
| Locate / utility locate | Locate, LocateTicket |
Call-before-you-dig style tickets. /report record_count. |
| Message / inbox | Message, MessageThread |
|
| Addon app | AddonApp, AddonAppInstalled |
Iframe apps loaded in product slots. |
get with count=true (returns {count}, empty data)./report when the resource lists report metrics.User/get with filters + fields: filter columns are kept for matching even if omitted from fields (nested CompanyUser path).page only applies when the resource has page_limit > 0; otherwise use limit / count.