Overview
This document defines all Revenova TMS (TMS) objects and fields that are added to the base Salesforce platform when installing the package. Objects that contain fields specifically for the Fleet Management module are described as such.
Refer to the Salesforce data dictionary for a description of standard Salesforce objects and fields.
Standard fields added to all Salesforce objects (such as Created By) are not defined here. By default, Salesforce uses USD as a single default currency. However, multi-currency is also available. Only enable if you require multi-currency as once enable it cannot be disabled!
See additional Data Dictionary objects and fields.
See additional package objects and fields.
Accounting Seed Data Dictionary
PayIQ Data Dictionary
Accessorial
The Accessorial object contains pre-populated, read-only reference data that describes “generic” accessorial charges defined in the TMS. You may add to this list, but please do not delete or modify existing records.
Field Name | Type | Description |
---|---|---|
Customer Charge Code | Text(20) | When populated, these codes are included in EDI 210 transactions. |
Customer Portal Selection | Checkbox | If “Checked,” the accessorial is available within the Customer Portal. |
Enabled | Checkbox | If “Checked,” the accessorial is visible and available for use. |
Limited Access | Checkbox | If “Checked,” the accessorial is added to the Limited Access list. |
Mode | Picklist (Multi-Select) | The mode(s) this accessorial applies to. Values include: “Truckload,” “LTL,” “Intermodal,” “Drayage,” “Ocean FCL,” “Ocean LCL,” ‘Air Freight,” “Flatbed,” “Bulk,” and “Parcel.” No default value. |
Name | Text(80) | The name and description of the accessorial. |
Pre-Quote | Checkbox | “Checked” means an accessorial is available when configuring a load. |
Type | Picklist | The accessorial is applied on: “Pickup,” “Delivery,” or the “Load.” No default value. |
Accessorial Exclusion
The Accessorial Exclusion object contains records that allow for Carriers that do not support a set of accessorial types to be excluded from loads.
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A Lookup to the associated Accessorial name/description record. |
Accessorial Exclusion Name | Auto Number | The unique record Identifier. Example: AE-{0}. |
Carrier Service | Lookup(Carrier Service) | A lookup to the associated Carrier Service record. |
Carrier Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Accessorial Exclusion belongs to. |
Effective Date | Date | The date an exclusion begins. If a load’s Stop One Expected Date is less than the Exclusion Effective Date, then the exclusion is not applied. |
Exclusion Type | Formula (Text) | The exclusion is applied on: “Pickup,” “Delivery,” or the “Load.” |
Expiration Date | Date | The date an exclusion expires. If the load’s Stop One Expected Date is greater than the Exclusion Expiration Date, then the exclusion is not applied. |
Lane | Lookup(Lane) | A lookup to the Lane record associated with the lane to apply the exclusion. (Only select a lane or a location). |
Location | Lookup(Account) | A lookup to the Account record associated with the location to apply the exclusion. (Only select a lane or location). |
Reason | Text(100) | The description of the exclusion. |
Account (SFDC Object)
The Account object is the foundational object of Salesforce. Note that customers, shippers, consignees, and carriers are all modeled as Account records.
Field Name | Type | Description |
---|---|---|
Accounting Status | Picklist | Flag for the Pub/Sub Accounting integration. Values include: "Ready for Accounting," "Sent to Accounting," "Publish Error." |
Broker Filer Code | Text(3) | The unique identification code issued by the U.S. Customs and Border Protection to Customs Brokers. |
Customer Sales Rep | Lookup(User) | A lookup to the User record associated with the Customer Sales Rep Account. |
DBA Name | Text(80) | The Doing Business As Name. |
Default Payment Method | Picklist | The selection for the payment method. Values include: “ACH" (NACHA File), “Check.” No default value. |
Posting City | Text(40) | The Posting City alias for load boards. |
Posting State/Province | Picklist | The Posting State/Province alias for load boards. No default value. |
Shipping Latitude for Reports | Formula (Number) | Latitude coordinates for supporting TMS Analytics. |
Shipping Longitude for Reports | Formula (Number) | Longitude coordinates for supporting TMS Analytics. |
Transportation Profile | Lookup(Transportation Profile) | A Lookup to the associated Transportation Profile record for the associated Account. |
Timezone | Picklist | The time zone for the account. No default value. |
TMS Type | Picklist (Multi-Select) | A selection for the account type. Values include: “Prospect,” “Customer,” “Shipper/Consignee,” “Carrier,” “Customs Broker,” “Factoring Company,” “Vendor,” and more. No default value. |
TMS Type for Sharing | Text(100) | The sharing rule compatible copy of the TMS Type field. |
UN Location Code | Text(6) | The UN Location code. Example: “CAMTR” for Montreal. Required for Ocean Full Container Loads. |
Account ELD
This Fleet Management object contains ELD-specific location information for this account.
Field Name | Type | Description |
---|---|---|
Account | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Account ELD belongs to. |
ELD ID | Text(50) (External ID) | The ELD provider identifier for this account/location. |
ELD Provider | Picklist | The only ELD Provider, “Samsara“ is selected by default. |
Geofence Radius | Number (10, 0) | The Geofence radius for arrival/departure events. Circle only. |
Geofence Type | Picklist | The shape of the Geofence: “Circle” or “Polygon.” “Circle” is the default value. |
Geofence Units | Picklist | The measurement units for the Geofence: “ft” or “m.” “Ft.” is the default value. |
Name | Auto Number | The unique record identifier. Example: ELD-{0}. |
ACE Notification
This object contains fields that hold status updates from U.S. border customs. This object is used by the Border Connect integration.
Field Name | Type | Description |
---|---|---|
ACE Notification Name | Text(80) | The name of the ACE Notification. |
EManifest | Master-Detail(EManifest) | The Master-Detail relationship to the parent EManifest record the ACE Notification belongs to. |
EManifest Shipment | Lookup(EManifest Shipment) | A lookup to the EManifest Shipment the ACE Notification is associated with. |
Entry Number | Text(30) | The entry number of the Customs Broker’s PAPS filing or in-bond entry number. |
Load Number | Formula (Text) | The Load number associated with the ACE notification. |
Port Code | Text(4) | The Port Code the ACE notification pertains to. |
Status | Picklist | The status of the notification. Several values available. This field is dependent on the Type field. No default value. |
Type | Picklist | The type of notification. Values include: “Trip” and “Shipment.” The Status field is dependent on this field. No default value. |
Advance Payment Authority
This object defines EPayment issuance authority levels for TMS users.
Field Name | Type | Description |
---|---|---|
Contact | Lookup(Contact) | A lookup to the associated Contact record. |
Default EPayment Credentials | Text(18) | The Credentials ID for EPayments. |
ePayment Recipient Required | Checkbox | "Checked" means a user requires a recipient when saving or issuing an EPayment. |
Issue Authority | Picklist | The type of authority the current user has to issue EPayments. Values include: “Assigned Carrier Only,” “Any Authorized Vendor,” and “Assigned Driver Only.” No default value. |
Name | Auto Number | The unique record identifier. Example: Auth-{0}. |
Per Day Count | Number(2,0) | The maximum number of EPayments that a user can issue per day. |
Per Day Max | Currency(5, 0) | The maximum monetary amount that a user can issue per day. |
Per Load Limit | Percent(5, 0) | The percent of the approved Carrier quote total for a load that can be issued as a Comchek. |
Per Load Maximum | Currency(5, 0) | The maximum monetary amount that can be issued as a Comchek for one load. |
User | Lookup(User) | A lookup to the associated user record granted authority. |
Advance Payment Authority Credentials
This object defines the credentials that users with Advance Payment Authority can issue EPayments.
Field Name | Type | Description |
---|---|---|
Advance Payment Authority | Master-Detail(Advance Payment Authority) | The Master-Detail relationship to the parent Advance Payment Authority record the Advance Payment Authority Credentials belong to. |
Credentials | Text(18) | The ID of the Credentials record. |
Advance Payment Authority Txn Type
This object defines the EPayment Transaction Types that users with Advance Payment Authority are allowed to issue EPayments for.
Field Name | Type | Description |
---|---|---|
Advance Payment Authority | Master-Detail(Advance Payment Authority) | The Master-Detail relationship to the parent Advance Payment Authority record the Advance Payment Authority Txn Type belongs to. |
EPayment Transaction Type | Master-Detail(EPayment Transaction Type) | The Master-Detail relationship to the parent EPayment Transaction Type record the Advance Payment Authority Txn Type belongs to. |
Advance Payment Fee
This object defines the Carrier Advance Payment Fee schedule rows.
Field Name | Type | Description |
---|---|---|
Charge | Currency(5, 2) | The monetary amount for the charge paid via EFS/Comchek. |
Fee | Currency(5, 2) | The monetary amount paid to the broker. |
From Payment Amount | Currency(5, 2) | The monetary amount sent via EFS/Comchek and cannot be greater than the “To Payment Amount” field. |
Name | Auto Number | The unique record identifier. Format: Fee-{0}. |
To Payment Amount | Currency(5, 2) | The monetary amount sent via EFS/Comchek. |
AI Model
This object defines AI model characteristics created in the AI Console.
Field Name | Type | Description |
---|---|---|
API Name | Text(100) | The name of the API used to create an AI Model. |
Enabled | Checkbox | If “Checked,” the AI model is enabled. |
Is Custom Model | Checkbox | If “Checked,” the AI Model is custom. |
Is Trained | Checkbox | If “Checked,” the AI Model is successfully trained and ready for use. |
Model Name | Text(80) | The name of the AI Model. |
Parent Model | Lookup(AI Model) | A lookup to the Parent AI Model the AI Model is associated with. |
Parent Model API Name | Formula(Text) | The name of the API Parent Model used to create the AI Model. |
AI Model Training Record
This object defines AI Model Training Records to train AI Models.
Field Name | Type | Description |
---|---|---|
AI Model Training Set | Master-Detail(AI Model Training Set) | The Master-Detail relationship to the parent AI Model Training Set record the AI Model Training record belongs to. |
AI Parsed Text | Lookup(AI Parsed Text) | A lookup to the AI Parsed Text used to train the AI Model. |
Model Output | Long Text Area(20000) | The text of the AI Model Training output. |
Name | Auto Number | The unique record identifier. Format: Record-{0}. |
System Prompts | Long Text Area(10000) | The text prompts used to train the AI Model. |
Type | Picklist | The type of AI Model to train. Values include: “Load” and “Truck Posting.” No default value. |
User Prompt | Long Text Area(10000) | The text entered to train the AI Model. |
AI Model Training Session
This object defines AI Model Training Session to train AI Models.
Field Name | Type | Description |
---|---|---|
AI Model | Master-Detail(AI Model) | The Master-Detail relationship to the parent AI Model record the AI Model Training Session record belongs to. |
AI Model Training Set | Master-Detail(AI Model Training Set) | The Master-Detail relationship to the parent AI Model Training Set record the AI Model Training Session record belongs to. |
API Session ID | Text(100) | The identifier of the API Session. |
Name | Text(80) | The name of the AI Model Training Session record. |
Status | Picklist | The current status of the AI Model Training Session. Values include: “New,” “Validating,” “Queued,” “Running,” “Succeeded,” “Failed,” and “Cancelled.” “New” is the default value. |
AI Model Training Set
This object defines the AI Model Training Set used to train AI Models.
Field Name | Type | Description |
---|---|---|
API File ID | Text(100) | The identifier of the API File. |
Description | Text(200) | A description of the AI Model Training Set. |
Name | Text(80) | The name of the AI Model Training Set record. |
Upload Status | Picklist | The current upload status of the AI Model Training Set. Values include: “Pending,” “Uploaded,” and “Error.” “Pending” is the default value. |
AI Parsed Text
This object defines the AI Parsed Text used to create Load and Truck Posting records from the parsed text of the AI integration.
Field Name | Type | Description |
---|---|---|
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record the AI Parsed Text is associated with. |
Contact | Lookup(Contact) | A lookup to the Contact record the AI Parsed Text is associated with. |
Created Record Count | Roll-Up Summary (COUNT AI Parsed Text Record) | The number of AI Parsed Text records created. |
Customer | Lookup(Account) | A lookup to the Customer Account record the AI Parsed Text is associated with. |
Input Text | Long Text Area(20000) | The text included that is sent to the AI integration for processing. |
Name | Auto Number | The unique record identifier. Format: Text-{0}. |
Output | Long Text Area(20000) | The processed text returned from the AI integration. |
Record Creation Status | Picklist | The type of AI Parsed Text record created. Values include: “None,” “Partial,” and “Complete.” No default value. |
Send Customer Quote | Checkbox | If “Checked,” customer quote is sent to the customer based on the AI Parsed Text. |
System Prompts | Long Text Area(10000) | The text prompts sent to the AI integration. |
Type | Picklist | The type of record created from the AI Parsed Text. Values include: “Load” and “Truck Posting.” No default value. |
AI Parsed Text Record
This object defines the record of AI Parsed Text returned from the AI integration.
Field Name | Type | Description |
---|---|---|
AI Parsed Text | Master-Detail(AI Parsed Text) | The Master-Detail relationship to the parent AI Parsed Text the AI Parsed Text Record belongs to. |
Name | Auto Number | The unique record identifier. Format: Record-{0}. |
Record ID | Text(18) (External ID) | The external ID for the AI Parsed Text Record created from the AI integration. |
API Accessorial
This object defines API-specific accessorial codes used in quoting and tendering loads while using API integrations such as Project44.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the API Accessorial belongs to. |
API Provider | Picklist | The API provider using the accessorial code. Values include: “Project44,” “Worldwide Express,” “AccuFRATE,” and “Banyan.” No default value. |
Code | Text(80) | The Carrier API-specific code for the accessorial. |
Subcode | Text(50) | The Banyan API-specific subcode for the accessorial. This field is required for the Banyan API integration. |
API Quote Log
This object defines the logs generated when auditing quotes.
Field Name | Type | Description |
---|---|---|
API Provider | Picklist | The API integration used to generate quotes. Values include: “Project44,” “SMC3,” “Banyan,” “Accufrate,” “WWEX,” and “WWEX Speedship.” No default value. |
API Quote Log Name | Auto Number | The unique record identifier. Format: Log-{0}. |
Carrier SCAC | Text(10) | The SCAC for the Carrier that a quote was generated for. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service associated with the quote log. |
Details | Long Text Area(131072) | The full text reason why quotes were not generated. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the API Quote Log belongs to. |
Timestamp | Date/Time | The timestamp when the log was created. This field may differ from the insertion date/time. API Quote Logs are generated in the background. |
API Service Level
This object defines API-specific Service Levels for Load quoting and tendering.
Field Name | Type | Description |
---|---|---|
API Provider | Picklist | The API provider using the Service Level. Values include: “SMC3 EVA.” No default value. |
Code | Text(80) | The Carrier API-specific code for the Service Level. |
Service Level | Master-Detail(Service Level) | The Master-Detail relationship to the parent Service Level record the API Service Level belongs to. |
Bank Account
This object defines Bank Account information for various accounts such as Carriers, Factoring companies, and vendors.
Field Name | Type | Description |
---|---|---|
Account | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Bank Account belongs to. |
Account Number | Text (Encrypted)(17) | The account number for the payment destination financial institution. |
Account Type | Picklist | The bank Account Type. Values include: “Checking” and “Savings.” No default value. |
ACH Active | Checkbox | The active bank account for the vendor. When “Checked,” Account Type, Routing Number, and Account Number are required fields. |
ACH Company Discretionary Data | Text(20) | The NACHA field for a Company’s internal use. |
ACH Company Information | Text(40) | The NACHA field for the Immediate Origin, FEIN, or Taxpayer Identification Number. |
ACH Company Name | Text((16) | The NACHA field representing the Payer’s company name. |
ACH Immediate Origin Name | Text(23) | The NACHA field for a Company Name originating the payment. |
ACH Payee Name | Text(22) | The NACHA field for the company name receiving the payment. |
ACH Reference Code | Text(3) | The NACHA field that contains the prefix value for the reference code on the header record. |
ACH Remittance Document | Picklist | The type of remittance document. Values include: “ACH Remittance Detail” and “ACH Remittance Summary.” No default value. |
Bank Name | Text(40) | The name financial institution for the payment destination. |
Confirm Account Number | Text Encrypted(17) | The second account number entry for confirmation purposes. |
Routing Number | Text(9) | The routing number of the financial institution for the payment destination. |
Carrier Equipment Type
This object tracks which equipment types are available for a given Carrier’s Transportation Profile.
Field Name | Type | Description |
---|---|---|
Equipment Type | Master-Detail(Equipment Type) | The Master-Detail relationship to the parent Equipment Type record the Carrier Equipment Type belongs to. |
Name | Auto Number | The unique record identifier. Format: Equipment-{0}. |
Number | Number(18-0) | The quantity of equipment type the Carrier operates. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Carrier Equipment Type belongs to. |
Carrier Exclusion
This object defines Carriers that are not used for a given Account and Transportation Profile.
Field Name | Type | Description |
---|---|---|
Carrier | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Carrier Exclusion belongs to. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record to exclude. |
Effective Date | Date | The start date for the Carrier exclusion. |
Exclusion Type | Picklist | The stop type to exclude selection. Values include: “Exclude Pickup,” “Exclude Delivery,” and “Exclude Pickup and Delivery.” “Exclude Pickup and Delivery” is the default value. |
Expiration Date | Date | The end date for the exclusion. If no Effective Date is provided, an exclusion will be effective until the Expiration Date. |
Lane | Lookup(Lane) | A lookup to the Lane record to exclude the Carrier. If no lane is provided, then the Carrier is excluded from all lanes. |
Location | Lookup(Account) | A lookup to the Account record location to exclude the Carrier. If no location is provided, then the Carrier is excluded from all locations. |
Name | Auto Number | The unique record identifier. Format: Exclusion-{0}. |
Reason | Text(100) | The reasoning for excluding the Carrier. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Carrier Exclusion belongs to. |
Carrier Liability Limit
This object captures the Carrier insurance liability limits based on country and NMFC class. Limits are typically a rate per pound.
Field Name | Type | Description |
---|---|---|
Carrier Service | Master-Detail(Carrier Service) | The Master-Detail relationship to the parent Carrier Service record the Carrier Liability Limit belongs to. |
Commodity Condition | Picklist | A description of the cargo. Values include: “New” and “Used.” No default value. |
Country | Picklist (Multi-Select) | The country this limit applies to. Values include: “CA,” “MX,” and “US.” No default value. |
Maximum Liability | Currency(10, 2) | The maximum liability monetary amount for any load of this class. |
Mode | Text(80) | The mode name of the Carrier Service. |
Name | Auto Number | The unique record identifier. Example: Limit-{0}. |
NMFC Class | Picklist (Multi-Select) | The NMFC Class(es) this limit applies to. No default value. |
Rate | Currency(10,2) | The monetary rate per unit weight. |
Weight Units | Picklist | The unit of measurement for the weight. Values include: “lbs.” or “kg.” “Lbs.” is the default value. |
Carrier Markup
This object allows for cost-plus markup Load parameters on Carrier quotes for specific customer-Carrier combinations.
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record this Carrier Markup is associated with. |
Carrier Markup Group | Lookup(Carrier Markup Group) | A lookup to the Carrier Markup Group record associated with the Carrier Markup. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record this Carrier Markup is associated with. If there is no value, the markup applies to all Carrier Services that do not have a specific record. |
Effective Date | Date | The optional begin date for the Carrier markup. |
Expiration Date | Date | The optional end date for the Carrier markup. |
Fuel Surcharge | Lookup(Fuel Surcharge) | A lookup to the Fuel Surcharge record associated with this Carrier Markup. |
Lane | Lookup(Lane) | A lookup to the Lane record associated with this Carrier Markup. |
Markup Type | Picklist | A selection of the criteria for the markup. Values include: “Freight,” “Fuel,” and “Accessorial.” No default value. |
Maximum Carrier Quote | Currency(10, 2) | The maximum monetary quote amount for a specific Carrier Service. |
Maximum Load Weight | Number(18, 0) | Criterion for filtering based on the maximum weight of the load. |
Maximum Markup Amount | Currency(16, 2) | The maximum monetary markup amount for a specific Carrier Service. |
Maximum Markup Amount - Floor | Currency(16, 2) | The maximum monetary markup amount floor value to return from SMC3. |
Maximum Markup Amount - Minimum | Currency(16, 2) | The maximum monetary markup amount minimum value to return from SMC3. |
Maximum Markup Amount - Tariff Rate | Currency(16, 2) | The maximum monetary markup amount tariff rate value to return from SMC3. |
Minimum Carrier Quote | Currency(10, 2) | The minimum monetary quote amount for a specific Carrier Service. |
Minimum Customer Freight Charge | Currency(16, 2) | The minimum monetary customer freight charge after the markup. |
Minimum Load Weight | Number(18, 0) | Criterion for filtering based on the minimum weight of the load. |
Minimum Markup Amount | Currency(16, 2) | The minimum markup amount for a specific Carrier Service. |
Minimum Markup Amount - Floor | Currency(16, 2) | The minimum monetary markup floor amount returned from SMC3. |
Minimum Markup Amount - Minimum | Currency(16, 2) | The minimum monetary markup minimum amount returned from SMC3. |
Minimum Markup Amount - Tariff Rate | Currency(16, 2) | The minimum monetary markup tariff rate amount returned from SMC3. |
Minimum Markup Percent | Percent(16, 2) | The minimum markup percent for a specific Carrier Service. |
Minimum Markup Percent - Floor | Percent(16, 2) | The minimum markup floor percent to return from SMC3. |
Minimum Markup Percent - Minimum | Percent(16, 2) | The minimum markup minimum percent to return from SMC3. |
Minimum Markup Percent - Tariff Rate | Percent(16, 2) | The minimum markup tariff rate percent to return from SMC3. |
Mode | Lookup(Mode) | A lookup to the Mode record associated with the Carrier Markup. This field is set by the Carrier Service if provided. |
Name | Auto Number | The unique record identifier. Example: Markup-{0}. |
NMFC Class | Picklist (Multi-Select) | The NMFC classes for this record. Only relevant to the LTL mode. No default value. |
Target Markup Percent | Percent(16, 2) | The suggested target markup percent. Used in the calculation for the target markup. |
Target Markup Percent - Floor | Percent(16, 2) | The suggested target floor markup percent to return from SMC3. |
Target Markup Percent - Minimum | Percent(16, 2) | The suggested target minimum markup percent to return from SMC3. |
Target Markup Percent - Tariff Rate | Percent(16, 2) | The suggested target tariff rate markup percent to return from SMC3. |
Transaction Fee | Currency(16, 2) | The suggested transaction fee to add to the suggested target markup percent. Used in the calculation for the target markup. |
Weight Units | Picklist | The unit of weight measurement for markup groups. Values include: “lbs” and “kg.” “Lbs.” is the default value. |
Carrier Markup Group
This object defines a group of Carrier Markup records.
Field Name | Type | Description |
---|---|---|
Description | Text(255) | Description of the Carrier Markup group. |
Name | Text(80) | The name of the Carrier Markup group. |
Carrier Quote
This object contains Carrier Quotes generated by Carriers to move a load.
Field Name | Type | Description |
---|---|---|
A/P Ignore | Checkbox | When “Checked,” historical loads are not included in A/P calculations. |
Accepted | Checkbox | If “Checked,” a Carrier quote is accepted. |
Accessorial Charges | Currency(16, 2) | The accessorial monetary charges for the Carrier quote. |
Auto-Tender | Checkbox | If “Checked," the Carrier quote to be processed by the Carrier Engagement Automation job. |
Billable Weight | Number(16, 2) | The greater of the DIM Weight or regular Weight. |
Book It | Checkbox | An Email loop support field for Book It Now feature. If “Checked,” the Carrier has the option to select Book It Now from the Carrier Portal. |
Book It Source | Picklist | The source of the Carrier quote Book It Now request. Values include: “TMS,” “Truckstop,” and “Trucker Tools Load Board.” No default value. |
Calculation Type | Picklist | The selection for calculating a stored rate quote. Values include: “Base,” “Minimum,” and “Maximum.” No default value. |
Carrier API Login Group | Text(40) | A group of customer-specific rates for specific Carriers. A Project44 login group that provides LTL quotes. This value changes per customer. (See the Project44 Carrier Aggregator documentation for more information.) |
Carrier Quote | Auto Number | The unique record identifier. Example: Carrier Quote {0}. |
Carrier Service | Lookup(Carrier Service) | A lookup to the associated Carrier Service record associated with the Carrier quote. |
Carrier Total | Currency(16, 2) | The total Carrier quote monetary amount. |
Deficit Charge | Currency(10, 2) | An LTL tariff support monetary amount field. |
Deficit Rate | Currency(16, 2) | An LTL tariff support monetary amount field. |
Deficit Weight | Number(12, 0) | An LTL tariff support field measured in pounds. |
Destination Movement Type | Picklist | The terminal Destination movement type. Values include: “Direct,” “Interline,” “Partner,” and “Unspecified.” “Unspecified” is the default value. |
Destination Terminal Code | Text(50) | A Read-Only terminal code field returned by SMC3 for LTL Carrier Quotes. |
Destination Terminal Email | A Read-Only email address field returned by SMC3 for LTL Carrier Quotes. | |
Destination Terminal Location | Text Area(255) | A Read-Only terminal location field returned by SMC3 for LTL Carrier Quotes. |
Destination Terminal Phone | Phone | A Read-Only phone number field returned by SMC3 for LTL Carrier Quotes. |
DIM Weight | Number(16, 2) | The dimensional weight total in the weight units of the load as calculated by the Rate Entry. |
Direct/Interline | Picklist | Service information for a Carrier quote. Values include: “Direct,” “Interline,” “Partner,” and “Unspecified.” “Unspecified” is the default value. |
Disclaimer | Long Text Area(5000) | Any disclaimer text related to the Carrier quote. A value can be populated with API-based quotes from AccuFRATE, Banyan, or Project44. |
Discount | Currency(16, 2) | A discount monetary amount applied to the freight charges. |
Discount Percent | Percent(3, 2) | The discount as a percentage of the freight charges. |
Effective Date | Date | The date the Carrier quote goes into effect. The effective date is usually the day the Carrier quote was created. |
Estimated Delivery Date | Date | The estimated delivery date for the load based on the service class and/or the transit days from the Carrier quote. |
Estimated Pickup Date | Date | The estimated pickup date for the load based on the service class. |
Estimated Transit Time (Days) | Number(3, 0) | The estimated transit time in days for the load for this service class. |
Expiration Date | Date/Time | The date a Carrier quote received from the WWEX Speedship API expires. |
Filtered from Portal | Checkbox | When “Checked,” the Carrier quote is not visible to the user in the customer Portal based on the routing filter. |
Freight Charge Applied | Text(10) | An LTL Tariff support field. This field indicates whether the Net Freight Charge are based on the tariff rate, minimum, or floor values. |
Freight Charge Notes | Text(200) | Notes related to the freight charge. |
Freight Charge Quantity | Number(16, 2) | The number of freight charge units. |
Freight Charge Unit | Picklist | A description of the measurement of a freight charge. “Fixed Cost” is the default value, but other selections are available including: “Percent of Amount,” “Per Day,” “Per Cubic Foot,” and "Per HU Position." |
Freight Charge Unit Price | Currency(16, 2) | The monetary cost associated with the Freight Charge Unit. Example: $500 per day. |
Freight Charges | Currency(16, 2) | The gross monetary freight charges before any discount. |
Freight Charges After Discount | Formula (Currency) | An LTL Tariff support field representing the gross freight charges minus any applicable monetary discount. |
Freight Charges after Discount/Minimums | Formula (Currency) | An LTL Tariff support field representing the greater monetary amount between the Freight Charges After Discount or the Minimum Freight Charge Floor. |
Freight Surcharge | Currency(16, 2) | An LTL Tariff support field for the monetary cost associated with shipping a load. |
Freight Surcharge Application | Text(10) | An LTL Tariff support field for when a Freight Surcharge was applied to the Net or Gross Freight Charge amount. |
Freight Surcharge Percentage | Percent(16, 2) | An LTL Tariff support for the percentage applied to calculate the Freight Surcharge. |
Fuel Surcharge | Currency(16, 2) | The fuel surcharge monetary amount. |
Fuel Surcharge Notes | Text(200) | Notes regarding the fuel surcharge. |
Fuel Surcharge Quantity | Number(16, 2) | The quantity of fuel surcharge units. |
Fuel Surcharge Unit | Picklist | Per-xxx fuel surcharge unit. Values include: “Fixed Cost,” “Per Mile,” “Per Kilometer,” and “Percent of Freight.” “Fixed Cost” is the default value. |
Fuel Surcharge Unit Price | Currency(14, 4) | The monetary charge for each fuel surcharge unit. |
Liability Coverage | Currency(16, 2) | The monetary amount of liability coverage offered by the Carrier and calculated from the Carrier Liability Limit. |
Liability Coverage Exceeded By | Currency(16, 2) | Any cargo monetary value more than the Carrier liability coverage amount. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Carrier Quote belongs to. |
Margin | Percent(6, 2) | An LTL Workbench support field for the margin percentage for a Carrier quote from an RFP and not from the Carrier Quote Assistant. |
Markup | Currency(16, 2) | An LTL Workbench support field for the markup monetary amount for a Carrier quote from an RFP and not from the Carrier Quote Assistant. |
Master Invoice Number | Text(50) (External ID) | The invoice number for multiple invoices. |
Messages | Long Text Area(5000) | Any messages related to a Carrier quote. Sometimes populated with API-based quotes from AccuFRATE, Banyan, Project44, and Worldwide Express. |
Minimum Freight Charge Floor | Currency(10, 2) | An LTL Tariff support field for the minimum monetary charge for transporting a load. This minimum charge is defined in the Tariff Schedule. |
Movement Type | Picklist | A description of ocean load movement. Values include: “Door to Door,” “Door to Port,” “Port to Door,” and “Port to Port.” No default value. |
Net Freight Charges | Currency(16, 2) | The Net Freight Charges field is the greater monetary amount between the Freight Charges field minus any Discounts and the Minimum Freight Charge Floor plus any Freight Surcharges. |
Order Number | Formula (Text) | The load’s customer order number. |
Origin Movement Type | Picklist | Description of the movement of a load from the origin terminal. Values include: “Direct,” “Interline,” “Partner,” and “Unspecified.” “Unspecified” is the default value. |
Origin Terminal Code | Text(50) | A Read-Only terminal code value returned by SMC3 for LTL Carrier quotes. |
Origin Terminal Email | A Read-Only email address value returned by SMC3 for LTL Carrier quotes. | |
Origin Terminal Location | Text Area(255) | A Read-Only terminal location value returned by SMC3 for LTL Carrier quotes. |
Origin Terminal Phone | Phone | A Read-Only phone number value returned by SMC3 for LTL Carrier quotes. |
Pickup Cutoff Time | Time | The latest available pickup time for the Carrier on the quote. |
Pickup Only | Checkbox | If “Checked,” set pickup-only flag for Project44 tender API calls. A PRO number is not assigned when dispatching the load. |
Priority | Picklist | This field is the Priority of the Rate Entry for the Carrier quote based on the lane and carrier combination. Values include: “1,” “2,” and “3.” |
Quote Contact | Lookup(Contact) | A lookup to the Contact record associated with the Carrier or Vendor type Carrier quote. |
Quote/Contract Id | Text(100) | The quote/contract ID returned with an API quote and is used when tendering a load. This value is returned by many API integrations. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record associated with the stored rate the Carrier quote is based on. |
Rate Entry Source | Lookup(Transportation Profile) | A lookup to the Transportation Profile record associated with the Rate Entry used in the Carrier quote. |
Reason for Acceptance | Picklist | The explanation for accepting a Carrier quote. Values include: “Customer Preference” and “Transit Time Requirement.” No default value. |
Removal Charge | Number(16, 2) | Any additional charges for removing a Carrier. These charges are for informational purposes. |
Removal Charge Accessorial | Text(255) | The accessorial name for a Carrier removal charge. |
Removal Comments | Text(255) | The explanation for removing a Carrier. |
Removal Reason | Picklist | The reason for carrier removal. Values include: “Load Not Ready,” “Carrier Breakdown,” and “Carrier Cancelled.” No default value. |
Request PRO Number | Checkbox | When Checked, the RequestPRONumber API call is made to SMC3 EVA. |
RFP | Lookup(RFP) | A lookup to the RFP record associated with the Carrier quote. An LTL Workbench support field for creating Carrier quotes for an RFP. Carrier Quotes created for an RFP are not created from the Freight Quote Assistant. |
Routing | Text(255) | A description of complex routing for Ocean load Carrier quotes. |
Sales Floor | Currency(16, 2) | The minimum monetary amount for customer sales reps to quote to customers. |
Same-Day Tender Cutoff Time | Time | The latest time on the same day for the Carrier to tender a load. |
Selection Reason | Picklist | The reason provided when not selecting the lowest cost Carrier quote on the portal Quote Wizard. Values include: “Faster Transit Time Required” and “Past Carrier Performance.” No default value. |
Service Class | Text(255) | A description of the Carrier Service class. |
Service Class Code | Text(20) | The Carrier Service class code provided by the Banyan or Project44 APIs. |
Service Level | Lookup(Service Level) | A lookup to the Service Level record associated with the Carrier. When quoting with SMC3 RateWare, this field is populated by the Rate Entry. |
Settlement Comments | Text(255) | Internal comments related to settlement. |
Settlement Contact | Lookup(Contact) | A lookup to the Contact record associated with the Carrier for settlement issues. |
Settlement Documents Received | Picklist (Multi-Select) | Settlement documents provided by the Carrier to date. This field selects from the Settlement Document Types global picklist. No default value. |
Settlement Issues | Picklist (Multi-Select) | The reason(s) preventing quote-invoice settlement. Values include: “Vendor Invoice Missing,” “Proof of Delivery Missing,” “Lumper Receipt Missing,” “Fuel Receipt Missing,” “Weight Certificate Missing,” and “Other (see comments).” No default value. |
Settlement Status | Picklist | The state of the Carrier quote-invoice settlement process. Values include: “Pending,” “Documents Requested,” “Documents Received,” and “Approved for Payment.” Default value is “Pending.” |
Settlement Status as of | Date/Time | The date and time of the most recent the Settlement Status changes. |
Tariff Minimum | Currency(10, 2) | The minimum tariff monetary amount from the SMC3 API. |
Tender Accepted By | Text(100) | The name of the user accepting the tender. |
Tender Accepted By Email | The email address of the user accepting the tender. | |
Tender Accepted Date | Date/Time | The date and time when the tender was accepted by the Carrier via Email Loop. |
Tender CC List | Text(250) | The email addresses added to the tender email. |
Tender Contact | Lookup(Contact) | A lookup to the Contact record associated with the recipient of the load tender email. |
Tender Declined Comments | Text Area(255) | Additional comments explaining why the Carrier declined the load tender. |
Tender Declined Reasons | Picklist (Multi-Select) | The reason the Carrier declined the load tender. Many values available. No default value. |
Tender Exception Comments | Text Area(255) | The comments for “Accept with Exception” for the Load tender. |
Tender Expiration Date | Date/Time | The date and time the Carrier quote tender expires. |
Tender Hold | Checkbox | If “Checked,” a load cannot be tendered. |
Tender Hold Reason | Text Area(255) | The explanation for the load tender hold. |
Tender Sent By | Lookup(User) | A lookup to the User record responsible for sending the load tender. |
Tender Sent Date | Date/Time | The date and time the load tender was sent to the Carrier. |
Tender Status | Picklist | The current state of the load tender. Values include: “Queued,” “Sent,” “Assigned,” “Rejected,” “Removed,” “Expired,” and “On Hold.” No default value. |
Third Party Insurance Information | Long Text(2000) | The insurance information included with Carrier Quotes received from the WWEX Speedship API. Insurance deductible, premium, insured amounts, expiration date, and terms and conditions are included. |
Third-Party Insurance Certificate Number | Text(50) | The Insurance certificate number returned with Carrier quotes from the WWEX Speedship API. |
Tracking Information | Text(255) | The IP address and browser type of the TMS Site email recipient. |
Variance Description | Text(255) | The explanation as to why the invoice total does not match the Carrier quote total. |
Variance Reason | Picklist (Multi-Select) | The reason(s) why the invoice does not match the Carrier quote. Values include: “Lumper Charges,” “Fuel Charges,” “Detention Charges,” and “Other Charges.” No default value. |
Vendor | Lookup(Account) | A lookup to the Account record associated with the Carrier Quote. The capacity provider for the load. Usually the Carrier. |
Vendor Invoice Date | Date | The vendor invoice issue date provided by the Carrier Portal or the invoice processor. |
Vendor Invoice Number | Text(40) | The vendor invoice number provided by the Carrier Portal or the invoice processor. |
Vendor Payment Terms | Lookup(Payment Terms) | A lookup to the Payment Terms record associated with the Carrier invoice. |
Vendor Settlement Total | Currency(16, 2) | The invoice monetary total provided by HubTran or the Carrier Portal. |
Vendor Settlement Variance | Formula (Currency) | The Vendor Settlement Total minus the Carrier Quote Total monetary amount. |
Carrier Quote Accessorial
This object contains accessorial charges specific to a Carrier quote.
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record associated with the Carrier Quote Accessorial. |
Carrier Accessorial | Lookup(Carrier Accessorial) | A lookup to the Carrier Accessorial record associated with the Carrier Quote Accessorial. |
Carrier Quote | Master-Detail(Carrier Quote) | The Master-Detail relationship to the parent Carrier Quote record the Carrier Quote Accessorial belongs to. |
Charge | Currency(16, 2) | The monetary charge from the Carrier for this accessorial. |
Code | Text(20) | The standard accessorial code employed by the Carrier. Used by the Banyan, HubTran, and Project44 APIs. |
Name | Text(80) | The Carrier-specific name and description of an accessorial. |
Notes | Text(200) | The optional details related to the accessorial charge. |
Quantity | Number(16, 2) | The number of units included on the Carrier quote accessorial. |
Quote/Contract Id | Text(100) | The identifier used with the Falvey integration to match the insurance certificate number on the Customer load with the accessorial record. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record associated with the Carrier Quote Accessorial. |
Stop | Lookup(Stop) | A lookup to the Stop record associated with the Carrier Quote Accessorial. |
Unit | Picklist | The cost unit of measure. “Fixed Cost” is the default value with many other options including: “Percent of Amount,” “Per Cubic Foot,” “Per Additional Stop,” “Per Hour,” "Per HU Position," etc. |
Unit Price | Currency(16, 2) | The per-unit price of the Carrier quote accessorial. |
User Added | Checkbox | If “Unchecked,” an API-generated quote automatically added the Carrier quote accessorial charges based on the Origin/Destination conditions. If “Checked,” the Carrier quote accessorial charges were manually added by the user. |
Carrier Quote Freight Charge Item
This object contains line itemized freight charges specific to an LTL Carrier quote.
Field Name | Type | Description |
---|---|---|
Carrier Quote | Master-Detail(Carrier Quote) | The Master-Detail relationship to the parent Carrier Quote record the Carrier Quote Freight Charge Item belongs to. |
Discount % | Percent(3, 2) | The discount percent associated with the freight charge item. |
Discount Amount | Formula(Currency) | The discount amount associated with the freight charge item. |
Freight Charge | Currency(10,2) | The pre-discount freight charge monetary amount associated with this freight charge item. |
Freight Charge Item Number | Auto Number | The unique record identifier. Example: Freight Charge Item-{000}. |
Item | Lookup(Line Item) | A lookup to the Line Item record associated with the Carrier Quote Freight Charge Item. |
Item Description | Text(255) | The description the freight charge item. |
Net Freight Charge | Formula(Currency) | The freight charge monetary amount including the discount amount associated with the freight charge item. |
NMFC Class (Rated As) | Picklist | The NMFC Class of the freight charge item. No default value. |
Rate | Currency(10,2) | The monetary rate associated with the freight charge item. |
Weight | Number(18,0) | The weight in pounds of the line item associated with the freight charge item. |
Carrier Service
This object defines how Carriers quote, tender, and update the status of loads.
Field Name | Type | Description |
---|---|---|
API Provider | Text(50) | The API Provider name for API-based Carrier Services. This field contains the name of any quoting, tendering, tracking, and image retrieval API. |
Batch Status Emails | Checkbox | If Checked, Carrier load status requests are sent via a batch email process. |
Carrier | Lookup(Account) | A lookup to the Account record associated with the Carrier Service. |
Carrier Service Owner | Lookup(User) | A lookup to the User record associated with the Carrier Service. This field denotes who owns the Carrier relationship. This is the Carrier Sales Rep assigned on the load in the Automated Tender Process. (Carrier Automation Engagement – only place this is used unless custom logic is built for customer.) |
Credentials | Text(18) | For API-based Carrier Services, this field contains the Record ID credentials. This information is retrieved from the TMS Admin section within Credentials |
Dimension Units | Picklist | The dimensional units for L/W/H thresholds. Values include: “in,” “cm,” “ft,” and “m.” “In” is the default value. |
EDI Provider | Picklist | When the Tender Method is EDI, this field can be set to “Kleinschmidt,” “Cleo,” or “Custom EDI” depending on the EDI in use. No default value. This field is dependent on the Tender Method field selection. |
Enabled | Checkbox | If Checked, this Carrier Service can be used to quote and tender loads. |
Load Tender Page Settings | Picklist (Multi-Select) | A selection of the fields displayed to the Carrier when accepting or declining the tender. Values include: “Email signature,” and “Carrier Details.” To accept a tender, “Email signature” requires a name and email address while “Carrier Details” prompts for a required or optional set of field set-driven information. No default value. |
Logo Document Id | Text(18) | The record ID of a document/image that displays on the Customer Portal for this Carrier Service. |
Maximum HU Count | Number(10, 0) | The maximum handling unit count for the Carrier Service. |
Maximum HU Height | Number(16, 2) | The maximum handling unit height dimension for the Carrier Service. |
Maximum HU Length | Number(16, 2) | The maximum handling unit length dimension for the Carrier Service. |
Maximum HU Weight | Number(18, 0) | The maximum per-handling unit weight for the Carrier Service. |
Maximum HU Width | Number(16, 2) | The maximum handling unit width dimension for the Carrier Service. |
Maximum Linear Feet | Number(10, 2) | The maximum linear feet of a load for the Carrier Service. |
Maximum Volume | Number(18, 0) | The maximum load volume for the Carrier Service. |
Maximum Weight | Number(18, 0) | The maximum load weight for the Carrier Service. This field is required field to use the Carrier Service. |
Minimum Linear Feet | Number(10, 2) | The minimum linear feet of a load for the Carrier Service. |
Minimum Weight | Number(18, 0) | The minimum load weight the Carrier Service supports. This field is required to use the Carrier Service. |
Mode | Master-Detail(Mode) | The Master-Detail relationship to the parent Mode record the Carrier Service belongs to. |
Mode Name | Formula (Text) | The mode name. For example, “Truckload.” |
Name | Text(80) | The name of the Carrier Service. |
Pickup Cutoff Time | Time | The latest available pickup time for the Carrier Service for a quote. |
Pickup Only | Checkbox | When Checked, Project44 load tendering API calls are noted as pickup only. A PRO number is not assigned when dispatching the load. |
Quote Contact | Lookup(Contact) | A lookup to the Contact record email email-based Carrier Service quotes. |
Quote Method | Picklist | The method used to request quotes. Values include: “Email,” “Phone,” “Fax,” “API,” and “Stored Rate.” No default value. |
Rail | Formula (Checkbox) | When Checked, the parent Mode record supports EDI rail transactions. |
Rating | Picklist | The rating of Carrier performance with “A” through “F” values. |
Request PRO Number | Checkbox | When Checked, the RequestPRONumber API call is made to SMC3 EVA. |
Same-Day Tender Cutoff Time | Time | The latest time a load may be tendered for the Carrier Service on the same day. |
Service Notes | Long Text Area(1000) | Service notes are available on the Customer Portal and users can view them in the quote list. |
Service Type | Picklist | The type of Carrier Service. Values include: “Carrier” and “Vendor. “Carrier” is the default value. |
Settlement Contact | Lookup(Contact) | A lookup to the Contact record for settlement-related issues. |
Status Contact | Lookup(Contact) | A lookup to the Contact record associated with email-based load status requests. This field is provided from the Carrier Quote. |
Status Method | Picklist | The method used to obtain the status of a load. Values include: “Email,” Phone,” and “API.” No default value. |
Tender Contact | Lookup(Contact) | A lookup to the Contact record associated with tendering a load via email. |
Tender Method | Picklist | The method used to tender loads. Values include: “Email,” “Fax,” “API,” and “EDI.” No default value. |
Transportation Profile | Lookup(Transportation Profile) | A lookup to the Transportation Profile record associated with the Carrier and Carrier Service. |
VLTL | Checkbox | Checked to indicate VLTL Carrier Service records. |
Volume Units | Picklist | The unit of volume for VLTL load volume. Values include: “Cubic Feet,” “Cubic Inches,” “Cubic Meters,” “Gallons,” and “Liters.” No default value. |
Weight Units | Picklist | The unit of weight for loads. Values include: “lbs” or “kg.” No default value. These fields are required to use the Carrier Service. |
Checklist Item
This Fleet Management object contains inspection report checklist item fields.
Field Name | Type | Description |
---|---|---|
Category | Picklist | The name of the item on the Inspection Report. Several values available including: “Air Lines,” “Brakes,” and “Emergency Equipment.” No default value. |
Checklist Item | Text(80) | The name of the checklist item. |
Inspection Comments | Text(255) | The comments regarding the inspection. |
Inspection Report | Master-Detail(Inspection Report) | A Master-Detail relationship to the parent Inspection Report record the Checklist item belongs to. |
Order | Number(4, 0) | The order of the items in the Inspection Report. |
Service Technician Comments | Text Area(255) | The comments from the service technician performing the inspection. |
Status | Picklist | The current state of the checklist item. Values include: “Pending,” “Passed,” and “Failed.” “Pending” is the default value. |
Claim
This object contains fields regarding damages, shorts, and other types of customer claims against defective loads.
Field Name | Type | Description |
---|---|---|
Amount Claimed | Currency(16, 2) | The monetary amount claimed for damages, etc. |
Carrier Claim Number | Text(50) | The Carrier claim system identifier if a claim was entered on the Carrier’s web site. |
Claim Date | Date | The date the user created a claim. |
Claim Number | Auto Number | The unique record claim identifier. Example: Claim {0}. |
Description | Rich Text Area(5000) | A text area to describe the details of the claim and attach images. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Claim is against. |
Status | Picklist | The state of the claim. Values include: “Open” and “Closed.” “Open” is the default value. |
Commodity
This object captures reference data related to recurring line-item commodities.
Field Name | Type | Description |
---|---|---|
Commodity Catalogue | Lookup(Commodity Catalogue) | A lookup to the Commodity Catalogue record associated with the Commodity. |
Density Maximum | Number(10, 2) | The maximum limit for filtering commodities based on the line-item density. |
Density Minimum | Number(10, 2) | The minimum limit for filtering commodities based on the line-item density. |
Description | Text(255) | A description of the commodity. |
Dimension Units | Picklist | The dimensional units for the handling unit of a commodity. Values include: “in,” “cm,” “ft,” and “m.” No default value. |
Effective Date | Date | The date the commodity becomes active. |
Expiration Date | Date | The date the commodity becomes inactive. |
Extended Price | Currency(16, 2) | The monetary cost of the commodity. |
Handling Units | Picklist | A description of the container for the commodity. Some examples include, “Barrels,” Boxes,” “Crates,” and “Other.” No default value. |
HazMat | Checkbox | If “Checked,” the line-item commodity is a hazardous material. |
HazMat Class/Division | Picklist | The HazMat category of the commodity, such as “9” or “2.1.” No default value. |
HazMat Contact | Lookup(Contact) | A lookup to the Contact record associated with the HazMat information for the commodity. |
HazMat Number | Text(4) | The United Nations number code for the HazMat material. |
HazMat Number Type | Picklist | A description of the HazMat Number. Values include: “UN” or “NA.” No default value. |
HazMat Packaging Group | Picklist | The group identifier for the packaging of HazMat materials. Values include: “I,” “II,” or “III.” No default value. |
Height | Number(16, 2) | The height of the commodity Handling Unit. |
HS Code | Text(7) | The Harmonized System (HS) code for commodity tax/tariff purposes. |
HTS Code | Text(12) | The Harmonized Tariff Schedule code for commodity tax/tariff purposes. |
HU Count | Number(18, 0) | The number of Handling Units of the commodity. |
Is Active | Formula(Checkbox) | If “Checked,” the commodity is active based on the effective and expiration dates. |
Item Number | Text(50) (External ID) | The unique identifier or SKU for the commodity. |
Length | Number(16, 2) | The length of the commodity Handling Unit. |
Name | Auto Number | The unique record identifier. Example: Commodity-{0}. |
NMFC Class | Picklist | The standard NMFC class for an LTL load. No default value. |
NMFC Number | Text(20) | The NMFC Number for an LTL load. |
Packaging Units | Picklist | The type of packaging unit. Packaging unit selections include: “Boxes,” “Cases,” Packages,” and many others. No default value. |
PU Count | Number(18, 0) | The quantity of packaging units. |
Schedule B Code | Text(12) | The Schedule B code for tax/tariff purposes. |
Stackable | Checkbox | If “Checked,” the commodity Handling Unit is stackable. |
Turnable | Checkbox | If “Checked,” the commodity Handling Unit is turn-able. |
Weight | Number(18, 0) | The weight of the commodity. |
Weight Units | Picklist | A selection of the unit of measure. Values include: “lbs” or “kg.” No default value. |
Width | Number(16, 2) | The width of the commodity Handling Unit. |
Commodity Catalogue
This object contains reference data related to recurring line-item commodities.
Field Name | Type | Description |
---|---|---|
Description | Text Area(255) | The description of the commodity catalogue. |
Global | Checkbox | If “Checked,” the catalogue can be accessed from the Enhanced Commodity Search dialog. |
Name | Text(80) | The unique record identifier. |
Contact (SFDC Object)
This is a standard Salesforce object. The TMS contributes additional fields to this object.
Field Name | Type | Description |
---|---|---|
Citizenship Country | Picklist (Multi-Select) | The contact citizenship. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Transportation Role | Picklist (Multi-Select) | The role of the contact with values: “Shipping,” “Receiving,” “HazMat,” “Quoting,” “Tendering,” “Status,” “Settlement,” “Billing,” and “Driver,” “Carrier Application Signer,” “Yard Contact,” “ACE,” and “ACI.” No default value. |
Container
This object defines the ocean/rail/drayage shipping container information for loads.
Field Name | Type | Description |
---|---|---|
Actual Arrival Date (D) | Date | The arrival date of a container to the port of discharge. |
Actual Arrival Time (D) | Time | The arrival time of a container to the port of discharge. |
Actual Departure Date (L) | Date | The departure date of a container from the port of loading. |
Actual Departure Time (L) | Time | The departure time of a container from the port of loading. |
Available Date (D) | Date | The date a container is available at the port of discharge. |
Available Time (D) | Time | The time a container is available at the port of discharge. |
Booking Number | Formula (Text) | The booking number of the ocean voyage. |
Container Number | Text(80) | The name of the container, such as “BNSF1234567.” |
Container Status | Picklist | The current state of the container. No default value. |
Container Status Comments | Text Area(255) | Comments regarding the status of the container. |
Customer | Formula (Text) | The name of the customer for the load. |
Discharged Date (D) | Date | The discharged date of a container from the port of discharge. |
Discharged Time (D) | Time | The discharged time of a container from the port of discharge. |
Earliest Pickup Date (L) | Date | The earliest pickup date for a container at the port of loading. |
Earliest Pickup Time (L) | Time | The earliest pickup time for a container at the port of loading. |
Earliest Return Date – Demurrage (L) | Date | The earliest return date for demurrage for a container at the port of loading. |
Earliest Return Time – Demurrage (L) | Time | The earliest return time to avoid demurrage for a container at the port of loading. |
Equipment Type | Lookup(Equipment Type) | A lookup to the Equipment Type record associated with the Container. |
Estimated Arrival Date (D) | Date | The estimated arrival date of a container to the port of discharge. |
Estimated Arrival Time (D) | Time | The estimated arrival time of a container to the port of discharge. |
Estimated Departure Date (L) | Date | The estimated departure date of a container from the port of loading. |
Estimated Departure Time (L) | Time | The estimated departure time of a container from the port of loading. |
Gated In Empty Date (D) | Date | The gated in empty date of a container from the port of discharge. |
Gated In Empty Time (D) | Time | The gated in empty time of a container from the port of discharge. |
Gated In Full Date (L) | Date | The gated in full date of a container at the port of loading. |
Gated In Full Time (L) | Time | The gated in full time of a container at the port of loading. |
Gated Out Empty Date (L) | Date | The gated out empty date of a container at the port of loading. |
Gated Out Empty Time (L) | Time | The gated out empty time of a container at the port of loading. |
Gated Out Full Date (D) | Date | The gated out full date of a container at the port of discharge. |
Gated Out Full Time (D) | Time | The gated out full time of a container at the port of discharge. |
Geolocation | Geolocation | The latitude and longitude location of the container. |
Geolocation as of | Date/Time | The date and time that a container location was most recently updated. |
Import/Export | Formula (Text) | The type of shipment for the container. Possibilities are “Import,” “Export,” and “Domestic.” |
Last Free Date - Demurrage (D) | Date | The date of last free demurrage for the container at the port of discharge. |
Last Free Date - Detention (D) | Date | The date of last free detention for the container at the port of discharge. |
Last Free Date - Detention (L) | Date | The date of last free detention for the container at the port of loading. |
Last Free Time - Demurrage (D) | Time | The time of last free demurrage for the container at the port of discharge. |
Last Free Time - Detention (D) | Time | The time of last free detention for the container at the port of discharge. |
Last Free Time - Detention (L) | Time | The time of last free detention for the container at the port of loading. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Container belongs to. |
Load Status | Formula (Text) | The status of the load. |
Load/Unload Type | Picklist | The loading and unloading type for the container. Values include: “Drop and Hook,” and “Live Load/Unload.” No default value. |
Loaded On Board Date (L) | Date | The date the container was loaded on board the vessel at the port of loading. |
Loaded On Board Time (L) | Time | The time the container was loaded on board the vessel at the port of loading. |
Master Bill of Lading Number | Formula (Text) | The load identifier for container tracking. |
Mode | Formula (Text) | The load’s mode name. |
Port/Terminal of Discharge | Lookup(Account) | A lookup to the Account record associated with the discharge port/terminal. |
Port/Terminal of Discharge Timezone | Formula (Text) | The discharge port/terminal IANA time zone. |
Port/Terminal of Load | Lookup(Account) | A lookup to the Account record associated with the load port/terminal. |
Port/Terminal of Load Timezone | Formula (Text) | The load port/terminal IANA time zone. |
Route Information | Long Text Area(500) | The description of the itinerary for the voyage(s) that a container will undertake. |
SCAC | Text(6) | The SCAC identifier of the ocean/rail Carrier of the container. |
Scheduled Arrival Date (D) | Date | The scheduled arrival date for a container at the port of discharge. |
Scheduled Arrival Time (D) | Time | The scheduled arrival time for a container at the port of discharge. |
Scheduled Departure Date (L) | Date | The scheduled departure date for a container at the port of loading. |
Scheduled Departure Time (L) | Time | The scheduled departure time for a container at the port of loading. |
Terminal Cut-Off Date (L) | Date | The cut—off date for the terminal at the port of loading. |
Terminal Cut-Off Time (L) | Time | The cut—off time for the terminal at the port of loading. |
Tracking | Picklist | The selection to determine if a container is tracked. Values include: “Off” or “On.” “Off” is the default value. |
Tracking Number | Text(40) (External ID) | The tracking number for the third-party API providing container tracking information. |
Tracking Provider | Text(40) | The name of the third-party API providing container tracking information. |
Vessel | Text(100) | The name of the vessel the container is on. |
Container Console Configuration
This object defines the user filters created in the Container Console.
Field Name | Type | Description |
---|---|---|
Default | Checkbox | If “Checked,” this is the default filter when the console is opened. |
Name | Text(80) | The name of the filter. |
State | Long Text Area(10000) | The JSON serialized filter definition. |
Visibility | Picklist | The selection for the visibility for the filter console. Values include: “Public” or “Private.” “Private” is the default value. |
Container/Trailer (Obsolete)
This object defines ocean container information for loads. Ocean loads will fill one or more containers.
Field Name | Type | Description |
---|---|---|
Container/Trailer Number | Text(80) | Name of container, such as “BNSF1234567”. |
Cargo Weight | Number(18, 0) | Cargo weight in container. |
Container Drop-Off Location | Text Area(255) | Where dray driver should drop container. |
Container Pickup Location | Text Area(255) | Where dray driver should pick up container. |
Contents Description | Text Area(255) | Free-form description of container contents. |
Description | Formula (Text) | Name of Equipment Type parent record. |
Equipment Type | Master-Detail(Equipment Type) | The parent Equipment Type record. |
Gross Weight | Formula (Number) | Cargo Weight + Tare Weight. |
ISO Size Type | Formula (Text) | The ISO Size Type of the parent Equipment Type record. |
ISO Type Group | Formula (Text) | The ISO Type Group of the parent Equipment Type record. |
Load | Master-Detail(Load) | The load this container is associated with. |
Maximum Weight | Number(18, 0) | The maximum loaded weight allowed for this container. |
Original Reference | Lookup(Container/Trailer) (Obsolete) | References container from customer load if this belongs to a carrier load in a freight plan. |
Overweight | Formula (Checkbox) | “true” if the maximum weight is exceeded. |
Sealing Party | Picklist | Which party has placed a seal on the container. |
Seal Number | Text(40) | The seal identifier placed on the container. |
Supplied By | Picklist | “Carrier” or “Shipper.” |
Tare Weight | Number(18, 0) | The empty weight of the container. |
Temperature Setting | Number(3,2) | The temperature setting for temperature controlled loads. |
Temperature Units | Picklist | “Fahrenheit” or “Celsius”. |
Verification Delegated | Checkbox | “true” if VGM delegated to third party. |
Verification Signature | Text(100) | Signature of VGM verifier. |
Verification Signature Date | Date/Time | Date and time of VGM signature. |
Verified Gross Mass | Number(10,2) | Verified Gross Mass of container. |
VGM Determination Date | Date/Time | Date and time of VGM determination. |
VGM Submitted | Checkbox | “true” if VGM submitted (to INTTRA). |
Volume | Number(18, 0) | Volume of line items in container. |
Volume Units | Formula (Text) | Volume units of parent load record. |
Weight Units | Formula (Text) | Weight units of parent Load record. |
Container/Trailer Line Item (Obsolete)
This object defines ocean container line item contents information for a specific load and container.
Field Name | Type | Description |
---|---|---|
Item | Auto Number | Record identifier. |
Container/Trailer | Lookup(Container/Trailer) (Obsolete) | The parent container. |
Handling Units | Formula (Text) | The handling units of the contained line item. |
Handling Unit Count | Number(18, 0) | The number of handling units in the container for the line item. |
Item Description | Formula (Text) | The line item description. |
Line Item | Master-Detail(Line Item) | The line item allocated to this container (in whole or part). |
Packaging Units | Formula (Text) | The packaging units of the contained line item. |
Packaging Unit Count | Number(18, 0) | The number of packaging units in the container for the line item. |
Summary | Formula (Text) | Computed summary of line item contents. |
Volume | Formula (Number) | Volume of line item in container. |
Volume Units | Formula (Text) | Volume units of parent line item record. |
Weight | Formula (Number) | The weight of the line item specific to this container. |
Weight Units | Formula (Text) | The line item weight units. |
Credit Limit
This object contains shared credit limit records that can be assigned to customer Transportation Profiles.
Field Name | Type | Description |
---|---|---|
A/R Current | Currency(16, 2) | The current accounts receivable monetary amount across related customers. |
A/R Past Due | Currency(16, 2) | The past due accounts receivable monetary amount across related customers. |
A/R Unbilled | Currency(16, 2) | The unbilled accounts receivable and accepted customer quotes monetary amount across related customers. |
Credit Limit Amount | Currency(16, 2) | The global credit limit monetary amount shared by related customers. |
Credit Limit Available | Formula (Currency) | The global remaining credit limit monetary amount shared by related customers. |
Credit Limit Utilized | Formula (Percent) | The global used credit limit monetary amount shared by related customers. |
Description | Text Area(255) | A description of the credit limit. |
Name | Text(80) | The unique record identifier. |
Unapplied Cash/Credit Memos | Currency(16, 2) | Any additions to the credit limit available monetary amount shared by related customers. |
Customer Invoice
This object contains load-specific invoice fields that are sent to the customer or accounting system.
Field Name | Type | Description |
---|---|---|
Accessorial Charges | Currency(16, 2) | The total accessorial monetary charges included on the invoice. |
Accounting Processed Date | Date/Time | The date and time the invoice was processed; for example, when it was exported to QuickBooks. |
Accounting Status | Picklist | Flag for the Pub/Sub Accounting integration. Values include: "Ready for Accounting," "Sent to Accounting," "Publish Error." |
Adjustments | Currency(16, 2) | This field holds any customer invoice changes that result in monetary adjustments to the Customer Invoice. The reason for these changes could be for a re-weigh, re-classification, etc. |
Balance Due | Formula (Currency) | The Balance Due field is the result of the Invoice Total field minus the Paid Amount field and the Payment Discount field. This field is Read-Only. |
Billing Account | Formula (Text) | The Billing Contact’s Account name. |
Billing Contact | Lookup(Contact) | A lookup to the Contact record associated with the Billing Account the Customer Invoice is sent to. |
Billing Contact Email | Formula (Text) | The Billing Contact email address. This field can also be used while list view filtering to find missing email addresses. |
Billing Method | Picklist | Selected method for sending a Customer Invoice. Values include: “Email,” “EDI,” or “Print.” “Email” is the default selection. |
Customer Quote | Lookup(Customer Quote) | A lookup to the Customer Quote record the Customer Invoice was created from. |
Date Sent | Date/Time | The Customer Invoice Date Sent field is set when the Customer Invoice is sent via email or as a bulk email/print of the Customer Invoices list. |
Days Past Due | Formula (Number) | The number of days past due for outstanding Customer Invoices. |
Dispute Contact | Lookup(Contact) | A lookup to the Contact record associated with the Dispute Contact for this Customer Quote. |
Dispute Date | Date/Time | The date and time a dispute was created in the TMS. |
Dispute Detail | Text Area(255) | A detailed description of the Dispute. |
Dispute Reason | Picklist (Multi-Select) | General category describing the dispute. Values include: “Pricing,” “Damaged Load,” “Late Load,” “Lost Load,” and “Other.” No default value. |
Dispute Resolution | Text Area(255) | A detailed description of resolving the dispute. |
Dispute Resolved Date | Date/Time | The date and time that a dispute is resolved. |
Dispute Status | Picklist | The current state of a dispute. Values include: “Open” or “Closed.” No default value. |
Disputed | Checkbox | “Checked” indicates a Customer Invoice is in dispute. |
EDI Processed Date | Date/Time | The date and time the Customer Invoice was sent via an EDI 210 transaction. |
Freight Charge Notes | Text(200) | Notes related to the freight cost. |
Freight Charge Quantity | Number(16, 2) | The number of freight charge cost units. |
Freight Charge Unit | Picklist | The cost type for the freight charge. No default value. |
Freight Charge Unit Price | Currency(16, 2) | The monetary cost for a unit of freight charge. |
Fuel Surcharge | Currency(16, 2) | The fuel surcharge line item monetary amount for this Customer Invoice. |
Fuel Surcharge Notes | Text(200) | Notes related to the fuel surcharge cost. |
Fuel Surcharge Quantity | Number(16, 2) | The number of fuel surcharge cost units. |
Fuel Surcharge Unit | Picklist | The cost type for the fuel surcharge. Values include: “Fixed Cost,” “Per Mile,” “Per Kilometer,” and “Percent of Freight.” No default value. |
Fuel Surcharge Unit Price | Currency(14, 4) | The monetary cost for a unit of fuel surcharge. |
Ignore Invoice Document Requirements | Checkbox | When “Checked,” allows for the creation of customer invoices without documents, particularly for Truck Ordered, Not Used cases. |
Invoice Date | Date | The date the Customer Invoice was generated. |
Invoice Due Date | Date | The date the Customer Invoice is due. |
Invoice Number | Text(80) | The Customer Invoice Number. |
Invoice Status | Picklist | The current state of a Customer Invoice. Values include: “Pending,” “Approved,” “Invoiced,” “Paid,” “Short Paid,” and “On Hold.” “Pending” is the default value. |
Invoice Status Comments | Text Area(255) | This field includes specific information when a Customer Invoice is set to “On Hold.” |
Invoice Total | Currency(16, 2) | The total monetary amount due on the Customer Invoice. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Customer Invoice belongs to. |
Master Invoice Number | Text(50) (External ID) | When a set of invoices are collected into a single email or printed as one PDF document, all member Customer Invoices will have the same Master Invoice Number. |
Net Freight Charges | Currency(16, 2) | The Net Freight Charges monetary amount. |
Paid Amount | Currency(16, 2) | The current total monetary amount paid toward this Customer Invoice. |
Payment Discount | Currency(16, 2) | Any monetary discount that can be applied to this Customer Invoice, such as advance payment. |
Payment Discount Taken | Currency(16, 2) | Any monetary discount applied to the Customer Invoice, rolled up from the child payment records. |
POD Received | Formula (Checkbox) | If “Checked,” a POD is attached to the load. |
POD Required | Checkbox | If “Checked,” a POD is required to send a Customer Invoice to the customer. |
Tax Amount | Currency(16, 2) | The rollup of monetary tax amounts from child tax records. |
Transportation Total | Currency(16, 2) | The monetary sum of the Net Freight Charges, Fuel Surcharge, and Accessorial Charges. |
Customer Invoice Accessorial
This object contains accessorial line item charges for a Customer Invoice.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the Customer Invoice Accessorial belongs to. |
Charge | Currency(16, 2) | The monetary charge on the Customer Invoice for this accessorial. |
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Invoice Accessorial belongs to. |
Name | Text(80) | The name and description of the accessorial. |
Notes | Text(200) | Optional details related to the accessorial charge. |
Payable | Checkbox | When “Checked,” the accessorial charge is considered for PayIQ. |
Quantity | Number(16, 2) | The number of units for the accessorial. |
Stop | Lookup(Stop) | A lookup to the stop this accessorial is associated with. |
Unit | Picklist | The type of accessorial cost category. There are many options including, “Fixed Cost,” “Percent of Amount,” “Per Cubic Foot,” “Per HU Position,” etc. No default value. |
Unit Price | Number(16, 2) | The per-unit monetary cost of an accessorial. |
Customer Invoice Adjustment
This object contains charges for re-weighs, re-classifications, and other unexpected load configuration issues.
Field Name | Type | Description |
---|---|---|
Adjustment Amount | Currency | The monetary amount of the Customer Invoice Adjustment. |
Category | Picklist | The type or category of Customer Invoice Adjustment. Values include: “Re-Class,” “Re-Weigh,” and “Other.” No default value. |
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Invoice Adjustment belongs to. |
Description | Text(80) | The description of the Customer Invoice Adjustment. |
Customer Invoice Document
This object defines customer-specific documents required for Customer Invoice generation.
Field Name | Type | Description |
---|---|---|
Accessorials | Text(255) | One or more applied accessorial charges that renders the Customer Invoice document required. |
Action | Picklist | Selection for including specific documentation for a Customer Invoice. Values include: “Never Include,” “Always Include,” “Always Include POD,” “Include if Present,” “Include if Accessorial Present,” and “Include if POD.” “Never Include” is the default value. |
Carrier Upload | Checkbox | If “Checked,” the document is available in document picklists to give Carriers the ability to upload this type of document. |
Customer | Lookup(Account) | A lookup to the Contact record this customer invoice document refers to. If “null” this is a global rule. |
Document Type | Picklist | Selection for the type of document this record refers to. Many document types are available. Do not make changes to the values of existing entries on the list. |
Modes | Text(255) | On or more Mode Ids whose presence makes this Customer Invoice Document record relevant. |
Name | Auto Number | The unique record identifier. Example: CID-{0}. |
Synonyms | Text(200) | Synonym used by Samsara ELD when uploading driver documents. This field is used when a document type doesn’t match what is available in the TMS. |
Customer Invoice Tax
This object contains (Canadian sales) tax records for a Customer Invoice.
Field Name | Type | Description |
---|---|---|
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Invoice Tax belongs to. |
Name | Auto Number | The unique record identifier. Example: Tax-{0}. |
Sales Tax | Lookup(Sales Tax) | A lookup to the Sales Tax record this customer invoice tax is calculated from. |
Stop | Lookup(Stop) | A lookup to the destination stop record (if unique) this customer invoice tax is calculated against. |
Tax Amount | Currency(16, 2) | The monetary amount as calculated by the Taxable Total multiplied by the Tax Rate. |
Tax Rate | Percent(3,3) | The Tax Rate percentage applied to the Taxable Total field. |
Taxable Total | Currency(16, 2) | The allocation of the total transportation monetary cost that this tax is calculated on. |
Customer Payment
This object contains any Customer Payments toward Customer Invoices.
Field Name | Type | Description |
---|---|---|
Accounting Processed Date | Date/Time | The date and time the Customer Payment was processed; for example, when it was exported to QuickBooks. |
Check/Reference Number | Text(50) (External ID) | The check or transaction number of the Customer Payment. |
Comments | Text Area(255) | Any comments related to the Customer Payment. |
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Payment belongs to. |
Description | Text(80) | The name/description of the Customer Payment. |
Discount | Currency(16, 2) | The monetary payment discount amount taken by the customer. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Customer Invoice Payment belongs to. |
Payment Amount | Currency(16, 2) | The total net payment amount. |
Payment Date | Date | The date the Customer Payment was made. |
Payment Type | Picklist | The type of payment made by the customer. Values include: “Company Check,” “ACH,” “Wire,” “Credit Card,” and “Other.” No default value. |
Customer Quote
This object contains the customer quote fields for loads or potential loads.
Field Name | Type | Description |
---|---|---|
A/R Ignore | Checkbox | Set to “Checked” for any quotes that should not contribute to A/R calculations. |
Accept Link | Formula (Text) | Email Loop Link URL for accepting a Customer Quote. |
Accessorial Charges | Currency(16, 2) | The total accessorial monetary charges for this customer quote. |
Billable Weight | Number(16, 2) | The billable weight total in the weight units of the load. The greater of DIM Weight and regular Weight. |
Billing Status | Picklist | The status of any related invoice to the customer quote. Values include: “Pending,” “Approved,” “Adjusted,” and “Invoiced.” “Pending” is the default value. |
Calculation Type | Picklist | When calculating a rate, the type of calculation to perform. Values include: “Base,” “Minimum,” and “Maximum.” No default value. |
Carrier Quote | Lookup(Carrier Quote) | A lookup to the Carrier Quote record associated with the Customer Quote. |
Comments | Text Area(255) | Any comments related to the customer quote. |
Credit Hold | Checkbox | Indicates if a Customer quote is on hold due to insufficient credit. |
Customer Contact | Lookup(Contact) | A lookup to the Contact record for the customer contact to receive the Customer Quote. |
Customer Quote | Auto Number | The unique record identifier. Example: Customer Quote {0}. |
Customer Quote Total | Currency(16, 2) | The total monetary amount quoted to a customer. This field is required to send a Customer Quote. |
Decline Link | Formula (Text) | The email loop link URL for Declining a Customer Quote. |
Deficit Charge | Currency(10,2) | The deficit charge monetary amount based on an SMC3 tariff. |
Deficit Rate | Currency(16,2) | The deficit rate based on an SMC3 tariff. |
Deficit Weight | Number(12,0) | The deficit weight in pounds based on an SMC3 tariff. |
Destination City | Text(40) | A shipment’s last stop consignee City. |
Destination Location | Lookup(Account) | A lookup to the Account record for a shipment’s last stop consignee location. |
Destination Postal Code | Text(20) | A shipment’s last stop consignee Postal Code. |
Destination State/Province | Picklist | A shipment’s last stop consignee State/Province. |
DIM Weight | Number(16, 2) | The dimensional weight as calculated by the Rate Entry. This is a Read-Only field. |
Discount | Currency(16,2) | The total monetary discount amount from an SMC3 tariff. |
Discount Percent | Percent(3,2) | The total discount percentage from an SMC3 tariff. |
Distance (Kilometers) | Number(10, 2) | Populated with the negotiated distance if this is a stored-rate quote. This field is Read-Only. |
Distance (Miles) | Number(10, 2) | Populated with negotiated distance if this is a stored-rate quote. This field is Read-Only. |
Expiration Date | Date/Time | The date and time the Customer Quote expires. |
Freight Charge Applied | Text(10) | The Net Freight Charges applied to a Customer Quote based on the tariff Rate (R), Minimum (M), or Floor (F). |
Freight Charge Notes | Text(200) | Notes describing the freight charges on the customer quote. |
Freight Charge Quantity | Number(16, 2) | The quantity of freight charge units on the customer quote. |
Freight Charge Unit | Picklist | The rate type cost of a freight charge. “Fixed Cost” is the default value, but many others are available including: “Percent of Amount,” Per Cubic Foot,” Per Gallon,” "Per HU Position," etc. |
Freight Charge Unit Price | Currency(16, 2) | The monetary cost for each freight charge unit. |
Freight Charges | Currency(16, 2) | The monetary cost of freight charges based on the SMC3 tariff. |
Freight Charges After Discount | Formula (Currency) | Freight charges after the Discount is applied from the SMC3 tariff. |
Freight Markup | Lookup(Carrier Markup) | A lookup to the Carrier Markup record associated with the Customer Quote for freight. |
Freight Surcharge | Currency(16,2) | The Freight Surcharge monetary amount. |
Freight Surcharge Application | Text(10) | Indicates whether the Freight Surcharge was applied to the Net (N) or Gross (G) Amount. |
Freight Surcharge Percentage | Percent(16,2) | Freight Surcharge percentage used to calculate the Freight Surcharge. |
Fuel Markup | Lookup(Carrier Markup) | A lookup to the Carrier Markup record associated with the Customer Quote for fuel. |
Fuel Surcharge | Currency(16, 2) | The fuel surcharge amount added to the Customer Quote. |
Fuel Surcharge Notes | Text(200) | Notes describing the fuel surcharge. |
Fuel Surcharge Quantity | Number(16, 2) | The quantity of fuel surcharge units. |
Fuel Surcharge Source | Formula (Text) | The origin of a fuel surcharge. Possible values are “TMS” or “Breakthrough Fuel.” This field is Read-Only. |
Fuel Surcharge Unit | Picklist | The type of fuel surcharge. Values include: “Fixed Cost,” “Per Mile,” “Per Kilometer,” and “Percent of Freight.” “Fixed Cost” is the default value. |
Fuel Surcharge Unit Price | Currency(14, 4) | The monetary amount of each fuel surcharge unit. |
Load | Lookup(Load) | A lookup to the Load record associated with this Customer Quote. |
Load Summary | Formula (Text) | A summary of the load origin and destination information. Included on the Customer Rate and Load Confirmation email template. |
Locked | Checkbox | If “Checked,” a Customer Quote is locked and cannot be updated. |
Messages | Long Text Area(5000) | The related field to Messages on the Carrier Quote field. Provides for the ability to store optional accessorials for ocean loads. |
Minimum Freight Charge Floor | Currency(10,2) | The Minimum Charge amount for a customer quote as defined in the Tariff Schedule. |
Movement Type | Picklist | The shipment type for ocean loads. Values include: “Door to Door,” “Door to Port,” “Port to Door,” and “Port to Port.” No default value. |
Net Freight Charges | Currency(16, 2) | The monetary amount for Freight Charges. |
Origin City | Text(40) | The origin stop city for no-load quotes. |
Origin Location | Lookup(Account) | A lookup to the Account record for the origin location for no-load quotes. |
Origin Postal Code | Text(20) | The origin postal code for no-load quotes. |
Origin State/Province | Picklist | The origin state/province code for no-load quotes. |
Pricing | Picklist | The type of rate quoted. The default value is “Spot,” and “Contract” is also available. |
Quote Date | Date | The date the Customer Quote was created. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record upon which the stored rate customer quote is based. This field is Read-Only. |
Rate per Kilometer | Formula (Currency) | The quote total divided by the distance (from quote or load). This field is Read-Only. |
Rate per Mile | Formula (Currency) | The quote total divided by the distance (from quote or load). This field is Read-Only. |
Rebate Amount | Currency(16, 2) | The rebate monetary amount as determined by the customer’s rebate program. |
Rebate Invoice | Lookup(Vendor Invoice) | A lookup to the Vendor Invoice record that contains the associated rebate invoice for the customer quote. |
Rebate Program Entry | Lookup(Rebate Program Entry) | A lookup to the Rebate Program Entry record that calculates the rebate for the customer quote. |
Routing | Text(255) | The description of complex routing information for an ocean load Customer Quote. |
Site URL | Text(200) | An internal field used to support URL links email templates. |
Status | Picklist | Value describing the state of the Customer Quote. The default value is “Pending,” and other values include: “Quoted,” “Accepted,” “Rejected,” “Cancelled,” “Expired,” and “Replaced.” |
Tariff Minimum | Currency(10, 2) | The tariff minimum monetary amount from the SMC3 tariff. |
Tax Amount | Currency(16, 2) | The rollup of “child” tax record monetary Tax Amounts. This field is Read-Only. |
Tracking Information | Text Area(255) | The IP address and browser type of the TMS Site email recipient. This field is Read-Only. |
Transportation Total | Currency(16, 2) | The monetary sum of Net Freight Charges, Fuel Surcharge, and Accessorial Charges. |
Customer Quote Accessorial
This object contains Customer Quote Accessorial charge line items.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the Customer Quote Accessorial belongs to. |
Charge | Currency(16, 2) | The monetary amount for this accessorial. |
Customer Quote | Master-Detail(Customer Quote) | The Master-Detail relationship to the parent Customer Quote record the Customer Quote Accessorial belongs to. |
Markup | Lookup(Carrier Markup) | A lookup to the Carrier Markup record associated with the Carrier Quote Accessorial. |
Name | Text(80) | The name/description of the accessorial. |
Notes | Text(200) | The optional details related to the accessorial charge. |
Payable | Checkbox | When “Checked,” the accessorial charge is considered for PayIQ. |
Quantity | Number(16, 2) | The number of units for an accessorial. |
Quote/Contract Id | Text(100) | The identifier used with the Falvey integration to match the insurance certificate number on the customer load with the accessorial record. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record associated with the Customer Quote Accessorial. |
Stop | Lookup(Stop) | A lookup to the Stop record the accessorial is associated with. |
Unit | Picklist | The type of accessorial cost category. The default value is “Fixed Cost,” and many others available including: “Percent of Amount,” “Per Additional Stop,” “Per Cubic Foot,” and “Per HU Position.” |
Unit Price | Currency(16, 2) | The per-unit monetary cost of the accessorial. |
Customer Quote Freight Charge Item
This object contains line itemized freight charges specific to a Customer Quote.
Field Name | Type | Description |
---|---|---|
Customer Quote | Master-Detail(Customer Quote) | The Master-Detail relationship to the parent Customer Quote record the Customer Quote Freight Charge Item belongs to. |
Discount % | Percent(3, 2) | The discount percent associated with this Freight Charge item. |
Discount Amount | Formula(Currency) | The discount monetary amount associated with this Freight Charge item. |
Freight Charge | Currency(10,2) | The pre-discount Freight Charge monetary amount associated with this Freight Charge item. |
Freight Charge Item Number | Auto Number | The unique record identifier. Example: Freight Charge Item-{000}. |
Item | Lookup(Line Item) | A lookup to the Line Item record this Freight Charge item relates to. |
Item Description | Text(255) | The item description of this Freight Charge item. |
Net Freight Charge | Formula(Currency) | The Freight Charge monetary amount including the Discount amount associated with this Freight Charge item. |
NMFC Class (Rated As) | Picklist | The NMFC Class for this Freight Charge item. No default value. |
Rate | Currency(10,2) | The monetary rate associated with this Freight Charge item. |
Weight | Number(18,0) | The weight in pounds of the line-item associated with this Freight Charge item. |
Customer Quote Tax
This object contains (Canadian sales) tax records for a Customer Quote.
Field Name | Type | Description |
---|---|---|
Customer Quote | Master-Detail(Customer Quote) | The Master-Detail relationship to the parent Customer Quote record the Customer Quote Tax belongs to. |
Name | Auto Number | The unique record identifier. Example: Tax-{0}. |
Sales Tax | Lookup(Sales Tax) | A lookup to the Sales Tax record this tax is calculated from. |
Stop | Lookup(Stop) | A lookup to the destination Stop record (if unique) this tax is calculated for. |
Tax Amount | Currency(16, 2) | The monetary amount of the Taxable Total multiplied by the Tax Rate. |
Tax Rate | Percent(3,3) | The Tax Rate percentage applied to the Taxable Total field. |
Taxable Total | Currency(16, 2) | The allocation of the total transportation monetary costs that this tax is calculated for. |
Customer Reference Number
This object defines customer-specific load and stop reference number requirements.
Field Name | Type | Description |
---|---|---|
Customer Reference | Auto Number | The unique record identifier. Example: Customer Reference-{0}. |
Load Validation Status | Picklist (Multi-Select) | The Load Statuses that are considered when validating the absence/presence of this customer reference number. Values include: “Tendered,” “Assigned,” “Dispatched,” “In Transit,” and “Delivered.” No default value. |
Mode | Picklist (Multi-Select) | The load Modes that will be considered when validating the absence/presence of this customer reference number. Values include: “Truckload,” “LTL,” “Intermodal,” “Drayage,” “Ocean FCL,” “Ocean LCL,” “Air Freight,” “Flatbed,” “Bulk,” and “Parcel.” No default value. |
TMS Field | Picklist | The Load and Stop fields that can be chosen as the customer reference number. Values include, “PO Number,” “PRO Number,” “Pickup/Delivery Number,” “Order Number,” and “Booking Number.” This field is dependent upon the TMS Object field. No default value. |
TMS Object | Picklist | Select the TMS object “Load” or “Stop” which controls the TMS Field dependent picklist. No default value. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Customer Reference Number belongs to. |
Customs Broker
This object defines customer-specific Customs Broker information for cross-border loads.
Field Name | Type | Description |
---|---|---|
Account | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Customs Broker belongs to. |
Broker | Auto Number | The unique record identifier. Example: Broker-{0}. |
Default | Checkbox | “Checked” for the primary Broker for a given country-to-country lane. |
Destination Country | Picklist (Multi-Select) | The lane destination country or countries for this broker. Values include: “CA,” “MX,” and “US.” No default value. |
Notes | Long Text Area(3000) | Notes specific to this Broker-Customer combination. |
Origin Country | Picklist (Multi-Select) | The lane origin country or countries for this Broker. Values include: “CA,” “MX,” and “US.” No default value. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Customs Broker belongs to. |