--- title: "Catena ELD Aggregator (formerly Axle)" slug: "catena-eld-aggregator" tags: ["Revenova Rep Required", "Expanded Content", "Fleet Management", "Admin"] updated: 2026-11-09T16:10:11Z published: 2026-11-09T16:10:11Z canonical: "documents.revenova.com/catena-eld-aggregator" --- > ## Documentation Index > Fetch the complete documentation index at: https://documents.revenova.com/llms.txt > Use this file to discover all available pages before exploring further. # Catena ELD Aggregator (formerly Axle) Monitor and manage Fleet operations with the Revenova integration with [Catena](https://www.catenaclearing.io/), an aggregator of Telematics Service Providers (TSP). Catena connects the TMS with over 80 TSPs to provide real-time driver and vehicle information. > [!NOTE] > Catena provides information from several Telematics Service Providers (TSP). The Revenova TMS refers to a specific TSP as the Electronic Logging Device (ELD) Brand or Provider. > > - The terms TSP, ELD Provider, and ELD Brand are used interchangeably. > - ELD Providers often include access to an environment to view Fleet Assets, Drivers, and control other configuration settings. Each ELD Provider manages and provides the login information for these environments. See [Driver](/v1/docs/catena-eld-aggregator#update-driver) and [Fleet Asset](/v1/docs/catena-eld-aggregator#update-vehicle) syncing information below to control how and when records are updated. Fleet Asset and Driver records exist in both the TMS and and the corresponding ELD Provider. Each time the [Fleet Management Job 4](/v1/docs/fleet-management-job-4) runs, records are kept in sync to ensure any record changes are consistent from both Catena and the TMS. In most cases, any record changes originate from the ELD Provider and propagate through Catena to the TMS. A small subset of fields may be created or updated in the TMS and sent back to Catena to populate the corresponding ELD Provider. For specific field information, see the [Fleet](/v1/docs/catena-eld-aggregator#fleet), [Driver](/v1/docs/catena-eld-aggregator#driver), and [Vehicle](/v1/docs/catena-eld-aggregator#vehicle) sections below. ## **Setup** > [!WARNING] > Each Telematics Service Provider (ELD Provider) has specific functionality setup, record requirements, and restrictions. Telematics Service Provider typically provide a configuration portal to manage the flow of data. Confirm the portal configuration settings allow for required data sync functionality. > > - For example, [Motive](https://gomotive.com/) requires additional setup to allow driver dispatching. In order to dispatch routes to the Motive driver app, the *Public Driver Workflow* setting must enabled. By default, the *Motive Native Dispatch* is enabled, not the *Public Driver Workflow* setting. > > > > Use caution with Fleet Asset **Name** or **License Plate Number** fields that may be sent to Catena to update records. For example, some services limit Name fields to a specific number of characters. TMS Fleet Asset record **Name** and **License Plate Number** fields may allow for more characters. ### Configure Named Credentials The integration with Catena requires a Named Credential. [Open a case](/v1/docs/getting-started-with-revenova#create-a-revenova-support-case) with Revenova support to create the *Catena* and *Catena_Test* External Credentials in production and sandbox orgs. Once created, confirm the correct profiles and permissions are set for the Named Credentials. 1. From **Setup**, search for *Named Credentials*. 2. Choose the *Named Credentials* link. 3. Select the *External Credentials* tab. 4. Add support for the appropriate Profiles and/or Permission Sets as necessary. 1. For Profiles, navigate to **Setup → Profiles**. 1. Select the appropriate Profile(s). 2. Find the *Enabled External Credential Principal Access* section. 3. Click **Edit**. 1. Add *Catena - Admin* to the **Enabled External Credential Principals** section in production orgs. 1. Add *Catena_Test - Admin* to the **Enabled External Credential Principals** section in sandbox orgs. 2. Click **Save**. 2. For Permission sets, navigate to **Setup → Permission Sets**. 1. Select the appropriate Permission Set(s). 2. Choose the *External Credential Principal Access* link. 3. Click **Edit**. 1. Add *Catena - Admin* to the **Enabled External Credential Principal Access** section in production orgs. 1. Add *Catena_Test - Admin* to the **Enabled External Credential Principal Access** section in sandbox orgs. 2. Click **Save**. ### Credentials Card Enable the Catena integration by completing the following steps. 1. Navigate to **TMS Admin**. 2. Select **Credentials**. 3. Select the **Global Services** tab. 4. Find *Catena* in the list and select the card. (Catena, formerly Axle) 5. Check the **Enabled** box. 6. The **User ID** and **Password 1** are provided and entered by a Revenova representative into the text fields. 1. The **Customer Number** is automatically set to the Fleet Id field provided by Catena. 7. Click the **Save** button. | User ID | Password 1 | Password 2 | Customer Number | | --- | --- | --- | --- | | User Id | Password | | Fleet Id | ### Remote Site Settings Upgrading from previous versions of the TMS may have outdated information. 1. Click the **Setup** gear icon in the top right corner. 2. From the drop-down, click **Setup**. 3. In the Quick Find Toolbar type *Remote Site Settings* and click the link. 4. From the list of remote sites find Axle and click the **Edit** link. 5. Update the Remote Site URLs to match the *Service URLs* below. Service URL: https://api.axleapi.com/v1 ### **Link ELD Providers** > [!WARNING] > *Do not test the Catena integration in production orgs.* Only test the integration in a sandbox to avoid creating records for test Drivers and Fleet Assets in the production org. When testing, ensure that the Catena **Test Mode** box is *Checked* on the [Credentials](/v1/docs/credentials-1#global-services) card. To configure a production org, *Uncheck* the **Test Mode** box before running Fleet Management Job 4. *Check* the **Test Mode** field on the Catena credentials card while linking ELD Providers. Test the integration once a ELD Provider is linked in the sandbox before performing the steps below in production. 1. Select the **Catena** credentials card to view the card. 2. Check the **Test Mode** field and click Save. 3. Select the **Catena** credentials card again to view the card. 4. Click the **Link ELD Account** button. ![](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/Link Fleet - 1.jpg) 1. Click **Continue** and follow the prompts to find the appropriate ELD Provider. 2. Enter the ELD Provider account credentials and select **Connect Telematics**. > [!WARNING] > Some ELD Providers may prompt an issue that the Revenova TMS is not recognized or “supported.” Continue linking process as this issue may be skipped. 3. Repeat steps 3 through 5 to link additional fleets as necessary. 4. The **Link Status** field is automatically set to *Checked* the first time Fleet Management Job 4 runs. > [!NOTE] > Production and testing environment credentials are provided by each ELD Provider. Contact the ELD Provider to acquire these credentials. ### **Other Setup Information** - Enable Feed Tracking for the Driver object. This enables the Chatter feature and allows for Driver messaging across the Fleet Management Module. - From **Setup** → **Feed Tracking**, select the *Driver* object. - *Check* **Enable Feed Tracking**. - Click **Save**. Navigate to TMS Admin → Configuration, [Fleet Management](/v1/docs/fleet-management-3). When finished configuring the following fields, click **Save**. - *Check* the **Fleet Management Enabled** box. - Select [**Fleet Management 4**](/v1/docs/fleet-management-job-4) from the **Fleet Management Job** picklist selection. - Fleet Management 4 job controls syncing record data between the TMS and the Catena integration. - Select a **Fleet Management Default ELD Provider** from the picklist selection. - Choose the majority Provider for Fleets with multiple ELD Providers. - Review the **Driver Log Grace Period (Days)** value. The default value is 2 days. Enter another value if necessary. - *Check* the **Enable Routing Consolidate Locations** field to consolidate duplicated Stop locations as one single Stop location. When *Checked* and the Segment contains Legs with consecutive End Stops/Locations of the same location, those locations are sent as a single location. - This only applies to defined location Accounts and not general addresses or geolocations. - Enter an email address in the **Fleet Management Email** box. - Search Accounts and select a **Fleet Management Default Carrier**. A Default Carrier is not required, but recommended. - Select a **Default ELD Provider** from the picklist. - **Save** the information when complete. - *Check* the **Create ELD Trip On Dispatch** field based on preferred functionality. - When *Checked*, Trips are sent to the ELD Provider when the user clicks the **Dispatch** button on the Trip Plan Segment. - When *Unchecked*, Trips are sent to the ELD Provider when the Trip Plan Segment **Driver Confirmation Status** moves to *Accepted*. - *Check* the **Disable ELD Dispatch** field to prevent the TMS from sending Trip information to ELD Providers. - This field should remain *Checked* if the ELD Provider does not support receiving Trip information. - Set the **Sync Active Drivers Only** field, as necessary. - When *Checked*, only Drivers set as *Active* in the ELD Provider and TMS are sent to create or update records in the ELD Provider or TMS. - When *Unchecked*, all Drivers in the ELD Provider are created or updated in the TMS. - Set the **Sync Active Fleet Assets Only** field, as necessary. - When *Checked*, only Fleet Assets set as *Active* in the ELD Provider are created or updated in the TMS. - When *Unchecked*, all Fleet Assets in the ELD Provider are created or updated in the TMS. > [!NOTE] > **Note**: Run Fleet Management Job 4 instead of the deprecated Fleet Management Job 2. The newer job is significantly faster and more efficient. The Revenova TMS is packaged with a Driver Lightning Record Page designed for use with the Catena integration. Assign the Driver Lightning Page Layout by completing the following steps. 1. Navigate to **Setup → Object Manager**. 2. Choose the *Driver* object. 3. Select the *Lightning Record Pages* link. 4. Choose the *Driver - Revenova Default (Catena)* page. 5. Click the **Edit** button. 6. Choose the **Activation…** button. 7. Click the **Assign as Org Default** button. 8. Select **Desktop and phone**. 9. Choose **Next**. 10. From the Review assignment modal, click **Save**. **Driver Records** - Driver records may be loaded into the TMS manually, the Salesforce [Data Loader](https://developer.salesforce.com/tools/data-loader), or from the ELD Provider. After records are created, the Revenova TMS is the “system of record” or “source of truth” for Driver records. - Any later changes to existing Driver record fields are sent to Catena to update records in the ELD Provider. - The only Driver fields that may update from changes made in the ELD Provider and sent to the TMS are the **ELD ID** and **ELD Brand** fields. - When Driver records are created from the ELD Provider, Driver record fields are populated with the response from the [Get Drivers](/v1/docs/catena-eld-aggregator#get-drivers) end point. - Changes made to Driver records in the TMS are sent to the ELD Provider in the [Update Driver](/v1/docs/catena-eld-aggregator#update-driver) call. Note the following Driver fields that control how records are created or synced between Catena and the TMS. - **ELD Enabled** - When *Checked*, Drivers that do not exist in the ELD Provider are sent from the TMS to create those records in the ELD Provider. - **ELD Exempt** - When *Checked*, Hours of Service features and violations do not sync between Catena and the TMS. **Fleet Asset Records** - Fleet Asset records are loaded into the TMS from the ELD Provider. After records are created, the ELD Provider is the “system of record” or “source of truth” for Fleet Asset records. - Any later changes to existing Fleet Asset record fields are received from Catena to update records in the TMS. - The only Fleet Asset fields that may update from changes made in the TMS and sent to the ELD Provider are the **Name** and **License Plate Number** fields. These fields are sent to Catena with the [Update Vehicle](/v1/docs/catena-eld-aggregator#update-vehicle) call. To begin syncing ELD information from Catena, run [Fleet Management Job 4](/v1/docs/fleet-management-job-4). > [!NOTE] > - Setting a Driver or Fleet Asset from Active to Inactive (or vice versa) in the TMS does not set the equivalent value in the ELD Provider. Likewise, changing a Driver or Fleet Asset from Active to Inactive (or vice versa) in the ELD Provider environment does not update the equivalent value in the TMS. > - Deactivate a Driver or Fleet Asset by deactivating the Driver or Fleet Asset records in both the TMS and the ELD Provider. > - In the TMS, set the Driver **Driver Activation Status** field to *Deactivated*. > - In the TMS, set the Fleet Asset **Status** field to *Out of Service*. > - Set the corresponding statuses to Inactive in the ELD Provider. ## **Catena API Endpoints** ### **Authentication** The Catena authentication endpoints verify the credentials of TMS users and pair TMS Fleet Account records to a Catena account. #### Get Authentication token Calling any of the Catena API endpoints requires an authentication token. A new authentication token is requested or refreshed before any other calls to Catena endpoints. Each time the Fleet Management 4 job runs, the **Get Authentication token** endpoint is called to request or refresh the authentication token. Authentication tokens expire every 12 hours. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get authentication token | POST | 201: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | Sample **Get Token** Request Payload ```json {  "email": "demo_test@axleapi.com",  "password": "test" } ``` Sample **Get Token** Response Payload ```json {    "access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5gHQ_yVrtYnkmA",    "expires_in": 43200,    "refresh_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVC3MiOiJodHRwczovcmVmcmVBIeLfMTIU4rOQuZj3ZblNw",    "refresh_token_expires_in": 2592000,    "email": "demo_test@axleapi.com",    "service_id": 981,    "token_type": "Bearer" } ``` **No TMS Field Updates** #### Link Fleets The **Link Fleet** endpoint is called to pair a TMS Account record to an Catena Fleet Code. The **Link Fleet** endpoint may be called more than once to add additional Fleets (TMS Account records) to a single Catena account. Multiple Linked Fleets are required when requesting information from multiple ELD Providers or when managing multiple Companies/Divisions. Complete the steps for linking ELD Providers [here](/v1/docs/catena-eld-aggregator#link-eld-providers). | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | **Link ELD Account** button on the Catena credentials card | Get link token | POST | 201: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | TMS fields sent in the **Link Fleet** Request | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Account | SFID | SFID | fleet_code | Sample **Link Fleet** Response ```json {  "token": "exampleLinkTokenABC123",  "expires_in_seconds": 3600,  "url": "https://auth.axleapi.com?token=exampleLinkTokenABC123" } ``` **No TMS Field Updates** ### **Fleet** The Catena Fleet endpoints send Fleet information into the TMS from the ELD Providers. Fleet information, Fleet Assets, Drivers, and Vehicle locations are sent to the TMS with this collection of calls. #### Get Fleets IDs The **Get Fleet IDs** call returns all of the Fleet ID(s) associated with a Catena account and stores them until the end of the current run of Fleet Management Job 4. Fleet IDs are required for calls to other Catena API endpoints. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get all fleets | GET | 201: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | No TMS Fields are sent in the **Get all Fleets** call. The Token returned from [Get Authentication Token](/v1/docs/catena-eld-aggregator#get-authentication-token) is sent in the Get All Fleets call. Sample **Get all fleets** Response Payload ```java {    "fleet_ids": [        20696,        8847    ] } ``` **No TMS Field Updates** #### Get Fleet Data The **Get Fleet Data** call returns the Catena tsp_id, name, and fleet_code for updating Driver and Fleet Asset records. This endpoint is called for each TMS Account record paired to an Catena account. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 (Passes 4 and 6) | Get fleet data | GET | 201: Success 400: Bad Request 500: Internal Server Error | Sample **Get Fleet Data** Response ```json {  "id": 2354,  "time": "2020-01-27T07:06:25.000Z",  "fleet_code": "dafhjk13cxiLE48",  "tsp_source": "motive",  "invalid_credentials": false,  "tsp_details": [    {      "axle_tsp_id": 25,      "name": "motive",      "invalid_credentials": false    },  ],  "carrier": {    "carrier_name": "Acme Inc.",    "dot_number": 87654321,    "home_terminal_address": "1234 Pear St., Scranton, PA 62814",    "home_terminal_name": "Acme Inc.",    "main_office_address": "1234 Pear St., Scranton, PA 62814"  } } ``` **No TMS Field Updates** #### Get Vehicles in a Fleet The **Get vehicles in a fleet** endpoint populates Fleet Asset records in the TMS from Catena. To prevent record sync errors, Fleet Asset records must have a **Company/Division Id** field value. > [!WARNING] > Fleet Asset records are not created in the TMS and sent to Catena or the ELD Provider. They are received from the ELD Provider via Catena and created in the TMS. Any Fleet Asset records created in the TMS do not populate into Catena or to the original ELD Provider. Many Fleet Asset record field values that are manually changed in the TMS are synced with the field values received from Catena. Contact the ELD Provider to update Fleet Asset fields that are synced with Catena. Fleet Asset records are received from Catena and then created in the TMS. Each time the Fleet Management 4 Job runs, the TMS and Catena records are compared. Any new Fleet Assets are created in the TMS. See the [Update vehicle](/v1/docs/catena-eld-aggregator#update-vehicle) section for more information on updating the Fleet Asset Name or License Plate Number fields and sending to Catena. | TMS Fleet Asset Status | Catena Status | | --- | --- | | Available | Active | | Out of Service | Inactive | | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get vehicles in a fleet | GET | 201: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | The Fleet ID(s) are sent to the **Get vehicles in a fleet** endpoint. Fleet Asset records are returned to the TMS where records are either created or updated as necessary. Sample **Get vehicles in a fleet** Response Payload ```json {  "fleet_id": 2354,  "vehicle_ids": [    103,    243,    823  ],  "details": [    {      "id": 103,      "fleet_id": 2354,      "time": "2020-01-27T07:06:25.000Z",      "tsp_source": "motive",      "oem": "Freightliner",      "model": "Cascadia",      "model_year": "2018",      "vin": "3AKJHHDR9JSJV5535",      "license_plate_state": "CA",      "license_plate_number": "5T31250",      "status": "active",      "name": "Truck 1234",      "eld_device_id": "1000000492436002",      "location": {        "latitude": 122.142,        "longitude": -93.343,        "address": "16 N Fair Oaks Ave",        "Pasadena": null,        "CA 91103": null      },      "speed": {        "value": 48.3,        "unit": "mph"      },      "odometer": {        "value": 140100,        "unit": "miles"      },      "fuel": {        "value": 54,        "unit": "percent"      },      "current_driver_id": 123    }  ] } ``` **TMS Field Updates** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Fleet Asset | ELD ID | Text(50) (External ID) | detail.id | | Fleet Asset | ELD Serial Number | Text(50) | detail.eld_device_id | | Fleet Asset | Fleet Asset Name | Text(80) | detail.name | | Fleet Asset | License Plate Number | Text(20) | detail.license_plate_number | | Fleet Asset | Status | Picklist | TMS sets to *Available* | | Fleet Asset | Type | Picklist | TMS sets to *Tractor* | | Fleet Asset | Vehicle Make | Picklist | detail.oem | | Fleet Asset | Vehicle Model | Picklist | detail.model | | Fleet Asset | VIN | Text(50) (External ID) | detail.vin | | Fleet Asset | Year | Text(4) | detail.model_year | #### Get Latest Vehicle Locations The **Get all latest vehicle locations in a fleet** endpoint provides the latest location information for Fleet Assets. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get all latest vehicle locations in a fleet | GET | 200: Success 400: Bad Request 500: Internal Server Error | The Fleet ID(s) are sent to the **Get all latest vehicle locations in a fleet** endpoint. Sample **Get all latest vehicle locations in a fleet** Response Payload ```json {  "fleet_id": 432,  "vehicle_locations": [    {      "id": 103,      "vehicle_id": 407,      "latitude": 122.142,      "longitude": -93.343,      "course": 32.42,      "address": "16 N Fair Oaks Ave, Pasadena, CA 91103",      "date_time": "2020-01-27T07:06:25.000Z",      "odometer": {        "value": 311560,        "unit": "miles"      },      "speed": {        "value": 31,        "unit": "mph"      },      "fuel": {        "value": 57,        "unit": "percent"      },      "vehicle": {        "id": 407,        "name": "Best Vehicle 123",        "oem": "Freightliner",        "model": "Cascadia",        "model_year": "2017",        "vin": "3AKJHHDR9JSJV5535",        "license_plate_state": "US-MA",        "license_plate_number": "XHJ-48D",        "eld_device_id": "832SZ"      },      "driver": {        "id": 209,        "name": "John Doe",        "license_number": "X192AGJ",        "license_state": "MA",        "license_country": "US"      }    }  ] } ``` **TMS Field Updates** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Fleet Asset | Current Location | Text(200) | vehicle_locations.address | | Fleet Asset | ELD ID | Text(50) (External ID) | detail.id | | Fleet Asset | ELD Last Update | Date/Time | vehicle_locations.date_time | | Fleet Asset | Fuel Percent Remaining | Number(3, 0) | vehicle_locations.fuel | | Fleet Asset | Geolocation | Geolocation | vehicle_locations.latitude, vehicle_locations.longitude | | Fleet Asset | Last Odometer Reading | Number(18, 0) | vehicle_locations.odometer | | Fleet Asset | Speed (kph) | Number(10, 2) | vehicle_locations.speed.value | | Fleet Asset | Speed (mph) | Number(10, 2) | vehicle_locations.speed.value | #### Get Drivers The **Get drivers in a fleet** endpoint returns a list of driver ids and Driver records from Catena. Any Drivers (and their associated Contact records) that do not exist in the TMS are created in the TMS. > [!NOTE] > Drivers are created in the TMS based on the status received from the ELD Provider and the **Sync Active Drivers Only** field in the TMS. When the **Sync Active Drivers Only** field is *Checked*, the following logic controls Driver updates in the TMS and ELD Provider. - Drivers are created in the TMS with an *Active* **Driver Activation Status**. - Drivers set as Inactive in the ELD Provider environment do not update in the TMS. | TMS Driver Activation Status | Catena Status | | --- | --- | | Available | Active | | Out of Service | Inactive | TMS Contact records are searched by name for any existing records. If found, a Driver is created and paired to the existing Contact record. The Driver **Phone** and **Email** fields are populated from the existing Contact record. When a Driver **Phone** and **Email** are populated, the Contact **Phone** and **Email** values are updated to match. If a Driver **Phone** or **Email** are not populated, the Driver fields are updated to match the corresponding Contact fields. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get drivers in a fleet | GET | 200: Success 400: Bad Request 500: Internal Server Error 503: Service Unavailable | The Fleet ID(s) are sent to the **Get drivers in a fleet** endpoint. Sample **Get drivers in a fleet** Response Payload ```json {  "fleet_id": 2354,  "driver_ids": [    123,    211,    601,    621,    741  ],  "details": [    {      "id": 123,      "fleet_id": 2354,      "time": "2020-01-27T07:06:25.000Z",      "tsp_source": "motive",      "name": "Susan Smith",      "phone": "”5558234327“",      "email": "susan@company.com",      "carrier": {        "carrier_name": "Acme Inc.",        "dot_number": 87654321,        "home_terminal_address": "1234 Pear St., Scranton, PA 62814",        "home_terminal_name": "Acme Inc.",        "main_office_address": "1234 Pear St., Scranton, PA 62814"      },      "status": "active",      "license": {        "license_number": "E1834567",        "license_state": "CA",        "license_country": "USA"      },      "work_rules": {        "break": "Property (off-duty/sleeper)",        "cycle": "USA 60 hour / 7 day",        "jurisdiction": "AR",        "restart": "34-hour Restart",        "shift": "US Interstate Property"      },      "hours_of_service": {        "date": "2020-01-27",        "off_duty_seconds": 43200,        "on_duty_seconds": 7200,        "sleeper_seconds": 0,        "driving_seconds": 21600,        "waiting_seconds": 0,        "active_seconds": 7200,        "personal_conveyance_seconds": 0,        "yard_move_seconds": 0      },      "external_ids": {        "maintenance_id": "250020",        "payroll_id": "ABFS18600"      },      "notes": "Prefers West Coast trips.",      "created_at_time": "2019-05-18T20:27:35.000Z",      "timezone": "America/Los_Angeles",      "current_vehicle_id": 103,      "vehicle_group": {        "id": "3914",        "name": "East Coast"      }    }  ] } ``` **TMS Field Updates** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Driver | *Activation Status | Picklist | status | | Driver | CDL # | Text(50) | details.license.license_number | | Driver | CDL State/Province | Picklist | details.license.license_state | | Driver | Contact | Lookup(Contact) | details.name | | Driver | Cycle Override | Picklist | details.work_rules.cycle | | Driver | Driver Name | Text(80) | details.name | | Driver | ELD Brand | Picklist | details.tsp_source | | Driver | ELD Enabled | Checkbox | TMS sets to *Checked* | | Driver | ELD ID | Text(50) (External ID) | details.id | | Driver | Phone | Phone | details.phone | | Driver | Rest Break Override | Picklist | details.work_rules.break | | Driver | Restart Override | Picklist | details.work_rules.restart | | Driver | Timezone | Picklist | details.timezone | | Driver | Username | Text(50) | details.notes, details.username | *If the **Activation Status** field is set to *Deactivated* for a new Driver, the Driver **Status** field is set to *Unavailable*. Manually setting the **Activation Status** for a Driver to *Deactivated* does not update the driver record in Catena. When a Driver is created in the TMS from Catena, an associated Contact record is created. After a Driver record is created in the TMS, the only fields that may update based on changes received from Catena are the **ELD ID** and **ELD Brand** fields. **TMS Field Updates with no matching Driver Contact** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Contact | Account Name | Lookup(Account) | Fleet Management Default Carrier | | Contact | Name | Name | details.name | | Contact | Transportation Role | Picklist (Multi-Select) | TMS sets to *Driver* | | Driver | Type | Picklist | ***Employee* or *Independent Contractor* | ** See the [Fleet Management 4](/v1/docs/fleet-management-job-4) Job documentation for information on how the TMS sets the Driver **Type** field value. #### Get Fleet Documents The **Get all fleet documents** endpoint returns documents from Catena. Some ELD Providers include additional document file information. No field information is stored in the TMS when documents are returned from Catena. > [!WARNING] > All Documents are requested from Catena since the date and time the Fleet Management Job last ran. Set a date and time in the **Fleet Management Job Last Run** field under TMS Admin → Configuration, [Fleet Management](/v1/docs/fleet-management-3) to request all documents from that date. If no value is in this field, all queued documents are requested from Catena. This includes all documents for approximately the two previous weeks. Documents are sent to the TMS and are handled based on the following criteria. 1. When a Load is associated with a Trip Plan Segment, documents are stored on the Load Documents section. 2. When no Load is associated with a Trip Plan Segment, an Inbound Email Record is created. 3. When the Driver is not associated with any Trip Plan Segments, an Inbound Email record is created. Inbound Email records are formatted with the following information. From the App Launcher, search for *Inbound Emails* to open the list view. - The document file is attached to the email. - The subject and body read, “The driver document could not be associated with a Load.” - The “From” email is the Driver Contact record. - If the Driver Contact does not have an email address, the Inbound Email record is created with an error. The error includes: “No Email on Matching Contact Record: + Driver Name” - When the Driver Contact record does not have an email address, the document is inserted into the TMS as a file. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get all fleet documents | GET | 200: Success 400: Bad Request 404: Not Found 500: Internal Server Error | The Fleet ID(s) and Start Date are sent to the **Get all fleet documents** endpoint. All documents are returned from the Start date to the current time running the Fleet Management Job 4. > [!NOTE] > Drivers may be associated with multiple Loads. The Load Name added to received documents is set by the Trip Plan Segment with the most recent Start Date/Time. > > Loads are associated with a Trip Plan when the Load is included on at least one Trip Plan Segment for a Trip Plan. TMS Fields sent in the **Get all fleet documents** Request | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credential Card | Customer Number | | fleet_id | | Not a TMS record | Date/Time | Date/Time of last Fleet Management job run | start_date | | Not a TMS record | Date/Time | Date/Time of “now” | end_date | Sample **Get all fleet documents** Response Payload ```json {  "fleet_id": 432,  "documents": [    {      "document_id": 2354,      "type": "dvir",      "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456",      "name": "dvir doc 1",      "notes": "additional comments",      "status": "submitted",      "time": "2020-01-27T18:07:35.000Z"    }  ] } ``` Documents are processed and stored based on the following logic. 1. Documents received from Catena are matched to the Driver **ELD ID**. Documents are saved to the Load matched with the Driver **ELD ID**. 2. If no Load is matched with the Driver **ELD ID**, an Inbound Email record is created and saved in the TMS. 3. If no Load is matched with the Driver ELD and the Driver does not have an email address, the document is saved in the org Files. **No TMS Field Updates** #### Fleet Messages Send and receive messages to and from Drivers and store them in the TMS. > [!WARNING] > All messages are requested from Catena since the date and time the Fleet Management Job last ran. Set a date and time in the **Fleet Management Job Last Run** field under TMS Admin → Configuration, [Fleet Management](/v1/docs/fleet-management-3) to request all messages from that date. If no value is in this field, all queued messages are requested from Catena. This includes all messages for approximately the two previous weeks. Messages are stored on the Driver object and are not stored on the Load. Send and receive Driver messages from the following locations. 1. From the [Load Detail](/v1/docs/load-detail) LWC. 2. The Related Records section on the [Fleet Management Console](https://documents.revenova.com/docs/fleet-management-console-views#fleet-management-functions). 1. It is possible to send the same message to multiple Drivers at one time. 2. Multiple messages cannot be sent to multiple Drivers at one time. Split up messages as necessary to send to multiple Drivers. 3. Trip Plan Segments on the [Trip Planner](/v1/docs/trip-planning) LWC. **Send Fleet Messages** Outbound messages to drivers are sent immediately when the **Send** button is clicked. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | **Send** on Send Driver Message modal | Post message | POST | 200: Success 400: Bad Request 401: Unauthorized 404: Not Found 500: Internal Server Error | TMS Fields sent in the **Post message** Request | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credential Card | Customer Number | | fleet_id | | Driver | ELD ID | Text(50) (External ID) | recipient_id | | Not a TMS record | | message | body | Sample **Post message** Request Payload ```json {  "fleet_id": 12345,  "recipient_ids": [    456,    789  ],  "body": "Hello, this is a test message." } ``` Sample **Post message** Response Payload ```json {  "fleet_id": 432,  "message": {    "sender": {      "sender_id": 2354,      "sender_name": "John Doe"    },    "recipients": [      {        "recipient_id": 123,        "recipient_name": "Jane Smith"      },      {        "recipient_id": 345,        "recipient_name": "Bob Johnson"      }    ],    "body": "Lorem ipsum",    "is_read": false,    "time": "2020-01-27T18:07:35.000Z"  } } ``` **No TMS Field Updates** **Receive Fleet Messages** The **Get all fleet messages** endpoint returns messages from Drivers through Catena. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get all fleet messages | GET | 200: Success 400: Bad Request 404: Not Found 500: Internal Server Error | The Fleet ID(s) and Start Date are sent to the **Get all fleet messages** endpoint. All messages are returned from the Start date to the current time running the Fleet Management Job 4. > [!NOTE] > Catena provides messages in different format types depending on the ELD Provider. The sender_name field controls when messages are stored in the TMS. The two scenarios outlined below are examples when messages are not saved from Drivers using a particular ELD Provider. > > - Samsara messages with a sender_name value of “Dispatch” are not saved. Messages with this value are sent from Samsara to the Driver. > - Motive messages do not contain a sender_name or sender_id to match to a Driver and are not saved. > > The recipient_id field pairs a message to a specific Driver. TMS Fields sent in the **Get all fleet messages** Request | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credential Card | Customer Number | | fleet_id | | Not a TMS record | Date/Time | Date/Time of last Fleet Management 4 job run | start_date | > [!NOTE] > Drivers may be associated with multiple Loads. The Load Name added to received messages is derived from the Trip Plan Segment with the most recent Start Date/Time. Messages are returned and matched to each Driver via the ELD ID and the recipient_id returned from Catena. Sample **Get all fleet messages** Response Payload ```json {  "fleet_id": 28183,  "messages": [    {      "sender": {        "sender_name": "John Test"      },      "recipients": [        {          "recipient_id": 4259414,          "recipient_name": "Bill Test"        }      ],      "body": "Driver sending back ",      "is_read": false,      "time": "2025-02-05T17:56:30Z"    },    {      "sender": {        "sender_name": "Dispatch"      },      "recipients": [        {          "recipient_id": 4261050,          "recipient_name": "August Eighth Twenty Twenty Four Ten Fifty"        }      ],      "body": "Dispatch text",      "is_read": false,      "time": "2025-02-05T17:55:20Z"    },    {      "sender": {        "sender_name": "Dispatch"      },      "recipients": [        {          "recipient_id": 4260923,          "recipient_name": "August Seventh Twenty Twenty Four Sixteen Thirty Five"        }      ],      "body": "Dispatch text 2",      "is_read": false,      "time": "2025-02-05T17:55:20Z"    },    {      "sender": {        "sender_name": "Dispatch"      },      "recipients": [        {          "recipient_id": 4259414,          "recipient_name": "Bill Test"        }      ],      "body": "Test",      "is_read": true,      "time": "2025-02-04T16:02:52Z"    },    {      "sender": {        "sender_name": "Dispatch"      },      "recipients": [        {          "recipient_id": 4259414,          "recipient_name": "Bill Test"        }      ],      "body": "Hello World",      "is_read": true,      "time": "2025-02-04T15:54:43Z"    }  ] } ``` *The “Dispatch” sender_name in the example above is specific to Samsara in the Catena environment. Sender “Dispatch” messages are original messages sent from the TMS.* **No TMS Field Updates** ### **Driver** The Driver API endpoints allow for creating and syncing Driver and Driver Log records between Catena and the TMS. See the individual calls below for the field values that are exchanged for each endpoint. > [!WARNING] > Catena requires unique Driver **First** and **Last Name** fields. If multiple TMS Driver records have the same Driver **Name** fields they are not sent to Catena. An email with the duplicate names is sent to the Fleet Management Email. When *Checked*, the **Sync Active Drivers Only** field controls the following actions. - TMS Driver records with a *Deactivated* **Driver Activation Status** field but are Active in the ELD Provider generate a “Duplicate Contact Found for Driver” error. - TMS Driver records with a *Deactivated* **Driver Activation Status** field do not update Drivers in the ELD Provider during the [Create](/v1/docs/catena-eld-aggregator#create-driver) and [Update](/v1/docs/catena-eld-aggregator#update-driver) Driver calls. #### **Create Driver** The Create driver endpoint is called to send Driver records from the TMS to Catena and the ELD Provider. Catena requires Driver Names be unique (regardless of ELD Brand). When creating Driver records in the TMS, confirm no Drivers share the same **First** and **Last Name**. TMS Driver records must have the following fields to create the Driver in the ELD Provider. - Company/Division Id - ELD Enabled (*Checked*) - ELD Brand - Username > [!WARNING] > Use caution when creating Driver records in the TMS. Once sent to Catena, the **Driver Name** (First & Last) field can only update in Catena when all of the following fields match. If at least one field does not match, a duplicate match error is generated. > > - CDL # > - CDL State/Province > - Cycle Override > - Rest Break Override > - Restart Override > - Timezone Catena returns a list of the Driver **ELD ID** fields that populate on TMS Driver records. When the **Sync Active Drivers Only** field is *Unchecked*, the following logic controls Driver updates in the ELD Provider. - A Driver is sent to the ELD Provider. No active Driver matches and an “Username already exists.” error is generated. - ELD Providers without duplication logic may create duplicate Drivers. See [Fleet Management Job 4](/v1/docs/fleet-management-job-4) information for more specific syncing criteria. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Create driver | POST | 201: Success 400: Bad Request 500: Internal Server Error 503: Service Unavailable | TMS Fields sent in the **Create driver** call. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credential Card | Customer Number | | fleet_id | | Not a TMS record | From **Get fleet data** call | | axle_tsp_id | | Driver | Activation Status | Picklist | status | | Driver | CDL # | Text(50) | license_number | | Driver | CDL State/Province | Picklist | license_state | | Driver | Company/Division | Formula(Text) | carrier_name | | Driver | Cycle Override | Picklist | primary_cycle | | Driver | Driver Name | Text(80) | *first_name, last_name | | Driver | ELD Exempt | Checkbox | is_eld_exempt | | Driver | ELD Exempt Reason | Text Area(255) | eld_exempt_reason | | Driver | Personal Conveyance Duty Status | Checkbox | is_personal_conveyance_enabled | | Driver | Password | Text (Encrypted)(50) | password | | Driver | Phone | Phone | phone | | Driver | Rest Break Override (or “None”) | Picklist | rest_break | | Driver | Restart Override (or “None”) | Picklist | restart | | Driver | Timezone | Picklist | timezone | | Driver | Username | Text(50) | **notes | | Driver | Yard Move Duty Status | Checkbox | is_yard_move_enabled | | Transportation Profile | ***US DOT Number | Text(10) | dot_number | *The **Driver Name** (First & Last) field can only update in Catena when all of the following fields match. If at least one field does not match, a duplicate match error is generated. - CDL # - CDL State/Province - Cycle Override - Rest Break Override - Restart Override - Timezone **Sent as “TMS - Username: ” + Driver **Username**. ***US DOT Number is numeric only. Sample **Create driver** Request Payload ```json  "fleet_id": 20696,  "axle_tsp_id": 25,  "override_duplicates": false,  "carrier_name": "Test Carrier Fleet",  "dot_number": 123456789012,  "first_name": "Bill",  "last_name": "Driver",  "username": "bdriver2",  "password": "password1",  "phone": "”5558234327“",  "license": {    "license_number": "E1834567",    "license_state": "CA",    "license_country": "USA"  },  "timezone": "Eastern Time (US & Canada)",  "notes": "From TMS- Username: bdriver2",  "primary_cycle": "USA Property (8/70)",  "is_eld_exempt": false,  "is_yard_move_enabled": false,  "is_personal_conveyance_enabled": false  } ``` Catena returns the Driver **ELD ID** field. Sample **Create driver** Response Payload ```json {  "id": "2143" } ``` **TMS Field Updates** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Driver | ELD ID | Text(50) (External ID) | id | #### **Update Driver** The Update driver endpoint sends Driver record updates from the TMS through Catena. The payload is similar to the Create driver call, but is used when a record already exists and requires updating through Catena. Drivers are only updated to Catena when the **ELD Enabled** field is *Checked*. The Driver **Password** field is only included in payloads to Catena when first sending a new Driver record to Catena. When a Driver already exists in both Catena and the TMS, the **Password** field is never updated in either system based on a difference in one of the other. When the **Sync Active Drivers Only** field is *Checked*, only Drivers with an *Active* **Driver Activation Status** are sent to Catena. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Update driver | PATCH | 201: Success 400: Bad Request 500: Internal Server Error 503: Service Unavailable | TMS Fields sent in the **Update driver** call. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credential Card | Customer Number | | fleet_id | | Not a TMS record | From **Get fleet data** call | | axle_tsp_id | | Driver | Activation Status | Picklist | status | | Driver | CDL # | Text(50) | license.license_number | | Driver | CDL State/Province | Picklist | license.license_state | | Driver | Company/Division | Formula(Text) | carrier_name | | Driver | Cycle Override | Picklist | primary_cycle | | Driver | Driver Name | Text(80) | *first_name, last_name | | Driver | ELD Exempt | Checkbox | is_eld_exempt | | Driver | ELD Exempt Reason | Text Area(255) | eld_exempt_reason | | Driver | Personal Conveyance Duty Status | Checkbox | is_personal_conveyance_enabled | | Driver | Phone | Phone | phone | | Driver | Rest Break Override (or “None”) | Picklist | rest_break | | Driver | Restart Override (or “None”) | Picklist | restart | | Driver | Timezone | Picklist | timezone | | Driver | Yard Move Duty Status | Checkbox | is_yard_move_enabled | | Transportation Profile | US DOT Number | Text(10) | dot_number | *The **Driver Name** (First & Last) field can only update in Catena when all of the following fields match. If at least one field does not match, a duplicate match error is generated. - CDL # - CDL State/Province - Cycle Override - Rest Break Override - Restart Override - Timezone > [!WARNING] > Any invalid field value (for example a Cycle Override value) causes the driver update call to fail for that specific driver. This failure is included in the email sent by the Fleet Management job. Sample **Update driver** Request Payload ```json  "fleet_id": 20696,  "axle_tsp_id": 25,  "override_duplicates": false,  "carrier_name": "Test Carrier Fleet",  "dot_number": 123456789012,  "first_name": "Bill",  "last_name": "Driver",  "phone": "5558234327",  "email": "",  "status": "active",  "created_at_time": "2025-01-21T14:34:30.711295Z",  "timezone": "Eastern Time (US & Canada)",  "notes": "From TMS- Username: bdriver2",  "carrier": {    "carrier_name": "Fleet Carrier Two",    "dot_number": 3949562,   },  "license": {    "license_number": "E1834567",    "license_state": "CA",    "license_country": "USA"  },  "work_rules": {    "break": "Property (off-duty/sleeper)",    "cycle": "USA Passenger (7/60)",    "jurisdiction": "",    "restart": "72-hour Restart",    "shift": "US Interstate Passenger"  },  "is_eld_exempt": false,  "is_yard_move_enabled": false,  "is_personal_conveyance_enabled": false  } ``` Sample **Update driver** Response Payload ```json {  "message": "Updated successfully" } ``` **No TMS Field Updates** #### Get HOS Availability The **Get Hours of Service (HOS) availability** endpoint returns Driver availability information from the ELD Provider. All active Drivers with a record through Catena to the ELD Provider have HOS values returned. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get Hours of Service (HOS) availability | GET | 200: Success 400: Bad Request 500: Internal Server Error | Fleet Driver IDs are sent to the **Get Hours of Service (HOS) availability** endpoint in the request. Sample **Get Hours of Service (HOS) availability** Response Payload ```json {  "hos_availability": [    {      "fleet_id": 2354,      "time": "2020-01-27T07:06:25.000Z",      "tsp_source": "motive",      "driver_id": 123,      "name": "Susan Smith",      "available_time": {        "cycle_seconds": 214800,        "shift_seconds": 49200,        "drive_seconds": 39600,        "break_seconds": 27600      }    }  ], } ``` **TMS Field Updates** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Driver | Cycle Time Remaining | Number(3, 2) | available_time.cycle_seconds | | Driver | Drive Time Remaining | Number(3, 2) | available_time.drive_seconds | | Driver | Shift Time Remaining | Number(3, 2) | available_time.shift_seconds | | Driver | Time Until Break | Number(3, 2) | available_time.break_seconds | #### **Get HOS Logs** The **Get Hours of Service (HOS) logs** endpoint returns Log and Log Entry records. All active Drivers with a record through Catena to the ELD Provider have HOS Logs return. The **Sync Active Drivers Only** field does not control Driver HOS Logs. TMS Driver HOS Logs continue to sync to the TMS when the TMS Driver record **Driver Activation Status** is set to *Deactivated*. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get Hours of Service (HOS) logs | GET | 200: Success 400: Bad Request 500: Internal Server Error | Fleet Driver IDs, a start date, and end date are sent to the **Get Hours of Service (HOS) logs** endpoint in the request. The start and end date is determined by the **Driver Log Grace Period** field set under TMS Admin → Configuration, [Fleet Management](/v1/docs/fleet-management-3). Driver Log records are named as Driver Name + Log Date. The Log Date is returned from Catena in the response. Log Events are also requested and populate as Log Entry records. > [!NOTE] > Driver Log records are never created for the current day. Driver Log and Log Entry records are returned and created in the TMS. If they match an existing Driver **ELD ID**, **Start Time**, and **End Time** fields, the Log or Log Entry is updated. When matched to an existing record, a new Log or Log Entry is not created. A Driver Log Entry record is created for each Event returned from Catena. See a list of Catena-provided Events in the table below. > [!WARNING] > HOS Log errors do not appear in any Fleet Management emails. If calls to the Hours of Service logs endpoint fail, HOS log information does not update. Review HOS log information to confirm the job is returning information correctly. Sample **Get Hours of Service (HOS) logs** Response Payload ```json {  "hos_logs": [    {      "id": 14322,      "fleet_id": 2354,      "time": "2020-01-27T07:06:25.000Z",      "tsp_source": "motive",      "driver_id": 123,      "name": "Susan Smith",      "date": "2020-01-27",      "work_rules": {        "break": "Property (off-duty/sleeper)",        "cycle": "USA 60 hour / 7 day",        "jurisdiction": "AR",        "restart": "34-hour Restart",        "shift": "US Interstate Property",        "deferral": "Day 1"      },      "exemptions": {        "adverse_driving": false,        "short_haul": false,        "wait_time": false,        "restart_24_hour": false,        "break_8_hour": false      },      "hours_of_service": {        "date": "2020-01-27",        "off_duty_seconds": 43200,        "on_duty_seconds": 7200,        "sleeper_seconds": 0,        "driving_seconds": 21600,        "waiting_seconds": 0,        "active_seconds": 7200,        "personal_conveyance_seconds": 0,        "yard_move_seconds": 0,        "deferral_seconds": 0      },      "distance": {        "drive_distance": {          "value": 300,          "unit": "miles"        },        "personal_conveyance_distance": {          "value": 0,          "unit": "m"        },        "yard_move_distance": {          "value": 0,          "unit": "m"        }      },      "certified": true,      "certified_time": "2020-01-27T07:06:25.000Z",      "shipping_docs": "Delivery to warehouse 10",      "events": [        {          "id": 26462,          "type": "driving",          "notes": "Going to warehouse",          "location": {            "latitude": 123.456,            "longitude": 37.459,            "address": "1234 Main St, San Jose, CA"          },          "start_time": "2020-01-26T19:08:25.000Z",          "end_time": "2020-01-26T19:38:25.000Z",          "deferral_seconds": 0,          "vehicle": {            "id": 103,            "oem": "Freightliner",            "model": "Cascadia",            "model_year": "2018",            "vin": "3AKJHHDR9JSJV5535"          },          "co_driver": {            "id": 621,            "name": "Sammy Simpson"          }        }      ],      "vehicles": [        {          "id": 103,          "oem": "Freightliner",          "model": "Cascadia",          "model_year": "2018",          "vin": "3AKJHHDR9JSJV5535"        }      ],      "trailer_info": null,      "co_drivers": [        {          "id": 621,          "name": "Sammy Simpson"        }      ]    }  ], } ``` **TMS Field Updates** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Driver Log | Active Duration | Number(10, 2) | hours_of_service.active_seconds | | Driver Log | Adverse Driving Exemption Claimed | Checkbox | exemptions.adverse_driving | | Driver Log | Certification Status | Picklist | certified | | Driver Log | Certified as of | Date/Time | certified_time | | Driver Log | Driver Log Name | Text(80) | name + date | | Driver Log | Driving Distance (Kilometers) | Number(10, 3) | distance.drive_distance.value, distance.drive_distance.unit | | Driver Log | Driving Distance (Miles) | Number(10, 3) | distance.drive_distance.value, distance.drive_distance.unit | | Driver Log | Driving Duration | Number(10, 2) | hourse_of_service.driving_seconds | | Driver Log | End Time | Date/Time | TMS sets to 23:59:59 | | Driver Log | Off Duty Duration | Number(10, 2) | hours_of_service.off_duty_seconds | | Driver Log | On Duty Duration | Number(10, 2) | hours_of_service.on_duty_seconds | | Driver Log | Personal Conveyance Distance (Kilometers) | Number(10, 3) | distance.personal_conveyance_distance.value, distance.personal_conveyance_distance.unit | | Driver Log | Personal Conveyance Distance (Miles) | Number(10, 3) | distance.personal_conveyance_distance.value, distance.personal_conveyance_distance.unit | | Driver Log | Personal Conveyance Duration | Number(10, 2) | hours_of_service.personal_conveyance_seconds | | Driver Log | Short Haul Exemption Active | Checkbox | exemptions.short_haul | | Driver Log | Sleeper Berth Duration | Number(10, 2) | hours_of_service.sleeper_seconds | | Driver Log | Start Time | Date/Time | TMS sets to 00:00:00 | | Driver Log | Waiting Time Duration | Number(10, 2) | hours_of_service.waiting_seconds | | Driver Log | Yard Move Distance (Kilometers) | Number(10, 3) | distance.yard_move_distance.value, distance.yard_move_distance.unit | | Driver Log | Yard Move Distance (Miles) | Number(10, 3) | distance.yard_move_distance.value, distance.yard_move_distance.unit | | Driver Log | Yard Move Duration | Number(10, 2) | hours_of_service.yard_move_seconds | | Driver Log Entry | Comments | Text Area(255) | event.notes | | Driver Log Entry | Duration (Hours) | Number(10, 2) | events.start_time, events.end_time | | Driver Log Entry | End Time | Date/Time | events.end_time | | Driver Log Entry | Geolocation | Geolocation | event.location.latitude, event.location.longitude | | Driver Log Entry | Start Time | Date/Time | events.start_time | | Driver Log Entry | Status | Picklist | event.type | **Catena Events to TMS Log Entry Status Table** | Catena Event Type | TMS Driver Log Entry Status | | --- | --- | | driving | Driving | | onDuty | On Duty Not Driving | | offDuty | Off Duty | | personalConveyance | Personal Conveyance | | sleeperBed | Sleeper Berth | | yardMove | Yard Move | | Any other value | No Status | ### **Service** The TMS calls the Service endpoint to receive all Catena-supported Hours of Service cycle rule values. #### **Get Hours of Service Cycles** The call to the Get HOS cycle map endpoint retrieves the list of Hours of Service cycle rule values for each linked ELD Provider. The TMS matches the returned values to the Driver **Cycle Override** field picklist values. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Get HOS cycle map | GET | 201: Success 400: Bad Request 401: Unauthorized 403: Forbidden | Any HOS cycle map values that do not match to existing values in the **Cycle Override** field are matched to the *Unrecognized Value from API* value. When Driver records are synced with Catena ([Create](/v1/docs/catena-eld-aggregator#create-driver) or [Update Driver](/v1/docs/catena-eld-aggregator#update-driver)), the **Cycle Override** *Unrecognized Value from API* value is not sent to Catena. Picklist values may be manually added to the **Cycle Override** field to match values received from Catena and replace the *Unrecognized Value from API* value. Complete the following steps to update Driver records that are created in the TMS with the *Unrecognized Value from API* value. 1. Find the desired Driver record(s) that have the **Cycle Override** *Unrecognized Value from API* value. 2. Identify the Catena value that is not recognized. Refer to Catena or ELD Provider information. 3. Navigate to **Setup → Object Manager** and select the Driver object. 4. Choose the **Cycle Override** field and find the *Values* section. 5. Click the **New** button and add the missing value(s). Click **Save**. 6. Return to the Driver record(s). Manually select the new picklist value and click **Save**. 7. Any new Drivers created after the picklist value is added are set automatically when the Driver records are created. Sample **Get HOS cycle map** Response Payload ```json {  "tsp_name": "eroad",  "cycle_map": {    "112-hour/8-day": "California Farm (8/112)",    "60-hour/7-day": "Oklahoma (7/60)",    "70-hour/7-day": "Oregon (7/70)",    "70-hour/8-day": "USA Property (8/70)",    "80-hour/8-day": "Oregon (8/80)"  } } ``` **No TMS Field Updates** ### **Trip** The TMS calls the Trip endpoints to send trip/route information to the ELD Provider through Catena. If the **Create ELD Trip on Dispatch** field is *Checked*, Trips are sent to the ELD Provider when the user/dispatcher clicks the **Dispatch** button. When **Create ELD Trip on Dispatch** is *Unchecked*, Trips are sent to the ELD Provider when the user/dispatcher sets the **Driver Confirmation Status** to *Accepted* or when the Driver accepts the Trip via the [Fleet Email Loop](/v1/docs/email-loop-setup#fleet-guest-access). The Catena Trip endpoints do not allow for sending and receiving Driver confirmation. > [!WARNING] > The Revenova integration with Catena supports creating and sending trip/routing information. However, confirm that the specific ELD Provider includes support for receiving trip/Routing information through Catena. *Check* the **Disable ELD Dispatch** field on TMS Admin → [Configuration](/v1/docs/fleet-management-3) if the specific ELD Provider does not support Trips. #### **Create a New Trip** The call to the Create a new trip endpoint sends the route information through Catena to the ELD Provider. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | - Segment **Driver Confirmation Status** set to *Accepted* OR - **Dispatch** button on the [Trip Planner](/v1/docs/trip-planning#trip-plan-segments). | Create a new trip | POST | 201: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | The actions completed for a Trip Plan are sent to the ELD Provider as activities. Stop actions include starting or ending trips and what to do with the cargo. Each **Create a new trip** payload sends the Stop action information in the activity_sequence and activity_type values. The values included in the Activity are based on the Leg type on the Trip Plan Leg. - *Start Trip* is sent when the Stop on the first Trip Plan Leg. - *End Trip* is sent when the Stop on the last Trip Plan Leg. The Fleet Asset (Trailer) action and **Cargo Status** on the Trip Plan Leg also create Activities. - *Pickup*/*Hooked*/*Dropoff* - *Empty*/*Live Load*/*Loaded* - *Load Stop* is sent when no action or **Cargo Status** is included on the Trip Plan Leg. - *Other* is sent in all other scenarios. Multiple Activities may be included for a single Stop or multiple Fleet Assets are included on the same Trip Plan Leg. See examples of Stop Activities in the sample **Create a new trip** Request Payload provided below. Trip Plan Segments that have Trip Plan Legs with consecutive End Stops/Locations with the same location may be consolidated. *Check* the **Consolidate Same Locations When Routing** field on the Trip Plan Segment to prevent arrival and departure issues for pickups and deliveries at a single location. > [!WARNING] > When multiple pickup and/or delivery events occur at a single location, this information is not included in the call to Catena. *Users must inform Drivers that multiple pickup/delivery events occur at a single location.* TMS Fields sent in the **Create a new trip** call. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credential Card | Customer Number | | fleet_id | | Not a TMS record | From **Get fleet data** call | | axle_tsp_id | | Not a TMS record | “false” or “true” | | is_dispatched | | Not a TMS record | “false” or “true” | | is_published | | Not a TMS record | “1” | | trip_sequence | | Not a TMS record | “Revenova” | | trip_source | | Not a TMS record | “Pending,” “Dispatched,” or “Cancelled” | | tsp_trip_status | | Driver | ELD ID | Text(50) (External ID) | assigned_driver_id | | Fleet Asset | ELD ID | Text(50) (External ID) | assigned_vehicle_id | | Load | Cargo Summary | Long Text Area(1500) | instructions | | Load | Load Number | Text(80) | reference_key | | Stop | Instructions | Long Text Area(2000) | stops.instructions | | Trip Plan Leg | Appointment Start Time | Time | *scheduled_arrival | | Trip Plan Leg | Arrival Date/Time | Date/Time | actual_arrival | | Trip Plan Leg | Departure Date/Time | Date/Time | actual_departure | | Trip Plan Leg | Due Out Date | Date | **scheduled_departure | | Trip Plan Leg | End Location (Name) | Lookup(Account) | address_name, client_name | | Trip Plan Leg | End Location (Shipping Address) | Lookup(Account) | address, street, street_2, city, province, postal_code, country, latitude, longitude | | Trip Plan Leg | End Type | Picklist | stop_type | | Trip Plan Leg | ETA Date, ETA Time | Date, Time | estimated_arrival | | Trip Plan Leg | Leg Number | Number(3, 0) | stop_sequence | | Trip Plan Segment | Distance (Miles) | Roll-Up Summary (SUM Trip Plan Leg) | distance | | Trip Plan Segment | SFID | SFID | trip_key | Trip Plan Segments do not begin with a scheduled arrival date and do not end with a scheduled departure date. *A scheduled_arrival value is only sent when the Trip Plan Leg **Start Location** is a Start Stop and an **End Location** Stop on the previous Trip Plan Leg. **A scheduled_departure value is only sent when the Trip Plan Leg **End Location** is an End Stop and the **Start Location** Stop on the following Trip Plan Leg. Sample **Create a New Trip** Request Payload ```json {  "fleet_id": 65542,  "axle_tsp_id": 55924,  "trip_source": "Revenova",  "trip_key": "a2vNq000004FFyvIAG",  "reference_key": "L-12",  "is_published": true,  "is_dispatched": true,  "started_at": "2025-10-07T11:00:00Z",  "completed_at": "2025-10-14T20:30:00Z",  "instructions": "14 Pallets (48.00x48.00x48.00 in), Mixed Cargo, 9850 lbs",  "assigned_driver_id": "4426661",  "distance": 1861.283,  "stops": [    {      "stop_sequence": 1,      "stop_type": "Terminal",      "client_name": "Illinois Terminal",      "scheduled_departure": "2025-10-07T11:00:00Z",      "latitude": 41.589496,      "longitude": -87.665631,      "street": "2900 166th St",      "city": "Markham",      "province": "IL",      "postal_code": "60428",      "country": "US",      "timezone": "America/Chicago",      "activities": [        {          "activity_sequence": 1,          "activity_type": "Start Trip"        }      ]    },    {      "stop_sequence": 2,      "stop_type": "Load Stop",      "client_name": "Revenova HQ",      "instructions": "Pickup Instructions",      "scheduled_arrival": "2025-10-09T14:30:00Z",      "latitude": 42.19565,      "longitude": -87.859529,      "street": "2333 Waukegan Rd.",      "city": "Bannockburn",      "province": "IL",      "postal_code": "60015",      "country": "US",      "timezone": "America/Chicago",      "activities": [        {          "activity_sequence": 1,          "activity_type": "Pickup - Live Load"        }      ]    },    {      "stop_sequence": 3,      "stop_type": "Load Stop",      "client_name": "Denver Deli Meats",      "instructions": "Delivery Instructions",      "scheduled_arrival": "2025-10-12T20:30:00Z",      "latitude": 39.739173,      "longitude": -104.99565,      "street": "1435 Fox St.",      "city": "Denver",      "province": "CO",      "postal_code": "80204",      "country": "US",      "timezone": "America/Denver",      "activities": [        {          "activity_sequence": 1,          "activity_type": "Dropoff - Loaded"        },        {          "activity_sequence": 2,          "activity_type": "Pickup - Empty"        }      ]    },    {      "stop_sequence": 4,      "stop_type": "Terminal",      "client_name": "Missouri Terminal",      "scheduled_arrival": "2025-10-14T20:30:00Z",      "latitude": 37.557666,      "longitude": -92.789626,      "street": "327 Pine St",      "city": "Phillipsburg",      "province": "MO",      "postal_code": "65722",      "country": "US",      "timezone": "America/Chicago",      "activities": [        {          "activity_sequence": 1,          "activity_type": "End Trip"        },        {          "activity_sequence": 2,          "activity_type": "Dropoff - Empty"        },        {          "activity_sequence": 3,          "activity_type": "Hooked - Loaded"        }      ]    }  ] } ``` Sample **Create a New Trip** Response Payload ```json {  "id": "c8815ab8-0935-41f6-b1a4-706ffeaad987",  "trip": {    "id": "c8815ab8-0935-41f6-b1a4-706ffeaad987",    "tsp_trip_id": "7037236978",    "trip_key": "a2vNq000004Fz45IAC",    "reference_key": "L-17",    "tsp_trip_status": "",    "is_published": true,    "is_dispatched": true,    "started_at": "2025-10-16T11:00:00Z",    "completed_at": "2025-10-17T03:12:23Z",    "distance": 1067.461,    "stops": [      {        "id": "",        "tsp_stop_id": "7194794235",        "stop_sequence": 1,        "stop_type": "Terminal",        "tsp_stop_status": "scheduled",        "address_city": "Markham",        "activities": [          {            "id": "",            "tsp_activity_id": "",            "activity_type": "Start Trip",            "activity_sequence": 1,            "tsp_activity_status": ""          }        ]      },      {        "id": "",        "tsp_stop_id": "7194794236",        "stop_sequence": 2,        "stop_type": "Load Stop",        "tsp_stop_status": "scheduled",        "address_city": "Bannockburn",        "scheduled_arrival": "2025-10-16T12:01:01Z",        "activities": [          {            "id": "",            "tsp_activity_id": "",            "activity_type": "Load Stop",            "activity_sequence": 1,            "tsp_activity_status": ""          }        ]      },      {        "id": "",        "tsp_stop_id": "7194794237",        "stop_sequence": 3,        "stop_type": "Load Stop",        "tsp_stop_status": "scheduled",        "address_city": "Denver",        "scheduled_arrival": "2025-10-17T03:12:23Z",        "activities": [          {            "id": "",            "tsp_activity_id": "",            "activity_type": "End Trip",            "activity_sequence": 1,            "tsp_activity_status": ""          }        ]      }    ]  } } ``` The Trip Id and the created Trip values are returned in the response. TMS field updates returned from the **Create a new trip** call. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Trip Plan Segment | ELD Trip Id | Text(40) (External ID) | Id | #### **Update an existing trip** The Update an existing trip endpoint is called to send new Trip information for an updated Trip Plan Segment. This end point is used for existing Trips that require changes. Click the **ReDispatch** button or **Resent Trip to ELD** button on the Trip Plan Segment to send updated Trip information to the ELD Provider. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | - **Resend Trip to ELD** button on the [Trip Planner](/v1/docs/trip-planning#trip-plan-segments). - **ReDispatch** button on the [Trip Planner](/v1/docs/trip-planning#trip-plan-segments). | Update an existing trip | PATCH | 200: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | > [!WARNING] > Some ELD Providers do not allow updating a Trip once dispatched to the driver. A Toast Message displays whether the trip was updated successfully. The actions completed for a Trip Plan are sent to the ELD Provider as activities. Stop actions include starting or ending trips and what to do with the cargo. Each **Update an existing** **trip** payload sends the Stop action information in the activity_sequence and activity_type values. The values included in the Activity are based on the Leg type on the Trip Plan Leg. - *Start Trip* is sent when the Stop is on the first Trip Plan Leg. - *End Trip* is sent when the Stop is on the last Trip Plan Leg. The Fleet Asset (Trailer) action and **Cargo Status** on the Trip Plan Leg also create Activities. - *Pickup*/*Hooked*/*Dropoff* - *Empty*/*Live Load*/*Loaded* - *Load Stop* is sent when no action or **Cargo Status** is included on the Trip Plan Leg. - *Other* is sent in all other scenarios. Multiple Activities may be included for a single Stop or multiple Fleet Assets are included on the same Trip Plan Leg. See examples of Stop Activities in the sample **Create a new trip** Request Payload provided below. TMS Fields sent in the **Update an Existing Trip** call. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credential Card | Customer Number | | fleet_id | | Not a TMS record | From **Get fleet data** call | | axle_tsp_id | | Not a TMS record | “false” or “true” | | is_dispatched | | Not a TMS record | “false” or “true” | | is_published | | Not a TMS record | “1” | | trip_sequence | | Not a TMS record | “Revenova” | | trip_source | | Not a TMS record | “Pending,” “Dispatched,” or “Cancelled” | | tsp_trip_status | | Driver | ELD ID | Text(50) (External ID) | assigned_driver_id | | Fleet Asset | ELD ID | Text(50) (External ID) | assigned_vehicle_id | | Load | Cargo Summary | Long Text Area(1500) | instructions | | Load | Load Number | Text(80) | reference_key | | Stop | Instructions | Long Text Area(2000) | stop.instructions | | Trip Plan Leg | Appointment Start Time | Time | *scheduled_arrival | | Trip Plan Leg | Arrival Date/Time | Date/Time | actual_arrival | | Trip Plan Leg | Departure Date/Time | Date/Time | actual_departure | | Trip Plan Leg | Due Out Date | Date | **scheduled_departure | | Trip Plan Leg | End Location (Name) | Lookup(Account) | address_name, client_name | | Trip Plan Leg | End Location (Shipping Address) | Lookup(Account) | address, street, street_2, city, province, postal_code, country, latitude, longitude | | Trip Plan Leg | End Type | Picklist | stop_type | | Trip Plan Leg | ETA Date, ETA Time | Date, Time | estimated_arrival | | Trip Plan Leg | Leg Number | Number(3, 0) | stop_sequence | | Trip Plan Segment | Distance (Miles) | Roll-Up Summary (SUM Trip Plan Leg) | distance | | Trip Plan Segment | SFID | SFID | trip_key | Trip Plan Segments do not begin with a scheduled arrival date and do not end with a scheduled departure date. *A scheduled_arrival value is only sent when the Trip Plan Leg **Start Location** is a Start Stop and an **End Location** Stop on the previous Trip Plan Leg. **A scheduled_departure value is only sent when the Trip Plan Leg **End Location** is an End Stop and the **Start Location** Stop on the following Trip Plan Leg. Sample **Update an Existing Trip** Request Payload ```json {  "fleet_id": 65542,  "axle_tsp_id": 55924,  "trip_source": "Revenova",  "trip_key": "a2vNq000004GGrJIAW",  "reference_key": "L-16",  "is_published": true,  "is_dispatched": true,  "started_at": "2025-10-15T11:30:00Z",  "completed_at": "2025-10-18T23:15:00Z",  "instructions": "14 Pallets (48.00x48.00x48.00 in), Mixed Cargo, 9850 lbs",  "assigned_driver_id": "4389217",  "distance": 1504.718,  "stops": [    {      "stop_sequence": 1,      "stop_type": "Terminal",      "client_name": "Missouri Terminal",      "scheduled_departure": "2025-10-15T11:30:00Z",      "latitude": 37.557666,      "longitude": -92.789626,      "street": "327 Pine St",      "city": "Phillipsburg",      "province": "MO",      "postal_code": "65722",      "country": "US",      "timezone": "America/Chicago",      "activities": [        {          "activity_sequence": 1,          "activity_type": "Start Trip"        }      ]    },    {      "stop_sequence": 2,      "stop_type": "Load Stop",      "client_name": "Revenova HQ",      "instructions": "Pickup Instructions",      "scheduled_arrival": "2025-10-15T21:45:00Z",      "latitude": 42.19565,      "longitude": -87.859529,      "street": "2333 Waukegan Rd.",      "city": "Bannockburn",      "province": "IL",      "postal_code": "60015",      "country": "US",      "timezone": "America/Chicago",      "activities": [        {          "activity_sequence": 1,          "activity_type": "Pickup - Loaded"        }      ]    },    {      "stop_sequence": 3,      "stop_type": "Load Stop",      "client_name": "Denver Deli Meats",      "instructions": "Delivery Instructions",      "scheduled_arrival": "2025-10-18T23:15:00Z",      "latitude": 39.739173,      "longitude": -104.99565,      "street": "1435 Fox St.",      "city": "Denver",      "province": "CO",      "postal_code": "80204",      "country": "US",      "timezone": "America/Denver",      "activities": [        {          "activity_sequence": 1,          "activity_type": "End Trip"        },        {          "activity_sequence": 2,          "activity_type": "Dropoff - Live Unload"        }      ]    }  ] } ``` Sample **Update an Existing Trip** Response Payload ```json {  "id": "6d66820f-66a8-48c4-9d8c-8e1d19133485",  "trip": {    "id": "6d66820f-66a8-48c4-9d8c-8e1d19133485",    "tsp_trip_id": "7037233047",    "trip_key": "a2vNq000004GGrJIAW",    "reference_key": "L-16",    "tsp_trip_status": "",    "is_published": true,    "is_dispatched": true,    "started_at": "2025-10-15T11:30:00Z",    "completed_at": "2025-10-16T10:23:51Z",    "distance": 1504.718,    "stops": [      {        "id": "",        "tsp_stop_id": "7194772598",        "stop_sequence": 1,        "stop_type": "Terminal",        "tsp_stop_status": "scheduled",        "address_city": "Phillipsburg",        "activities": [          {            "id": "",            "tsp_activity_id": "",            "activity_type": "Start Trip",            "activity_sequence": 1,            "tsp_activity_status": ""          }        ]      },      {        "id": "",        "tsp_stop_id": "7194772599",        "stop_sequence": 2,        "stop_type": "Load Stop",        "tsp_stop_status": "scheduled",        "address_city": "Bannockburn",        "scheduled_arrival": "2025-10-15T19:12:29Z",        "activities": [          {            "id": "",            "tsp_activity_id": "",            "activity_type": "Pickup - Loaded",            "activity_sequence": 1,            "tsp_activity_status": ""          }        ]      },      {        "id": "",        "tsp_stop_id": "7194773600",        "stop_sequence": 3,        "stop_type": "Load Stop",        "tsp_stop_status": "scheduled",        "address_city": "Denver",        "scheduled_arrival": "2025-10-16T10:23:51Z",        "activities": [          {            "id": "",            "tsp_activity_id": "",            "activity_type": "End Trip",            "activity_sequence": 1,            "tsp_activity_status": ""          },          {            "id": "",            "tsp_activity_id": "",            "activity_type": "Dropoff - Live Unload",            "activity_sequence": 2,            "tsp_activity_status": ""          }        ]      }    ]  } } ``` The Trip Id and the updated Trip values are returned in the response. No TMS field updates from the **Update an Existing Trip** call. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Trip Plan Segment | ELD Trip Id | Text(40) (External ID) | Id | #### **Delete Trip** The Catena Delete Trip endpoint is called remove the Trip information from the ELD Provider. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | - **Undispatch** button on the [Trip Planner](/v1/docs/trip-planning#trip-plan-segments). - Segment **Driver Confirmation Status** changed from *Accepted* to *Pending* or *Declined.* | Delete a trip | DELETE | 201: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | TMS Fields sent in the **Delete trip** call. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Trip Plan Segment | ELD Trip Id | Text(40) (External ID) | Id | Sample **Delete Trip** Request Payload ```json { "id": "1032b069-c26d-4718-b258-51a" } ``` Sample **Delete Trip** Response Payload ```json { "message":"Trip Deleted" } ``` **No TMS field updates.** ### **Vehicle** The TMS calls one Vehicle endpoint to confirm Vehicle/Fleet Asset records are synced between the TMS and the ELD Provider through Catena. #### **Update vehicle** > [!WARNING] > Use caution when updating Fleet Asset records in the TMS. Once sent to Catena, Fleet Asset records cannot be deleted in the ELD Provider. Changing the Fleet Asset **Name** or **License Plate Number** field in the TMS updates that Fleet Asset in Catena/the ELD Provider. The **Update vehicle** endpoint is called when there are Vehicle/Fleet Asset record differences between Catena and the TMS. The Fleet Asset **Name** and/or **License Plate Number** fields are sent to Catena to update records. These two Vehicle fields are the only updates the TMS sends through Catena. - When **Sync Active Fleet Assets Only** is *Checked*, only active Fleet Asset records are sent to Catena to update. - When **Sync Active Fleet Assets Only** is *Unchecked*, all Fleet Asset records are sent to Catena to update. > [!WARNING] > Each Telematics Service Provider (ELD Provider) has unique record requirements and restrictions. Use caution with Fleet Asset **Name** or **License Plate Number** fields that may be sent through Catena to update records. For example, some ELD Provider services limit Name fields to a specific number of characters. TMS Fleet Asset record **Name** and **License Plate Number** fields typically allow for more characters. | TMS Operation | Catena Endpoint | Request Type | Response | | --- | --- | --- | --- | | Fleet Management Job 4 | Update vehicle | PATCH | 200: Success 400: Bad Request 401: Unauthorized 500: Internal Server Error | Sample **Update vehicle** Request Payload ```json {  "fleet_id": 8847,  "name": "T-9944",  "license_plate_number": "JPP1968 " } ``` **TMS Fields Sent** | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Fleet Asset | Fleet Asset Name | Text(80) | name | | Fleet Asset | License Plate Number | Text(20) | license_plate_number | Sample **Update vehicle** Response Payload ```json {  "message": "Updated successfully" } ``` **No TMS Field Updates** ## **Field Reference Table** The following table relates TMS fields with the equivalent Catena fields included in Catena API calls. | Object | Field | Type | Catena Field | | --- | --- | --- | --- | | Catena Credentials Card | Customer Number | | fleet_id | | Not a TMS record | From **Get fleet data** call | | axle_tsp_id | | Not a TMS record | “false” or “true” | | is_dispatched | | Not a TMS record | “false” or “true” | | is_published | | Not a TMS record | “1” | | trip_sequence | | Not a TMS record | “Revenova” | | trip_source | | Not a TMS record | “Pending,” “Dispatched,” or “Cancelled” | | tsp_trip_status | | Account | SFID | SFID | fleet_code | | Contact | Account Name | Lookup(Account) | Company/Division ID | | Contact | Name | Name | details.name | | Contact | Transportation Role | Picklist (Multi-Select) | TMS sets to *Driver* | | Driver | Activation Status | Picklist | status | | Driver | CDL # | Text(50) | details.license.license_number | | Driver | CDL State/Province | Picklist | details.license.license_state | | Driver | Company/Division | Formula(Text) | carrier_name | | Driver | Contact | Lookup(Contact) | details.name | | Driver | Cycle Override | Picklist | details.work_rules.cycle | | Driver | Cycle Time Remaining | Number(3, 2) | available_time.cycle_seconds | | Driver | Drive Time Remaining | Number(3, 2) | available_time.drive_seconds | | Driver | Driver Name | Text(80) | details.name | | Driver | ELD Brand | Picklist | details.tsp_source | | Driver | ELD Enabled | Checkbox | TMS sets to *Checked* | | Driver | ELD Exempt | Checkbox | is_eld_exempt | | Driver | ELD Exempt Reason | Text Area(255) | eld_exempt_reason | | Driver | ELD ID | Text(50) (External ID) | details.id, assigned_driver_id | | Driver | Driver Name | Text(80) | first_name, last_name | | Driver | Password | Text (Encrypted)(50) | password | | Driver | Personal Conveyance Duty Status | Checkbox | is_personal_conveyance_enabled | | Driver | Phone | Phone | details.phone | | Driver | Rest Break Override | Picklist | details.work_rules.break | | Driver | Restart Override | Picklist | details.work_rules.restart | | Driver | Shift Time Remaining | Number(3, 2) | available_time.shift_seconds | | Driver | Time Until Break | Number(3, 2) | available_time.break_seconds | | Driver | Timezone | Picklist | details.timezone | | Driver | Type | Picklist | *Employee* or *Independent Contractor* | | Driver | Username | Text(50) | details.notes, details.username | | Driver | Yard Move Duty Status | Checkbox | is_yard_move_enabled | | Driver Log | Active Duration | Number(10, 2) | hours_of_service.active_seconds | | Driver Log | Adverse Driving Exemption Claimed | Checkbox | exemptions.adverse_driving | | Driver Log | Certification Status | Picklist | certified | | Driver Log | Certified as of | Date/Time | certified_time | | Driver Log | Driving Distance (Kilometers) | Number(10, 3) | distance.drive_distance.value, distance.drive_distance.unit | | Driver Log | Driving Distance (Miles) | Number(10, 3) | distance.drive_distance.value, distance.drive_distance.unit | | Driver Log | Driving Duration | Number(10, 2) | hours_of_service.driving_seconds | | Driver Log | End Time | Date/Time | events.end_time | | Driver Log | Off Duty Duration | Number(10, 2) | hours_of_service.off_duty_seconds | | Driver Log | On Duty Duration | Number(10, 2) | hours_of_service.on_duty_seconds | | Driver Log | Personal Conveyance Distance (Kilometers) | Number(10, 3) | distance.personal_conveyance_distance.value, distance.personal_conveyance_distance.value | | Driver Log | Personal Conveyance Distance (Miles) | Number(10, 3) | distance.personal_conveyance_distance.value, distance.personal_conveyance_distance.value | | Driver Log | Personal Conveyance Duration | Number(10, 2) | hours_of_service.personal_conveyance_seconds | | Driver Log | Short Haul Exemption Active | Checkbox | exemptions.short_haul | | Driver Log | Sleeper Berth Duration | Number(10, 2) | hours_of_service.sleeper_seconds | | Driver Log | Start Time | Date/Time | events.start_time | | Driver Log | Waiting Time Duration | Number(10, 2) | hours_of_service.waiting_seconds | | Driver Log | Yard Move Distance (Kilometers) | Number(10, 3) | distance.yard_move_distance.value, distance.yard_move_distance.unit | | Driver Log | Yard Move Distance (Miles) | Number(10, 3) | distance.yard_move_distance.value, distance.yard_move_distance.unit | | Driver Log | Yard Move Duration | Number(10, 2) | hours_of_service.yard_move_seconds | | Driver Log Entry | Comments | Text Area(255) | event.notes | | Driver Log Entry | Duration (Hours) | Number(10, 2) | events.start_time, events.end_time | | Driver Log Entry | End Time | Date/Time | events.end_time | | Driver Log Entry | Geolocation | Geolocation | event.location.latitude, event.location.longitude | | Driver Log Entry | Start Time | Date/Time | events.start_time | | Driver Log Entry | Status | Picklist | event.type | | Fleet Asset | Current Location | Text(200) | vehicle_locations.address | | Fleet Asset | ELD ID | Text(50) (External ID) | detail.id, assigned_vehicle_id | | Fleet Asset | ELD Last Update | Date/Time | vehicle_locations.date_time | | Fleet Asset | ELD Serial Number | Text(50) | detail.eld_device_id | | Fleet Asset | Fleet Asset Name | Text(80) | detail.name | | Fleet Asset | Fuel Percent Remaining | Number(3, 0) | vehicle_locations.fuel | | Fleet Asset | Geolocation | Geolocation | vehicle_locations.latitude, vehicle_locations.longitude | | Fleet Asset | Last Odometer Reading | Number(18, 0) | vehicle_locations.odometer | | Fleet Asset | License Plate Number | Text(20) | detail.license_plate_number | | Fleet Asset | Speed (kph) | Number(10, 2) | vehicle_locations.speed.value | | Fleet Asset | Speed (mph) | Number(10, 2) | vehicle_locations.speed.value | | Fleet Asset | Status | Picklist | TMS sets to *Available* | | Fleet Asset | Type | Picklist | TMS sets to *Tractor* | | Fleet Asset | Vehicle Make | Picklist | detail.oem | | Fleet Asset | Vehicle Model | Picklist | detail.model | | Fleet Asset | VIN | Text(50) (External ID) | detail.vin | | Fleet Asset | Year | Text(4) | detail.model_year | | Load | Cargo Summary | Long Text Area(1500) | instructions | | Load | Load Number | Text(80) | reference_key | | Stop | Instructions | Long Text Area(2000) | instructions | | Transportation Profile | US DOT Number | Text(10) | dot_number | | Trip Plan Leg | Appointment Start Time | Time | *scheduled_arrival | | Trip Plan Leg | Arrival Date/Time | Date/Time | actual_arrival | | Trip Plan Leg | Departure Date/Time | Date/Time | actual_departure | | Trip Plan Leg | Due Out Date | Date | **scheduled_departure | | Trip Plan Leg | End Location (Name) | Lookup(Account) | address_name, client_name | | Trip Plan Leg | End Location (Shipping Address) | Lookup(Account) | address, street, street_2, city, province, postal_code, country, latitude, longitude | | Trip Plan Leg | End Type | Picklist | stop_type | | Trip Plan Leg | ETA Date, ETA Time | Date, Time | estimated_arrival | | Trip Plan Leg | Leg Number | Number(3, 0) | stop_sequence | | Trip Plan Segment | Distance (Miles) | Roll-Up Summary (SUM Trip Plan Leg) | distance | | Trip Plan Segment | SFID | SFID | trip_key | **Catena Restart Override Codes** | Catena Accepted Restart Override Codes | | --- | | 24-hour Restart | | 34-hour Restart | | 36-hour Restart | | 72-hour Restart | **Catena Events to TMS Log Entry Status Table** | Catena Event Type | TMS Driver Log Entry Status | | --- | --- | | driving | Driving | | onDuty | On Duty Not Driving | | offDuty | Off Duty | | personalConveyance | Personal Conveyance | | sleeperBed | Sleeper Berth | | yardMove | Yard Move | | Any other value | No Status | **Cycle Override Value Mapping** | Catena Value | TMS Cycle Override Picklist Option | | --- | --- | | USA 70 hour / 8 day | USA Property (8/70) | | USA 60 hour / 7 day | USA Property (7/60) | | 70-hour/8-day | USA Property (8/70) | | 60-hour/7-day | USA Property (7/60) | | Any other value | Unrecognized Value from API | The Salesforce ID, a record identifier comprised of 15 or 18 characters. ![](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Glossary/Toast%20Message%20-%20Success.png) ![](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Glossary/Toast%20Message%20-%20Warning.png) ![](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Glossary/Toast%20Message%20-%20Error.png)