Integration Toolkit REST API
API Explorer The OpenAPI description for this API is available to view and download here.
Introduction
Section titled “Introduction”A comprehensive REST API enabling seamless integration between external systems and TMT’s fleet maintenance management functionality.
Key Features
Section titled “Key Features”- Fleet Maintenance Management: Comprehensive access to repair orders, preventive maintenance, estimates, invoices, and service history
- Mobile Integration: Support for DVIR inspections, fault reporting, meter readings, and position tracking
- Parts Management: Integration with parts inventory systems and supplier networks (FCA parts integration)
- Accounting Integration: Access to AP/AR/GL transactions related to maintenance operations
- Unit Management: Complete vehicle/equipment lifecycle management including specifications, licenses, and work history
- Flexible Query Parameters: Rich parameter support including date ranges, unit identification, and status filtering
- Real-Time Operations: Access to both current operational data and historical maintenance records
Use Cases
Section titled “Use Cases”- Fleet Maintenance Integration: Synchronize maintenance operations with external CMMS, ERP systems, and accounting platforms
- Mobile Fleet Management: Build mobile applications for technicians, drivers, and fleet managers with access to repair orders, DVIR inspections, and fault reporting
- Parts Inventory Integration: Connect with parts suppliers and inventory management systems for automated ordering and stock management
- Preventive Maintenance Automation: Automate PM scheduling, tracking, and compliance reporting based on mileage, hours, or time intervals
- Compliance & Safety Reporting: Generate DOT compliance reports, safety inspections (DVIR), and maintenance audit trails
- Business Intelligence & Analytics: Extract maintenance data for cost analysis, equipment utilization, and predictive maintenance insights
- Customer Service Portals: Provide customers with access to their equipment service history, maintenance schedules, and repair status
- Telematics Integration: Combine maintenance data with GPS tracking, fuel consumption, and vehicle diagnostics from telematics providers
- Financial Integration: Synchronize maintenance-related accounting transactions (AP/AR/GL) with corporate financial systems
Associated Products
Section titled “Associated Products”- TMT Fleet Maintenance
- TMT Service Center
The API can also be used in conjunction with:
- Third-party ERP systems for accounting integration
- Parts management and inventory systems
- Telematics and GPS tracking systems
- Mobile device management platforms
- Business Intelligence platforms
- Maintenance management systems
- Preventive maintenance scheduling systems
Explanation and Concepts
Section titled “Explanation and Concepts”API Architecture
Section titled “API Architecture”The Integration Toolkit REST API follows RESTful design principles and provides structured access to TMT’s fleet maintenance management objects and processes. The API is organized into logical resource groups that mirror TMT’s functional areas.
Resource Organization
Section titled “Resource Organization”The API endpoints are organized by functional area using the /Integration/{area}/ URL structure:
- Accounting: Financial transactions (AP/AR/GL) related to maintenance operations
- Fleet_ServiceCenter: Repair orders, estimates, invoices, fuel tickets, purchase orders, campaigns
- Mobile: DVIR inspections, fault reporting, meter readings, position tracking
- System: Units (vehicles/equipment), vendors, shops, customers, employees, system codes
- Parts: Parts inventory and supplier integration (FCA)
- OAuth: Authentication token management
- Tax: Tax calculation integration (Vertex)
Data Management Patterns
Section titled “Data Management Patterns”Most endpoints support flexible data management capabilities:
- Current Data: Live maintenance and fleet operational data for real-time integrations
- Historical Data: Maintenance history, PM records, and archived repair information
- Filtered Results: Date ranges, unit identifiers, work order status, and document type restrictions
- CRUD Operations: Support for Create, Read, Update operations on maintenance records
Response Formats
Section titled “Response Formats”The API supports JSON response format for modern applications and API integrations.
Integration Patterns
Section titled “Integration Patterns”Common integration patterns supported by the API include:
- Pull-Based Integration: Regular polling for new repair orders, maintenance updates, or fault reports
- Mobile Integration: Real-time data exchange with mobile devices for DVIR, meter readings, and position updates
- Bi-directional Sync: Both GET and POST operations for comprehensive data synchronization
- OAuth Security: Token-based authentication for secure mobile and third-party integrations
Data Consistency
Section titled “Data Consistency”The API maintains data consistency through:
- Transactional Integrity: Database-level transaction support for maintenance records
- Audit Tracking: Comprehensive logging of maintenance activities and data modifications
Terms of Use
Section titled “Terms of Use”API usage is governed by your TMT license agreement. Contact your Trimble representative or TMT administrator for specific terms and conditions.