Carrier Monitoring API Field Mapping

  • Updated on Apr 30, 2025
  • Published on Mar 21, 2023
  • 6 minute(s) read
Prev Next

Overview

Integrations with SaferWatch, RMIS, Highway, and MyCarrierPackets allow for real-time Carrier monitoring within the TMS. The table below describes field value changes based on the integration.

Table Guide

The following fields are inserted/updated by the Carrier Monitoring APIs as follows:

I – Insert

U – Update

(1) => update if the global setting “Allow Carrier Address Updates” is checked OR the value in the TMS field is null

(2) – update if the value in the TMS field is null

(3) – update if there is a value in the response

(4) – update if there is a value in the response AND the value in the TMS field is null

(5) – update if the global setting “Carrier Remit To Sync” is checked AND the response has factor company information

(6) – update to ‘Pending’ if RMIS Certified is not ‘Yes’

(7) – set to ‘Pending’ by the TMS

(8) - Set to Email by the TMS.

(*) - If a W9 file is associated with the Carrier, the file is downloaded and attached to the Transportation File. No field values are updated.

(**) - If a file is associated with an Insurance Policy in the Highway system, the file is downloaded and added to the Files section of the Insurance Policy record.

Carrier Address Updates

Enable this functionality by navigating to TMS Admin and then selecting Configuration. Check the box for "Allow Carrier Address Updates" in the list of Global Settings. When checked, the shipping and billing addresses for the Carrier will update continuously.   Note that this functionality is only supported by RMIS and MyCarrierPackets, NOT SaferWatch.

Object

Field

SaferWatch

RMIS

Highway

MyCarrierPackets

Account

Account Name

I

I

I

I

Account

BillingStreet

I 

I / U (1)

I / U (1)

I / U (1)

Account

BillingCity

I

I / U (1)

I / U (1)

I / U (1)

Account

BillingStateCode

I

I / U (1)

I / U (1)

I / U (1)

Account

BillingPostalCode

I

I / U (1)

I / U (1)

I / U (1)

Account

BillingCountryCode

I

I / U (1)

I / U (1)

I / U (1)

Account

Currency

I

I

I

I

Account 

DBA Name

I / U (2)

I / U (2)

I

I / U (2)

Account

Default Payment Method

I

Account

Fax

I / U (2)

I / U (2)

I

I / U (2)

Account

Phone

I / U (2)

I / U (2)

I

I / U (2)

Account

ShippingStreet

I

I / U (1)

I / U (1)

I / U (1)

Account

ShippingCity

I

I / U (1)

I / U (1)

I / U (1)

Account

ShippingStateCode

I

I / U (1)

I / U (1)

I / U (1)

Account

ShippingPostalCode

I

I / U (1)

I / U (1)

I / U (1)

Account

ShippingCountryCode

I

I / U (1)

I / U (1)

I / U (1)

Bank Account

Account Number

I

I

Bank Account

Account Type

I

Bank Account

ACH Payee Name

I

Bank Account

Bank Name

I

I

Bank Account

Confirm Account Number

I

I

Bank Account

Routing Number

I

I

Carrier Equipment Type

Equipment Type

I

I

Carrier Equipment Type

Name

I

I

Carrier Equipment Type

Number

I

I

Carrier Service

Batch Status Emails

I

Carrier Service

Currency

I

I

I

I

Carrier Service

Enabled

I

Carrier Service

Maximum Weight

I

Carrier Service

Minimum Weight

I

Carrier Service

Mode

 

I

I

I

Carrier Service

Name

I

I

I

I

Carrier Service

Quote Contact

I

I

I

I

Carrier Service

Quote Method

I (8)

Carrier Service

Settlement Contact

I

Carrier Service

Status Contact

I

I

I

I

Carrier Service

Status Method

I

Carrier Service

Tender Contact

I

I

I

I

Carrier Service

Tender Method

I (8)

Carrier Service

Weight Units

I

Contact

First Name

I

I

I

I

Contact

Last Name

I

I

I

I

Contact

Email

I

I

I

I

Contact

Fax

 

I

I

Contact

Mobile Phone

 

I

I

Contact

Phone

I

I

I

I

Contact

Title

 

I

 

Contact

Transportation Role

I

I

I

I

Insurance Policy

Currency

I

I

I / U

I

Insurance Policy

Address

I

I

I / U

I

Insurance Policy

Agent Company

I

I

I

Insurance Policy

Agent Email

I

I

I

Insurance Policy

Agent Phone

I

I

I

Insurance Policy

Cancel Date

 

I

I / U

 

Insurance Policy

City

I

I

I / U

I

Insurance Policy

Coverage Amount

I

I

I / U

I

Insurance Policy

Effective Date

 

I

I / U

 

Insurance Policy

Expiry Date

I

I

I / U

I

Insurance Policy

Fax

I

I

I

Insurance Policy

Insurance Company

I

I

I / U

I

Insurance Policy

Name

I

I

I / U (**)

I

Insurance Policy

Phone

I

I

I / U

I

Insurance Policy

Policy Number

I / U

Insurance Policy

Postal Code

I

I

I / U

I

Insurance Policy

Reefer Breakdown Coverage

I

 

 

Insurance Policy

Reefer Breakdown Deductible

I

 

 

Insurance Policy

Deductible

I

 

I

Insurance Policy

Source

I

I

I / U

I

Insurance Policy

State/Province

I

I

I / U

I

Insurance Policy

Type

I

I

I / U

I

Payment Terms

Name

I

Payment Terms

Payment Days Due

I

Payment Terms

Payment Discount %

I

Payment Terms

Type

I

Transportation Profile

Agreement Date

 

 

I

I

Transportation Profile

Agreement Signed By

 

 

I

I

Transportation Profile

Agreement Status

 

 

I

I

Transportation Profile

Authority Granted Date

I / U

I / U

I / U

I / U

Transportation Profile

Authority Points

 

 

I / U

Transportation Profile

Authority Risk

I / U

I (7)

I / U

I / U

Transportation Profile

Blocked Carrier

I / U

Transportation Profile

Broker Authority Pending

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Broker Authority Revocation

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Broker Authority Status

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Canada Province Coverage

 

I / U (4)

I / U (4)

Transportation Profile

CARB TRU Certificate Expiration Date

 

I / U

 

Transportation Profile

CARB TRU Compliant Vehicles Reported

 

I / U

 

Transportation Profile

CARB TRU Compliance Type

 

I / U

 

Transportation Profile

CARB TRU Non-Compliant Reason

 

I / U

 

Transportation Profile

Cargo Carried

 

 

I / U

I / U

Transportation Profile

Carrier Comments

I / U

Transportation Profile

Carrier Operation

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Carrier Pay To Name

 

I / U

 

Transportation Profile

Carrier Remit To

I

I / U (5)

I / U (5)

Transportation Profile

Carrier Review Status

I

I / U (6)

I / U

(7)

Transportation Profile

Common Authority Pending

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Common Authority Revocation

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Common Authority Status

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Company Risk

I

(7)

I / U

(7)

Transportation Profile

Connection Status

I / U

Transportation Profile

Contract Authority Pending

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Contract Authority Revocation

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Contract Authority Status

I / U (3)

I / U (3)

I / U (3)

I / U (3)

Transportation Profile

Currency

I

I

I

I

Transportation Profile

D&B DUNS Number

 

 

I

Transportation Profile

EPayment Authorized

I

Transportation Profile

Federal Tax ID

 

I / U (3)

I

I / U (3)

Transportation Profile

Fleet Size

 

I

I / U

I

Transportation Profile

FMCSA Insurance Cancellation Date

I / U

 

 

Transportation Profile

FMCSA Insurance Cancellation Type

I / U

 

 

Transportation Profile

Highway ID

I

Transportation Profile

Insurance Points

 

 

I / U

Transportation Profile

Insurance Risk

I / U

I (7)

I / U

I / U

Transportation Profile

Last Carrier Review Date

 

I / U

I / U

 

Transportation Profile

MC Number

I / U (3)

I / U (3)

I / U

I / U (3)

Transportation Profile

Mexico State Coverage

 

I / U (4)

 

Transportation Profile

Name

I

I

I / U

I

Transportation Profile

NSC Number

 

I / U (3)

 

Transportation Profile

NSC Safety Certificate Date

 

I / U (3)

 

Transportation Profile

Number of Drivers

 

I

I

Transportation Profile

Operation Points

 

 

I / U

Transportation Profile

Operation Risk

I / U

I (7)

I / U

I / U

Transportation Profile

Other Carrier Capabilities

 

I / U

I / U

I / U

Transportation Profile

Other Risk

I / U

Transportation Profile

Other Risk Points

I / U

Transportation Profile

Out of Service

I / U (3)

I / U (3)

I / U

I / U (3)

Transportation Profile

Out of Service Date

I / U (3)

I / U (3)

I / U

I / U (3)

Transportation Profile

Overall Points

 

 

I / U

Transportation Profile

Overall Risk

I / U

I (7)

I / U

I / U

Transportation Profile

Payment Processor

I

Transportation Profile

Provincial Authority

 

I / U (3)

 

Transportation Profile

Provincial Permit Number

 

I / U (3)

 

Transportation Profile

RMIS Carrier Payment Option

 

I / U

 

Transportation Profile

RMIS Certified

 

I / U

 

Transportation Profile

RMIS ID

 

I / U (3)

 

Transportation Profile

RMIS Non-Certified Reason

 

I / U

 

Transportation Profile

Safety Points

 

 

I / U

Transportation Profile

Safety Rating

I / U

I / U

I / U

I / U

Transportation Profile

Safety Rating Date

I / U

I / U

I / U

 

Transportation Profile

Safety Risk

I / U

I (7)

I / U

I / U

Transportation Profile

SCAC

 

I / U (3)

I / U

 

Transportation Profile

State DOT Number

I / U (3)

I / U (3)

I / U

 

Transportation Profile

State DOT State

 

I

 

Transportation Profile

Total Power Units

I / U (3)

I / U (3)

I / U

I

Transportation Profile

Total US Vehicle Inspections

I / U (3)

I / U (3)

I / U (3)

I

Transportation Profile

US DOT Number

I / U (3)

I / U (3)

I / U

I

Transportation Profile

US State Coverage

 

I / U (4)

I / U (4)

Transportation Profile

W9 Address

 

I / U

*

I

Transportation Profile

W9 City

 

I / U

*

 

Transportation Profile

W9 State

 

I / U

*

 

Transportation Profile

W9 Postal Code

 

I / U

*

 

Transportation Profile

W9 Validated

 

I / U

*

 

Transportation Profile

Watchdog Reports

I / U

 

I

Table Guide

I – Insert

U – Update

(1) => Update if the global setting Allow Carrier Address Updates is Checked OR the value in the TMS field is null.

(2) – Update if the value in the TMS field is null.

(3) – Update if there is a value in the response.

(4) – Update if there is a value in the response AND the value in the TMS field is null.

(5) – Update if the global setting Carrier Remit To Sync is checked AND the response has factor company information.

(6) – Update to Pending if RMIS Certified is not Yes.

(7) – Set to Pending by the TMS.

(8) - Set to Email by the TMS.

(*) - If a W9 file is associated with the Carrier, the file is downloaded and attached to the Transportation File. No field values are updated.

(**) - If a file is associated with an Insurance Policy in the Highway system, the file is downloaded and added to the Files section of the Insurance Policy record.