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
Default Accessorial
This object defines location-based default accessorial charges that should be automatically added to a load when created.
Field Name | Type | Description |
|---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the Default Accessorial belongs to. |
Name | Auto Number | The unique record identifier. Example: Acc-{0}. |
Provider | Picklist | This field indicates which party is responsible for the default accessorials. Values include: “Carrier” and “Third Party.” “Carrier” is the default value. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Default Accessorial belongs to. |
Dispatch Console Filter
This Fleet Management object contains driver and load filters defined by users for the Dispatch Console.
Field Name | Type | Description |
|---|---|---|
Default | Checkbox | If “Checked,” this filter is used when opening the Dispatch Console. |
Filter Name | Text(80) | The unique record identifier. |
Filter State | Long Text Area(10000) | Stores the filter details in JSON serialized form. |
Type | Picklist | Selection to view in the Dispatch Console. Values include: “Driver” or “Load.” No default value. |
Dock
This Fleet Management object is a child of the Transportation Profile containing dock information.
Field Name | Type | Description |
|---|---|---|
Name | Text(90) | The name of the Dock location. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Dock belongs to. |
Document Cross Reference
This object supports the HubTran integration document versioning.
Field Name | Type | Description |
|---|---|---|
Attachment ID | Text(18) (External ID) | The record ID of the related attachment. |
Document ID | Text(50) (External ID) | The HubTran record ID for the document passed through the API. |
Fingerprint | Text(100) | The unique Hashcode for a particular document version. |
Is POD | Checkbox | If "Checked," the document is a Proof of Delivery. |
Name | Auto Number | The unique record identifier. Example: XREF-{0}. |
Page Number | Number(3, 0) | The page number of the document passed by HubTran. |
Parent ID | Text(18) (External ID) | The HubTran parent ID for the document passed. |
Document Options
This object contains look-and-feel options for emails and documents created and sent to customers, Carriers, and drivers.
Field Name | Type | Description |
|---|---|---|
BOL Legal Text | Rich Text Area(10000) | The Bill of Lading legal text. |
Carrier Application Appendix | Rich Text Area(10000) | The list of payment method choices to make available in the Carrier application. Values include: “ACH (NACHA File)” and “Check.” No default value. Carrier application Appendix field. |
Carrier Application Company Instructions | Rich Text Area(5000) | The online Carrier application Company instructions field. |
Carrier Application Contact Instructions | Rich Text Area(5000) | The online Carrier application Contact instructions field. |
Carrier Application Country Select Instr | Rich Text Area(5000) | The online Carrier application country selection instructions field. |
Carrier Application Country Selection | Picklist (Multi-Select) | The online Carrier application country selection. Values include: “USA,” “Canada,” and “Mexico.” No default value. |
Carrier Application Email Template | Text(18) | The email template to send the Carrier application back to the Carrier. |
Carrier Application Enable E-Signature | Checkbox | The online Carrier application setting allows the client to show and require (or hide) the e-signature box in the Company Agreement page. “Checked” shows the E-Signature box. |
Carrier Application FMCSA Instructions | Rich Text Area(5000) | The online Carrier application FMCSA instructions field. |
Carrier Application Hide Factor Co Entry | Checkbox | If “Checked,” the Carrier application will hide the user's ability to search for a Factor company. |
Carrier Application Instructions CA | Rich Text Area(5000) | The online Carrier application Canada instructions field. |
Carrier Application Instructions MX | Rich Text Area(5000) | The online Carrier application Mexico instructions field. |
Carrier Application Instructions US | Rich Text Area(5000) | The online Carrier application US instructions field. |
Carrier Application Insure Instructions | Rich Text Area(5000) | The online Carrier application Insure instructions field. |
Carrier Application Operational Instruct | Rich Text Area(5000) | The online Carrier application Operational instructions field. |
Carrier Application Optional Sections | Text(200) | The list of optional sections to display in the Carrier application. |
Carrier Application Paym. Method Options | Picklist (Multi-Select) | The list of payment method choices to make available in the Carrier application. Values include: “ACH (NACHA File)” and “Check.” No default value. |
Carrier Application Post Submission Text | Rich Text Area(30000) | The online Carrier application instructions field. |
Carrier Application Reply To Email | The email address that the Carrier will reply to after they receive the carrier application PDF. | |
Carrier Application Require Bank Account | Checkbox | If “Checked,” the bank account information is required in the Online Carrier application. |
Carrier Application Start Instructions | Rich Text Area(30000) | The online Carrier application Start instructions field. |
Carrier Application T and C Instructions | Rich Text Area(5000) | The online Carrier application Terms and Conditions instructions field. |
Carrier Application T C Acknowledgement | Rich Text Area(1000) | The online Carrier application Terms and Conditions Acknowledgement instructions field. |
Carrier Application Terms and Conditions | Rich Text Area(100000) | The online Carrier application instructions field. |
Carrier Application Upload Instructions | Rich Text Area(5000) | The online Carrier application Upload instructions field. |
Carrier Book It Message | Long Text Area(1000) | Support text for the Carrier Book It Message used in the Email Loop support text. |
Carrier Document Request Email Template | Text(18) | Communication template for Carrier document requests. |
Carrier Load Confirm Accept Message | Rich Text Area(2000) | Text displayed upon load tender accept by the Carrier. |
Carrier Load Confirm Decline Message | Rich Text Area(2000) | Text Displayed upon load tender decline by the Carrier. |
Carrier Load Confirm Footer | Rich Text Area(10000) | Carrier Rate and Load Confirmation PDF document footer text. |
Carrier Load List Instructions | Rich Text Area(1000) | Support text for the Carrier Load List Instructions used in the Email Loop support text. |
Carrier Load Status Batch Email Template | Text(18) | Communication template selected for Carrier status email for multiple loads. |
Carrier Load Status Email Template | Text(18) | Communication template selected for Carrier status email for single loads. |
Carrier Load Tender Email Template | Text(18) | Communication template selected for the load tender email. |
Carrier Load Tender Email Template 2 | Text(18) | Communication template selected for the load tender post-accept email (used when shipper/consignee identity masking). |
Carrier Load Tender Email Template 3 | Text(18) | Communication template selected for the load tender when the load is assigned on the sending of an email. |
Carrier Load Tender Footer | Long Text Area(10000) | Text displayed in the footer on the Carrier tender accept/decline interface. |
Carrier Load Tender Instructions | Long Text Area(10000) | Text displayed on the Carrier tender accept/decline interface. |
Carrier Quotation Load Expired Message | Rich Text Area(500) | Error message to display to the Carrier in an RFP after the load has expired. |
Carrier Quotation No Longer Available | Rich Text Area(500) | Error message to display to the Carrier in an RFP after the load is not available. |
Carrier Quotation Request Email Template | Text(18) | The communication template selected for the Carrier RFQ email. |
Carrier Quotation Request Footer | Rich Text Area(10000) | The Carrier RFQ PDF document legal text footer. |
Carrier Quotation Submit Message | Rich Text Area(2000) | The message displayed when a Carrier submits a quote. |
Carrier Quotation Tender Expired Message | Rich Text Area(500) | The error message to display to the Carrier in an RFP after the quote has expired. |
Carrier Quote Footer | Rich Text Area(2000) | Support text for the Carrier Quote Footer used in the Email Loop support text. |
Carrier Quote PDF Format Options | Picklist (Multi-Select) | Defines how cost details are displayed on the PDF for a Carrier quote. Values include: “Show Freight/Fuel Details,” “Show Freight/Fuel Notes,” “Show Accessorial Details,” and “Show Accessorial Notes.” No default value. |
Carrier Quote Submit Message | Long Text Area(1000) | Support text for the Carrier Quote Submit Message used in the Email Loop support text. |
Carrier Settlement Instructions | Rich Text Area(1000) | Support text for the Carrier Settlement Instructions used in the Email Loop support text. |
Carrier Stop Status Footer | Rich Text Area(1000) | Support text for the Carrier Stop Status Footer used in the Email Loop support text. |
Carrier Stop Status Instructions | Rich Text Area(1000) | Support text for the Carrier Stop Status Instructions used in the Email Loop support text. |
Customer Default Invoice Terms | Number(4, 0) | The number of days between the customer invoice date and the invoice due date. |
Customer Invoice Batch Email Template | Text(18) | The communication template selected for batched customer invoice emails. |
Customer Invoice Email Template | Text(18) | The communication template selected for a customer invoice email. |
Customer Invoice Footer | Rich Text Area(10000) | The customer invoice PDF document legal text footer. |
Customer Invoice Header | Rich Text Area(500) | The customer invoice PDF document header. |
Customer Invoice PDF Format Options | Picklist (Multi-Select) | Defines how cost details are displayed on the PDF for the customer invoice. Values include: "Show Freight/Fuel Details," "Show Freight/Fuel Notes," "Show Accessorial Details," and "Show Accessorial Notes." No default value. |
Customer Load Confirm Accept Message | Rich Text Area(2000) | The message displayed to the customer when a quote is accepted. |
Customer Load Confirm Decline Message | Rich Text Area(2000) | The message displayed to the customer when a quote is declined. |
Customer Load Confirm Email Template | Text(18) | The communication template selected for the customer load confirmation email. |
Customer Load Confirm Footer | Rich Text Area(10000) | Customer rate and load confirmation PDF document legal text footer. |
Customer Quote PDF Format Options | Picklist (Multi-Select) | Defines how cost details are displayed on the PDF for a customer quote. Values include: “Show Freight/Fuel Details,” “Show Freight/Fuel Notes,” “Show Accessorial Details,” and “Show Accessorial Notes.” No default value. |
Default Carrier Bill To | Lookup(Account) | A lookup to the Account record this Carrier bill-to account record references. |
Document Account | Lookup(Account) | A lookup to the Account record this Document Account record references. |
Driver Decline Message | Long Text Area(2000) | The message displayed to the Driver when the confirmation is declined on the Email Loop page. |
Driver Load Confirm Email Template | Text(18) | The communication template selected for the driver load confirmation email. |
Driver Load Confirm Footer | Rich Text Area(10000) | The driver load confirmation PDF document legal text footer. |
Enable Assign Carrier on Tender Option | Checkbox | If “Checked,” allow the tender email action to set load status to Assigned (and use a different email template). |
Fleet Driver Confirm Email Template | Text(18) | The communication template selected for the Fleet Driver confirmation email. |
Global Defaults | Checkbox | “Checked” only for the global default record. |
Header Account Field Set Override | Text(20) | The field set to use for the header account instead of the default when generating a customer invoice batch PDF. |
Header Invoice Field Set Override | Text(20) | The field set to use for the header invoice instead of the default when generating a customer invoice batch PDF. |
Header Load Field Set Override | Text(20) | The field set to use for the header load instead of the default when generating a customer invoice batch PDF. |
Insurance Type Selection | Picklist (Multi-Select) | Selection for the insurance type maintained by the Carrier. Values include: “Auto,” “BIPD,” “Bond,” “Cargo,” “General,” “Workers Compensation,” and “Other.” No default value. |
Itemize Carrier Quote Accessorials | Checkbox | If “Checked,” Load accessorials are itemized for the Carrier recipient of the Carrier RFQ emails. |
Logo Id | Text(18) | A link to the logo image file. |
Mask Shipper Consignee on Carrier RFQ | Checkbox | If “Checked,” mask the shipper/consignee identity on selected Carrier documents during the Carrier RFQ process. |
Mask Shipper Consignee on Carrier Tender | Checkbox | If “Checked,” mask the shipper/consignee identity on selected Carrier documents during the Carrier tender process. |
Name | Text(80) | The name of the record, such as “Global Defaults.” |
No Documents Until Tender Accepted | Checkbox | If “Checked,” do not send the Carrier the RFQ PDF document; do not send the tender PDF document(s) until the tender is accepted. |
PAPS Footer Text | Rich Text Area(1000) | The text that appears at the bottom of the PAPS cover sheet. |
PARS Footer Text | Rich Text Area(1000) | The text that appears at the bottom of the PARS cover sheet. |
Quote Reply To Email | The email address that quote email replies from Carriers will be sent to. | |
Quote Reply To Email Option | Picklist | Selection for the email address option to send Quote replies to. Values include: “User Email” or “Default Email.” “Default Email” is the default value. |
Remit To Address | Text Area(255) | The customer invoice PDF document remit to address. |
Remove Carrier Email Template | Text(18) | The communication template selected for removing a Carrier. |
Request Tender Decline Reason | Checkbox | If “Checked,” a modal is displayed on the Carrier Guest Tender Accept/Decline component when declining a tender. |
Show Contact Info | Checkbox | If “Checked,” the shipper/consignee contact info is displayed on the Carrier rate and load confirmation PDF document. |
Suppress HazMat Column | Checkbox | When “Checked,” all HazMat column information on all documents is hidden. |
Suppress NMFC Columns | Checkbox | When “Checked,” all NMFC column information on all documents is hidden if no values for those fields is provided. |
Tender Reply To Email | The email address tender replies from Carriers are sent to. | |
Tender Reply To Email Option | Picklist | Selection for determining the Reply To Email for customer and Carrier tender emails. Values include: “User Email” or “Default Email.” “Default Email” is the default value. |
Use Billing Contact | Checkbox | When “Checked,” billing contact information is used on the customer rate and load confirmation. |
Vendor Quote PDF Format Options | Picklist (Multi-Select) | Configurable options for Vendor Rate confirmation. |
Document Options Selection Criterion
This object stores criteria for selecting the appropriate document options record for a given user and load.
Field Name | Type | Description |
|---|---|---|
Document Options | Master-Detail(Document Options) | The Master-Detail relationship to the parent Document Options record the Document Options Selection Criterion belongs to. |
Evaluation Order | Number(4, 0) | The sequence in which this rule will be evaluated. |
Mode | Lookup(Mode) | A lookup to the mode record that matches a load or Carrier to this document options record. |
Name | Auto Number | The unique record identifier. Example: Criterion-{0}. |
User Field Name | Text(40) | Field name information used in the evaluation of criteria as true or false. |
User Field Operation | Picklist | Operation selection for the evaluation of document option selection criterion. “Equals” or “Not Equal To.” No default value. |
User Field Value | Text(100) | Field value information used in the evaluation of criteria as true or false. |
Driver
This Fleet Management object contains driver information.
Field Name | Type | Description |
|---|---|---|
Activation Status | Picklist | The current state of a driver. Values include: “Active” and “Deactivated.” “Active” is the default value. |
Adverse Weather ELD Exemption | Checkbox | If “Checked,” drivers have an ELD-synced hours of service exemption due to adverse weather. |
Big Day ELD Exemption | Checkbox | If “Checked,” drivers have an ELD-synced hours of service exemption for the number of service hours in the day. |
CDL # | Text(50) | The driver’s commercial driver’s license number. |
CDL Country | Picklist | The issuing country of the CDL. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
CDL Expiration Date | Date | The CDL expiration date. |
CDL State/Province | Picklist | The issuing state/province of the CDL. This field is dependent upon the CLD Country field. No default value. |
Co-Driver | Lookup(Driver) | A lookup to the Driver record associated with the co-driver. |
Company/Division | Formula (Text) | The name of the Account company or division. |
Company/Division Id | Formula (Text) | The ID of the Account company or division. |
Contact | Lookup(Contact) | A lookup to the Contract record associated with the driver. |
Current Duty Status | Picklist | The current HOS duty status. Values include: “Driving,” “On Duty Not Driving,” “Off Duty,” “Sleeper Berth,” “Yard Move,” “Personal Conveyance,” and “Waiting Time.” No default value. |
Cycle Override | Picklist | An ELD-synced driver HOS parameter. Values include: “USA Passenger (7/60),” “USA Property (7/60),” “Unrecognized Value from API,” and many others. No default value. |
Cycle Started | Date/Time | The HOS cycle start date and time. |
Cycle Time Remaining | Number(3, 2) | An ELD-synced driver HOS parameter for time remaining for the following day. |
Cycle Time Remaining Tomorrow | Number(3, 2) | An ELD-synced driver HOS parameter for time remaining for the following day. |
Cycle Violation Duration | Number(16, 2) | An ELD-synced driver HOS parameter for the time in hours of a cycle violation. |
Do Not Hire | Checkbox | If “Checked,” the field indicates to not hire the driver. |
DOB | Date | The driver date of birth. |
Domicile | Lookup(Account) | A lookup to the Account record associated with this Domicile. |
Drive Time Remaining | Number(3, 2) | An ELD-synced driver HOS parameter for the number of remaining hours of drive time. |
Driver Manager | Lookup(User) | A lookup to the User record that is the driver’s boss. |
Driver Manager Comments | Text Area(255) | The driver manager comments. |
Driver Name | Text(80) | The unique record identifier. |
Driver Ruleset Override | Checkbox | When “Checked,” an ELD-synced driver HOS parameter that allows for overriding a driver’s ruleset. |
Drivers License | Text(20) | The personal driver’s license number of the driver. |
Drivers License Country | Picklist | The issuing country of the driver’s personal license. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Drivers License Expiration | Date | The expiration date for a driver’s personal license. |
Drivers License State/Province | Picklist | The issuing state/province for a driver’s personal license. No default value. This field is dependent on the Drivers License Country field. |
ELD Brand | Picklist | The ELD Provider the Driver belongs to. This field is sent in calls to the Catena integration. Values include: “Eroad,” “Motive,” “Samsara,” and many others. No default value. |
ELD Day Start Hour | Picklist | An ELD-synced driver HOS parameter for when the starting time of the day. Values include: “Midnight” and “Noon.” No default value. |
ELD Enabled | Checkbox | If “Checked,” the driver has an ELD device. |
ELD Exempt | Checkbox | If “Checked,” the driver has ELD-synced driver HOS parameter exemption. |
ELD Exempt Reason | Text Area(255) | An ELD-synced driver HOS parameter description for an ELD exemption. |
ELD ID | Text(50) (External ID) | The ELD Driver unique identifier. |
Emergency Contact | Text(100) | The emergency contact of the driver. |
Emergency Contact Notes | Text Area(255) | Notes regarding the emergency contact information. |
Emergency Contact Relationship | Picklist | The relationship of the emergency contact to the driver. Values include: “Spouse,” “Sibling,” “Father,” “Mother,” and “Other.” No default value. |
Employment Status | Picklist | The current employment status of the driver. Values include: “Applied,” “Hired,” and “Terminated.” No default value. |
Endorsements | Picklist (Multi-Select) | The CDL endorsements of the driver. Values include: “HazMat” and “Tanker.” No default value. |
EPayment Authorized | Checkbox | When “Checked,” the Driver is authorized to receive EPayments. |
EPayment Deductible | Checkbox | When “Checked,” EPayments for this driver are deductible from settlement. |
EPayment Fee Waived | Checkbox | When “Checked,” the EPayment Fee is waived for the driver. |
Fuel Card Driver Number | Text(6) (External ID) (Unique Case Sensitive) | The identifier for a Fuel Card when assigned to a Driver. When assigned to a Fleet Asset, the Employee ID. |
Hire Date | Date | The date the driver was hired. |
Home Address | Formula (Text) | The Driver contact mailing city and state address. |
Jurisdiction Override | Picklist | An ELD-synced driver HOS parameter for the state jurisdiction. No default value. |
Last Physical Date | Date | The date of the most recent physical for the driver. |
Medical Card Expiration Date | Date | The date the driver medical card expires. |
MVR Date | Date | The date of a Motor Vehicle Report. |
Next Physical Date | Date | The date of the next driver physical. |
Other Restrictions | Text(100) | Miscellaneous driving restrictions applied to the driver. |
Password | Text (Encrypted)(50) | The ELD Phone Application password. |
Payroll ID | Text(50) (External ID) | The payroll system ID. |
Personal Conveyance Duty Status | Checkbox | An ELD-synced driver HOS parameter that allows the driver to move a commercial motor vehicle while off-duty. |
Phone | Phone | The associated driver record phone number. |
Rest Break Override | Picklist | An ELD-synced driver HOS parameter override for rest breaks. Values include: “Property (off-duty/sleeper),” “California Mealbreak (off-duty/sleeper),” and “None.” No default value. |
Restart Override | Picklist | An ELD-synced driver HOS parameter for an override restart. Values include: “34-Hour Restart,” “24-Hour Restart,” “36-Hour Restart,” “72-Hour Restart,” and “None.” No default value. |
Restrictions | Picklist (Multi-Select) | Restrictions placed on the driver. Values include: “Vising” and “Hearing.” No default value. |
Shift Driving Violation Duration | Number(16, 2) | An ELD-synced driver HOS parameter for the number of hours in driving violation. |
Shift Time Remaining | Number(3, 2) | An ELD-synced driver HOS parameter for the number of driving hours remaining in a shift. |
Status | Picklist | The driver’s current status. Values include: “Onboarding,” “Available,” “Seated,” and “Unavailable.” No default value. |
Team | Formula (Checkbox) | When “Checked,” a co-driver is present. |
Termination Date | Date | The driver’s termination date. |
Termination Notes | Text Area(255) | The explanation for a driver’s termination. |
Termination Reason | Picklist | The driver termination reason. Values include: “Preventable Accident,” “DUI,” “Non-Adherence to Company Procedures,” “Insubordination,” and “Other.” No default value. |
Time Until Break | Number(3, 2) | An ELD-synced driver HOS parameter for the number of hours until a driver’s break. |
Timezone | Picklist | The driver’s home time zone. No default value. |
Type | Picklist | The driver employment type. Values include: “Employee” and “Independent Contractor.” No default value. |
User | Lookup(User) | A lookup to the associated User record. |
Username | Text(50) | The driver ELD Phone Application username. |
Weekly Pay Target | Currency(16, 2) | The weekly driver pay target monetary amount. |
Yard Move Duty Status | Checkbox | If “Checked,” an ELD-synced driver HOS parameter that indicates a driver is on yard move duty. |
Driver Assignment
This Fleet Management object stores long-term assignments of drivers to power units.
Field Name | Type | Description |
|---|---|---|
Driver | Lookup(Driver) | A lookup to the Driver record assigned. |
End Date | Date/Time | The ending date of the driver assignment. |
Fleet Asset | Master-Detail(Fleet Asset) | The Master-Detail relationship to the parent Fleet Asset record the Driver Assignment belongs to. |
Name | Auto Number | The unique record identifier. Example: Assignment-{0}. |
Start Date | Date/Time | The starting date of the driver assignment. |
Driver Log
This Fleet Management object contains driver HOS log header records.
Field Name | Type | Description |
|---|---|---|
Active Duration | Number(10, 2) | The number of hours of active duty. |
Adverse Driving Exemption Claimed | Checkbox | If “Checked,” the adverse driving exemption was claimed for this driver log. |
Available | Picklist | A selection for the availability of a driver log. Values include: “Yes” and “No.” No default value. |
Big Day Exemption Claimed | Checkbox | If “Checked,” the big day exemption was claimed for this driver log. |
Certification Status | Picklist | The current state of a driver log certification. Values include: “Pending” and “Certified.” No default value. |
Certified as of | Date/Time | The date and time the log was certified by the driver. |
Driver | Lookup(Driver) | A lookup to the driver record associated with this log. |
Driver Log Name | Text(80) | The unique record identifier. |
Driving Distance (Kilometers) | Number(10, 3) | The total driving distance on the log in kilometers. |
Driving Distance (Miles) | Number(10, 3) | The total driving distance on the log in miles. |
Driving Duration | Number(10, 2) | The number of hours driving recorded in the driver log. |
End Time | Date/Time | The date and time of the end of the driver log. |
Off Duty Duration | Number(10, 2) | The number of off-duty hours in the driver log. |
On Duty Duration | Number(10, 2) | The number of on-duty hours in the driver log. |
Personal Conveyance Distance (Kilometer) | Number(10, 3) | The total personal conveyance distance in kilometers in the driver log. |
Personal Conveyance Distance (Miles) | Number(10, 3) | The total personal conveyance distance in miles in the driver log. |
Personal Conveyance Duration | Number(10, 0) | The number of hours spent in personal conveyance in the driver log. |
Remarks | Text Area(255) | Comments regarding the driver log. |
Short Haul Exemption Active | Checkbox | When “Checked,” the short haul exemption was claimed on the driver log. |
Sleeper Berth Duration | Number(10, 2) | The number of hours of sleeper berth on the driver log. |
Start Time | Date/Time | The date and time of the driver log start. |
Unavailable Reason | Picklist | An explanation as to why the driver was not available. This field is dependent on the Available field. Values include: “Holiday,” “Off Day,” “Personal Day,” “Sick Day,” and “Vacation Day.” No default value. |
Waiting Time Duration | Number(10, 2) | The number of hours of wait time on the driver log. |
Yard Move Distance (Kilometers) | Number(10, 3) | The total yard move distance in kilometers on the driver log. |
Yard Move Distance (Miles) | Number(10, 3) | The total yard move distance in miles on the driver log. |
Yard Move Duration | Number(10, 2) | The number of hours of yard moves on the driver log. |
Driver Log Entry
This Fleet Management object stores driver hours of service log detail records.
Field Name | Type | Description |
|---|---|---|
Batch ID | Text(20) (External ID) | The identifier of the batch job run that created/updated driver log entry record. |
Comments | Text Area(255) | Driver log entry comments. |
Driver Log | Master-Detail(Driver Log) | The Master-Detail relationship to the parent Driver Log record the Driver Log Entry belongs to. |
Driver Log Entry | Auto Number | The unique record identifier. Example: Log Entry-{0}. |
Duration (Hours) | Number(10, 2) | The number of hours of driving activity. |
End Time | Date/Time | The driver log entry end date and time. |
Geolocation | Geolocation | The latitude and longitude of the driver log entry activity. |
Start Time | Date/Time | The driver log entry start date and time. |
Status | Picklist | The type of driver log activity. Values include: “Driving,” “On Duty Not Driving,” “Off Duty,” “Sleeper Berth,” “Yard Move,” “Personal Conveyance,” and “Waiting Time.” No default value. |
Tractor/Truck | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with the driver log entry. |
EDI Load Reference
This object contains dynamic load references that will be created on-the-fly when sending outbound EDI transactions.
Field Name | Type | Description |
|---|---|---|
Direction | Picklist | The direction (inbound or outbound) of the EDI transaction. Values include: “Outbound,” “Inbound,” and “Both.” No default value. |
EDI Location | Master-Detail(EDI Location) | The Master-Detail relationship to the parent EDI Load record the EDI Load Reference belongs to. |
Label | Text(100) | The label text that will be passed with the load reference. |
Reference Name | Auto Number | The unique record identifier. Example: Reference-{0}. |
TMS Field | Picklist | The field (API name) to pass as a load reference. Values include: “Order Date,” “PO Number,” “PRO Number,” “Arrival Date,” “Departure Date,” “Pickup/Delivery Number,” “HazMat Number,” and “Item Number.” This field is dependent on the TMS Object picklist selection. No default value. |
TMS Object | Picklist | Object selection when passing a load reference. Values include: “Load,” “Stop” and “Line Item.” No default value. |
Type | Text(30) | The Type text that will be passed with the load reference. |
EDI Location
This object contains EDI trading partner identifiers and all shippers/consignees identified in EDI 204 load tenders. It “self-fills” as EDI 204 transactions are processed and prevents duplication of the shipper, consignee, and bill-to accounts.
Field Name | Type | Description |
|---|---|---|
Auto-Accept Original 204 | Checkbox | When “Checked,” EDI 990 Accept transaction is sent automatically after receiving the Original 204 transaction. |
Auto-Accept Update 204 | Checkbox | When “Checked,” EDI 990 Accept transaction is sent automatically after receiving an Update 204 transaction. |
EDI Provider 210 Override | Picklist | Selection if invoice EDI 210 transactions are sent via a different EDI provider than the load tender 204 provider. Values include: “Kleinschmidt,” “Cleo,” “Custom EDI,” and “Do Not Send.” No default value. |
EDI Provider 214 Override | Picklist | Selection if status EDI 214 transactions are sent via a different EDI provider than the load tender 204 provider. Values include: “Kleinschmidt,” “Cleo,” “Custom EDI,” and “Do Not Send.” No default value. |
EDI Provider 990 Override | Picklist | Selection if EDI 990 tender response transactions are sent via a different EDI provider than the load tender 204 provider. Values include: “Kleinschmidt,” “Cleo,” “Custom EDI,” and “Do Not Send.” No default value. |
Location | Lookup(Account) | A lookup to the Account record that is associated with the EDI location. |
Location Code | Text(80) | Identifies the account/location. |
SCAC | Text(10) | If set, allows EDI 204 tenders from one trading partner to be spread across multiple customer account records (one account per SCAC). |
Trading Partner | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the EDI Location belongs to. |
Trading Partner 210 Override | Lookup(EDI Location) | A lookup to the other EDI Location record that should receive 210 transactions instead of this record. |
Trading Partner 214 Override | Lookup(EDI Location) | A lookup to the other EDI Location record that should receive 214 transactions instead of this record. |
Trading Partner 990 Override | Lookup(EDI Location) | A lookup to the other EDI Location record that should receive 990 transactions instead of this record. |
Trading Partner Id | Checkbox | If “Checked,” the Location Code identifies the trading partner EDI ID (as opposed to a location code for a shipper/consignee). |
Use EDI Order Update Console | Checkbox | If “Checked,” the Trading Partner uses the EDI Order Update Console to edit and Accept/Decline inbound Update 204s. |
EDI Transaction
This object contains raw XML payloads and status fields received and sent from the TMS.
Field Name | Type | Description |
|---|---|---|
Direction | Picklist | The transaction direction. Values include: “Inbound” and “Outbound.” No default value. |
EDI ID | Auto Number | The record identifier. Example: EDI-{0}. |
EDI Location | Lookup(EDI Location) | A lookup to the EDI Location record this transaction is related to. |
EDI Provider | Picklist | EDI Provider selection. Values include: “Kleinschmidt,” “Cleo,” and “Custom EDI.” No default value. |
Event Code | Text(20) | The Event Code of an EDI 214 Transaction. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the EDI Transaction belongs to. |
Purpose | Picklist | The purpose of the EDI transaction. Values include: “Original,” “Update,” and “Cancellation.” No default value. |
Status | Picklist | The current state of the EDI transaction. Values include: “Pending,” “Success,” and “Failure.” No default value. |
Status Log | Long Text Area(3000) | Displayed error message in case of failure. |
Trading Partner | Lookup(Account) | A lookup to the trading partner account this transaction is associated with. |
Transaction Payload | Long Text Area(130,000) | The raw XML transaction payload. |
Transaction Payload After Console Update | Long Text Area(130,000) | The raw XML transaction payload after it has been updated via user input from the EDI Order Update Console. |
Transaction Type | Picklist | The type of EDI transaction. Values include: “204,” “990,” “214,” “210,” “404,” “998,” “824,” “322,” and “410.” No default value. |
EDI Update Setting
This object contains XML payload received and updates to the EDI 204 load tender field-level settings.
Field Name | Type | Description |
|---|---|---|
Action | Picklist | Selection for EDI 204 updates. Values include: “Allow Updates,” “Block Updates,” “Ignore,” and “Use Stored Rate.” This field is dependent on the Data field selection. “Allow Updates” is the default value. |
Data | Picklist | Selection of the stop, line item, load, or quote data to perform an action upon. Many selections are available. No default value. |
EDI Location | Master-Detail(EDI Location) | The Master-Detail relationship to the parent EDI Location record the EDI Update Setting belongs to. |
Setting Name | Auto Number | The record identifier. Example: Setting-{0}. |
EManifest
This parent object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
Accepted Shipments Count | Roll-Up Summary (COUNT EManifest Shipment) | The number of accepted shipments on the EManifest. |
Direction | Picklist | Indicates the direction of a shipment. ACE is for Loads coming into the U.S. ACI is for Loads entering Canada. Values include: “ACE” and “ACI.” No default value. |
EManifest Number | Auto Number | The record identifier. Example: EManifest-{0}. |
Error Present | Checkbox | Field is “Checked” when the EManifest Transaction Status is Error. |
Estimated Arrival Date/Time | Date/Time | The expected date and time the Driver will arrive at the border crossing. |
Estimated Arrival Timezone | Picklist | The timezone for the arrival border crossing. |
IIT Bond Type | Picklist | The owner of the Instruments of International Traffic declared. Required for empty Instruments of International Traffic aboard. Values include: “Importer” and “Carrier.” No default value. |
Port of Arrival | Lookup(Account) | A lookup to the Account for a border crossing location. |
Released Shipments Count | Roll-Up Summary (COUNT EManifest Shipment) | The number of released shipments on the EManifest. |
Status | Picklist | The path status of the EManifest. Values include: “NONE,” “VALIDATED,” “INVALIDATED,” “SENT,” “ACCEPTED,” “REJECTED,” and “REVOKED.” “NONE” is the default value. |
Total Shipment Count | Roll-Up Summary (COUNT EManifest Shipment) | The total number of shipments on the EManifest. |
Trip Identifier | Text(21) (Unique Case Insensitive) | The unique string used by Border Connect to identify a Manifest trip. |
Trip Plan Leg | Lookup(Trip Plan Leg) | A lookup to the Trip Plan Leg the EManifest belongs to. |
Trip Plan Name | Formula (Text) | The name of the Trip Plan the EManifest belongs to. |
Truck | Lookup(Fleet Asset) | A lookup to the Fleet Asset record for the truck completing the border crossing. |
Truck Cargo Exemptions | Picklist (Multi-Select) | Required when goods are of a listed exemption type. Values include “Courier Low Value Shipment (LVS),” “Instrument of International Trade (IIT),” “Postal,” “Flying Truck,” “Emergency Repairs,” and “In-Transit.” No default value. |
Truck Seal Numbers | Text(48) | The seal number values reported on the Trip Plan Leg. |
EManifest Asset
This child of the EManifest object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
Cargo Exemptions | Picklist (Multi-Select) | Required when goods in the trailer/container are of a listed exemption type. Values include “Courier Low Value Shipment (LVS),” “Instrument of International Trade (IIT),” “Postal,” “Flying Truck,” “Emergency Repairs,” and “In-Transit.” No default value. |
EManifest | Master-Detail(EManifest) | The Master-Detail relationship to the parent EManifest record the EManifest Asset belongs to. |
EManifest Asset Name | Text(80) | The name of the EManifest Asset. |
Fleet Asset | Lookup(Fleet Asset) | A lookup to the Fleet Asset record the Emanifest Asset belongs to. |
EManifest Driver
This child of the EManifest object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
Driver | Lookup(Driver) | A lookup to the Driver record the EManifest Driver belongs to. |
EManifest | Master-Detail(EManifest) | The Master-Detail relationship to the parent EManifest record the EManifest Driver belongs to. |
EManifest Driver Name | Text(80) | The name of the EManifest Driver. |
Primary Email Address | The email address of the EManifest Driver. | |
Primary Email Receive ACE | Checkbox | When “Checked,” ACE notifications are sent to the primary email address. |
Primary Email Receive ACI | Checkbox | When “Checked,” ACI notifications are sent to the primary email address. |
Primary Email Receive Entry Numbers | Checkbox | When “Checked,” entry numbers are sent to the primary email address. |
Primary Email Receive PARS | Checkbox | When “Checked,” PARS notifications are sent to the primary email address. |
Primary Phone Number | Phone | The primary phone number of the EManifest Driver. |
Primary Phone Receive ACE | Checkbox | When “Checked,” ACE notifications are sent to the primary phone number. |
Primary Phone Receive ACI | Checkbox | When “Checked,” ACI notifications are sent to the primary phone number. |
Primary Phone Receive Entry Numbers | Checkbox | When “Checked,” entry numbers are sent to the primary phone number. |
Primary Phone Receive PARS | Checkbox | When “Checked,” PARS notifications are sent to the primary phone number. |
Secondary Email Address | The secondary email address of the EManifest Driver. | |
Secondary Email Receive ACE | Checkbox | When “Checked,” ACE notifications are sent to the secondary email address. |
Secondary Email Receive ACI | Checkbox | When “Checked,” ACI notifications are sent to the secondary email address. |
Secondary Email Receive Entry Numbers | Checkbox | When “Checked,” entry numbers are sent to the secondary email address. |
Secondary Email Receive PARS | Checkbox | When “Checked,” PARS notifications are sent to the secondary email address. |
Secondary Phone Number | Phone | The secondary phone number of the EManifest Driver. |
Secondary Phone Receive ACE | Checkbox | When “Checked,” ACE notifications are sent to the secondary phone number. |
Secondary Phone Receive ACI | Checkbox | When “Checked,” ACI notifications are sent to the secondary phone number. |
Secondary Phone Receive Entry Numbers | Checkbox | When “Checked,” entry numbers are sent to the secondary phone number. |
Secondary Phone Receive PARS | Checkbox | When “Checked,” PARS notifications are sent to the secondary phone number. |
EManifest Passenger
This child of the EManifest object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
EManifest | Master-Detail(EManifest) | The Master-Detail relationship to the parent EManifest record the EManifest Passenger belongs to. |
EManifest Passenger Name | Text(80) | The name of the EManifest Passenger. |
Passenger | Lookup(Contact) | A lookup to the Contact record the EManifest Passenger belongs to. |
EManifest Shipment
This child of the EManifest object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
Accepted | Checkbox | When “Checked,” the EManifest Shipment is accepted by customs. |
Consolidated Freight | Checkbox | When “Checked,” this denotes to customs that freight is later de-consolidated. |
Customs Broker Port Location | Lookup(Account) | A lookup to the Account location record for the U.S. customs port of the broker filing the entry. |
Direction | Picklist | The movement direction across the Canada - US border. Values include: “ACE” and “ACI.” No default value. This field controls the Shipment Type field. |
EManifest | Master-Detail(EManifest) | The Master-Detail relationship to the parent EManifest record the EManifest Shipment belongs to. |
EManifest Shipment Name | Text(80) | The name of the EManifest Shipment. |
Entry Number | Text(30) | The unique string of numbers for a customs broker. |
Estimated Exportation Date | Date | The date a Load is expected to leave the U.S. |
Goods Astray Exit Date | Date | The date a Load left the U.S. |
In Bond Foreign Destination | Text(5) | The Schedule K Code for the territory that freight is shipped to after it leaves the U.S. |
In Bond Number | Text(9) | The 9-digit In-Bond entry number sequence allocated to bonded Carriers by U.S. Customs. |
In Bond Type | Picklist | The type of In Bond shipment. Values include: “Immediate Transportation,” “Transportation and Exportation,” “Immediate Export,” and “Canada U.S. Canada In Transit.” No default value. |
In Bond US Destination | Lookup(Account) | A lookup to the Account for the US destination location. |
Loading Location | Lookup(Account) | A lookup to the Account for the location of loading if not the first stop of the Load. |
Onward Carrier | Lookup(Account) | A lookup to the Carrier Account that is the onward Carrier. |
PAPS Number | Text(16) | The shipping control number for a PAPS shipment. |
PARS Number | Text(25) | The shipping control number for a PARS shipment. |
Port Sublocation | Lookup(Account) | A lookup to the Account location for the TMS Type Customs Port. |
Regulated by FDA | Checkbox | When “Checked,” the in-bond goods are subject to U.S. FDA regulation. |
Release Office | Lookup(Account) | A lookup to the Account for the location of the customs release office. |
Released | Checkbox | When “Checked,” the Load is released by border customs. |
Shipment | Lookup(Load) | A lookup to the Load record the EManifest Shipment belongs to. |
Shipment Identifier ACE | Text(12) (Unique Case Sensitive) | The unique identifier to create the Shipment Control Number. |
Shipment Identifier ACI | Text(12) (Unique Case Sensitive) | The unique identifier to create the Shipment Control Number. |
Shipment Type | Picklist | The type of EManifest Shipment. Several values available. No default value. This field is dependent on the Direction field selection. |
Special Instructions | Text Area(255) | Field to provide customs information for overages and shortages. |
To Be Exported | Checked | When “Checked,” the shipping goods in-bond into Canada are intended to be moved to another country. |
EManifest Shipment Commodity
This child of the EManifest Shipment object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
Cargo Value USD | Number(16, 2) | The value of the line item in U.S. dollars. |
Commodity | Lookup(Line Item) | A Lookup to the line item the commodity belongs to. |
Country of Origin | Picklist | The country a commodity was created. Values include: “US,” “CA",” and “MX.” “US” is the default value. |
EManifest Shipment | Master-Detail(EManifest Shipment) | The Master-Detail relationship to the parent EManifest Shipment record the EManifest Shipment Commodity belongs to. |
EManifest Shipment Commodity Name | Text(80) | The name of the EManifest Shipment Commodity. |
Marks and Numbers | Text(48) | Identifying numbers of the EManifest Shipment Commodity. |
EManifest Shipment Party
This child of the EManifest Shipment object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
EManifest Shipment | Master-Detail(EManifest Shipment) | The Master-Detail relationship to the parent EManifest Shipment record the EManifest Shipment Party belongs to. |
EManifest Shipment Party Name | Text(80) | The name of the EManifest Shipment Party. |
Party | Lookup(Account) | A lookup to the Account the EManifest Shipment Party belongs to. |
Party Type | Picklist | The type of part on the EManifest Shipment. Many options available. No default value. |
EManifest Transaction
This child of the EManifest object contains fields for the Border Connect integration for a customs manifest. This object is used by the Border Connect integration.
Field Name | Type | Description |
|---|---|---|
Action | Picklist | The action taken on an EManifest Transaction. Values include: “VALIDATE,” “SEND,” “UPDATE,” “REVOKE,” “RESPONSE,” “DOCUMENT_REQUEST,” "and “RNS_NOTIFICATION.” No default value. |
Direction | Picklist | The movement direction across the Canada - US border. Values include: “ACE” and “ACI.” No default value. This field controls the Document Type field. |
Document Type | Picklist | They type of EManifest Transaction document. Values include: “Form A8A",” “ACE Manifest Cover Sheet,” “ACI Manifest Cover Sheet,” and more. This field is dependent on the Direction field selection. No default value. |
EManifest | Master-Detail(EManifest) | The Master-Detail relationship to the parent EManifest record the EManifest Transaction belongs to. |
EManifest Transaction Name | Text(80) | The name of the EManifest Transaction. |
Response | Long Text Area(130,000) | The EManifest Transaction response. |
Send Id | Text(68) (Unique Case Sensitive) | The EManifest Transaction Send Id. |
Status | Picklist | The EManifest Transaction Status. Values include: “PENDING,” “SUCCESS,” “ERROR,” and “TIMEOUT.” No default value. |
EPayment
This object contains the fields for the EPayment issued to a vendor.
Field Name | Type | Description |
|---|---|---|
Amount | Currency(16, 2) | The monetary amount sent via EPayment. |
Charge | Currency(16, 2) | The monetary charge to be paid by the broker to the EPayment provider. |
Credit Deduction Amount | Picklist | The monetary amount selection to deduct from the credit amount. Values include: “Amount and Payment Fee,” “Amount Only,” “Payment Fee Only,” and “None.” No default value. |
Deductible | Checkbox | When “Checked,” the EPayment Amount and Fee are considered deductible for settlement purposes. |
Description | Text(100) | Notes regarding the EPayment. |
EPayment Amount Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record used in the Vendor Invoice Accessorial record for the EPayment. |
EPayment Amount Product | Lookup(Product) | A lookup to the Product record used in the Payable Line record for the EPayment. (TMS Accounting Seed) |
EPayment Charge Accessorial | Lookup(Accessorial) | A look up to the Accessorial record used in the Vendor Invoice Accessorial record for the charge of the EPayment. |
EPayment Charge Product | Lookup(Product) | A lookup to the Product record used in the Payable Line record for the Charge of the EPayment. (TMS Accounting Seed) |
EPayment Fee Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record used in the Vendor Invoice Accessorial record for the Fee of the EPayment. |
EPayment Fee Product | Lookup(Product) | A lookup to the Product record used in the Payable Line record for the Fee of the EPayment. (TMS Accounting Seed) |
EPayment Transaction Type | Lookup(EPayment Transaction Type) | A lookup to the EPayment Transaction Type record for the EPayment. |
Fee | Currency(16, 2) | A monetary fee charged to the recipient of an EPayment. |
Funding Source | Text(80) | The name of the credentials used to issue the EPayment. |
Funding Source ID | Text(18) | The ID of the credentials record used to issue the EPayment. |
Load | Lookup(Load) | A lookup to the load record associated with this EPayment. |
Name | Auto Number | The unique record identifier. Example: ePay-{0}. |
Payment Status | Picklist | The current state of the EPayment. Values include: “Pending,” “Issued,” “Frozen,” and “Cancelled.” No default value. |
Recipient | Lookup(Contact) | A lookup to the contact record that received the EPayment. |
Recipient Email | The email associated with the recipient of the EPayment. | |
Reference Number | Text(100) | The EPayment reference number from the EPayment provider. |
Transaction ID | Text(50) | The EPayment transaction ID from the EPayment provider. |
Transaction Type Name | Formula (Text) | The name of the EPayment Transaction Type for the EPayment. |
Type | Picklist | The payment type. Values include: “Comdata Comchek” and “EFS Money Code.” “Comdata Comchek” is the default value. |
Vendor | Lookup(Account) | A lookup to the Account record for the Vendor associated with the EPayment. |
EPayment Transaction Type
This object contains the fields for the EPayment issued to a vendor.
Field Name | Type | Description |
|---|---|---|
Charge Type | Picklist | The type defines whether the charge in the EPayment Transaction Type Fee Charge object is an amount or a percentage. Values include: “Amount” and “Percentage.” No default value. |
Credit Memo Amount Default | Picklist | This option allows the user to change the Credit Deduction Amount field when an EPayment is created. Values include: “Read-Only” and “Edit.” No default value. Do not add picklist choices to this field. |
Credit Deduction Amount Default | Picklist | This option dictates what type of vendor invoice records to create, including credit memos. Values include: “Amount and Payment Fee,” “Amount Only,” “Payment Fee Only,” and “None.” No default value. Do not add picklist choices to this field. |
EPayment Txn Type Name | Text(80) | The unique record identifier. |
Fee Type | Picklist | Defines whether the fee in the EPayment Transaction Type Fee Charge object will be an amount or a percentage. Values include: “Amount” and “Percentage.” No default value. |
EPayment Transaction Type Fee Charge
This object defines the Fee and Charge amounts deducted from a Carrier invoice when an EPayment is issued for each EPayment Transaction Type.
Field Name | Type | Description |
|---|---|---|
Charge (Amount) | Currency(5, 2) | The monetary amount of the EPayment issued to the vendor. |
Charge (Percent) | Percent(3, 2) | The percentage to be paid by the broker to the EPayment provider. |
EPayment Transaction Type | Master-Detail(EPayment Transaction Type) | The Master-Detail relationship to the parent EPayment Transaction Type record the EPayment Transaction Type Fee Charge belongs to. |
Fee Amount | Currency(5, 2) | The monetary processing fee amount to be paid by the Carrier to the broker. |
Fee (Percent) | Percent(3, 2) | The percentage of the EPayment monetary amount to be paid by the Carrier to the broker. |
From Payment Amount | Currency(5, 2) | The Comchek low range to apply this processing fee. |
To Payment Amount | Currency(5, 2) | The Comchek high range to apply this processing fee. |
Transaction Type Fee Charge Name | Auto Number | The unique record identifier. Example: TTFC-{000}. |
Equipment Pool
This Fleet Management object is a child of the Transportation Profile and defines the equipment in a lot.
Field Name | Type | Description |
|---|---|---|
Aging Threshold (Days) | Number(6, 0) | The aging threshold in number of days. |
Available Empties | Number(6, 0) | The number of available empty trailers in the Equipment Pool. |
Available Loaded | Number(6, 0) | The number of available loaded trailers in the Equipment Pool. |
Current Pool Count | Formula (Number) | The number of Assets in the Equipment Pool. |
Equipment Type | Picklist | The type of equipment in the pool. Values include: “Chassis,” “Container,” and “Trailer.” |
Lot Status | Formula (Text) | The status of the lot based on the amount of equipment in the lot. Options include, “Over Pool,” “Under Pool,” and “In Range.” |
Maximum Allowed | Number(6, 0) | The maximum allowed pieces of equipment in the lot. |
Minimum Allowed | Number(6, 0) | The minimum allowed pieces of equipment in the lot. |
Name | Text(80) | The name of the equipment. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Equipment Pool belongs to. |
Transportation Profile Name | Formula (Text) | The Transportation Profile name. |
Type | Picklist | The type of equipment pool. Values include: “Secured,” and “Unsecured.” No default value. |
Equipment Type
This object defines the equipment types employed to move loads.
Field Name | Type | Description |
|---|---|---|
Blue Yonder Code | Text(50) | The Blue Yonder equipment code. |
Blue Yonder Mode | Lookup(Mode) | A lookup to the Mode record associated with the Blue Yonder equipment type. |
Border Connect Trailer Code | Picklist | The code used to generate a border Customs manifest. Many options available. No default value. |
Carrier Application | Checkbox | If “Checked,” the Equipment Type is available in the Online Carrier Application. |
Category | Picklist | The selection for the type of equipment. Values include: “Van,” “Flatbed,” “Reefer,” “Specialized,” and “Ocean/Intermodal.” “Van” is the default value. |
DAT Posting | Text(50) | The DAT equipment type for posting to the load board. |
Dimension Units | Picklist | The dimensional units for the length/width/height. Values include: “in,” “cm,” “ft,” and “m.” No default value. |
Enabled | Checkbox | If “Checked,” allow the selection of this record when setting the load equipment type. |
Height | Number(10, 1) | The height measurement of the equipment. |
ISO Size Type | Text(4) | The ocean container ISO Size Type, such as “22G0.” |
ISO Type Group | Text(4) | The ocean container ISO Type Group, such as “22GP.” |
Length | Number(10, 1) | The length measurement of the equipment. |
Max Pallets | Number(18, 0) | The maximum number of pallets that can be placed in this equipment type. |
Max Volume | Number(18, 0) | The maximum cubic dimensions available for this equipment type. |
Max Weight | Number(18, 0) | The maximum weight this equipment type can hold. |
Mode | Picklist (Multi-Select) | The available modes for this equipment type. Values include: “Truckload,” “LTL,” “Intermodal,” “Drayage,” “Ocean FCL,” “Ocean LCL,” “Air Freight,” “Flatbed,” “Bulk,” and “Parcel.” No default value. |
Name | Text(80) | The name/description of the equipment type. |
Tare Weight | Number(18, 0) | The empty weight of the container/trailer. |
TEU | Number(3, 2) | Twenty-Foot Equivalent Units. |
TransCore Posting | Text(50) | The TransCore equipment type for posting purposes. |
Trucker Tools Posting | Text(50) | The Trucker Tools equipment type for posting purposes. |
Truckstop Posting | Text(50) | The Truckstop equipment type for posting purposes. |
Volume Units | Picklist | The dimensional units for the Max Volume field. Values include: “Cubic Feet” and “Gallons.” “Cubic Feet” is the default value. |
Weight Units | Picklist | The dimensional units for the Max Weight and Tare Weight fields. Values include: “lbs” and “kg.” “Lbs” is the default value. |
Width | Number(10, 1) | The width of the equipment. |
Error Log
This object defines the fields for storing error records from Platform Events and asynchronous threads.
Field Name | Type | Description |
|---|---|---|
Exception Message | Long Text Area(32768) | The message included with the exception. |
Logging Class | Text(255) | The class where the Error Log was created. |
Exception Type | Text(255) | The type of exception causing the error. |
Name | Text(80) | The name/description of the Error log. |
Stack Trace | Long Text Area (32768) | The stack trace indicating the location of the error. |
Field Export Definition
This object defines the fields that are part of a .CSV or NACHA file.
Field Name | Type | Description |
|---|---|---|
Child Relationship Name | Text(80) | The name of the detail child relationship. |
Data Type | Picklist | The data type of the field. Values include: “Checkbox,” “Currency,” “Date,” “Datetime,” “Number,” “Percent,” “Text,” and “Time.” No default value. |
Data Type Format | Text(20) | The format to use for the field output. |
Default Value | Text(255) | The default value to use for this field. |
End Position | Number(4, 0) | End position of the field in the record. Applicable to Fixed Record Length files. |
Field Name | Picklist | The name of the field for export used for NACHA files. No default value. This field is dependent on the File type field. |
Field Size | Number(3, 0) | The size of fields on NACHA files. |
Field Value Requirement | Picklist | Selection for the field type requirements used for NACHA files. Values include: “Optional,” “Mandatory,” and “Required.” This field is dependent on the File type field. No default value. |
File Type | Picklist | The type of file for export. Values include: .csv” and “NACHA.” No default value. |
Multi-Row | Checkbox | When checked, this field is part of child (detail) relationship record. To use in conjunction with the “Child Relationship Name” field. |
Name | Auto Number | The unique record identifier. Example: FEDN-{0000}. |
Padding Character | Picklist | Used for NACHA files (future use) Values include: “Blank,” “0,” “1,” “2,” “3,” “4,” “5,” “6,” “7,” “8,” and “9.” No default value. This field is required when a Padding Justification is entered. |
Padding Justification | Picklist | Used for NACHA files (future use) Values include: “Left” and “Right.” No default value. This field is required when a Padding Character is entered. |
Record Export Definition | Master-Detail(Record Export Definition) | The Master-Detail relationship to the parent Record Export Definition record the Field Export Definition belongs to. |
Reference Field | Text(255) | The API name of the field that contains this value in a result set. |
Reference Object | Text(50) | The API name of the object for this field. |
Sequence Number | Number(4, 0) | The position of the field in the record. |
Start Position | Number(4, 0) | The beginning position in the file. |
File Export Definition
This object defines an export file that is either a .CSV or NACHA file (future use).
Field Name | Type | Description |
|---|---|---|
Create Balancing Transaction | Picklist | The selection for the creation of a balancing transaction. Values include: “Yes” and “No.” No default value. |
Description | Text Area(255) | The optional description of the export file. |
File Generator Class | Text(40) | The name of the class used to generate the file. |
File Type | Picklist | The selection of the type of file to export. Values include: .CSV,” and “NACHA.” This field is dependent upon the Create Balancing Transaction field. No default value. |
Name | Text(80) | The name of the export file. |
Query | Long Text Area(5000) | The SOQL query used for this file definition. |
End Position | Text(5000) | Optional query used to retrieve the data to generate the file. |
Query Fields | Long Text Area(1000) | The optional fields to add to the query used by this File Export Definition. |
Fleet Asset
This Fleet Management object defines fleet assets such as trucks/tractors, trailers, containers, and more.
Field Name | Type | Description |
|---|---|---|
ACE ID | Text(80) | The ID assigned by Customs and Border Protection to an ACE-registered trailer. |
Ambient Air Temperature (C) | Number(10, 3) | The ambient air temperature in degrees Celsius. |
Barometric Pressure (PSI) | Number(3, 2) | The outdoor pressure at the asset location retrieved from the ELD device. |
Battery Voltage | Number(10, 3) | The asset battery voltage retrieved from the ELD device. |
CARB Compliant | Checkbox | If “Checked,” the asset is CARB compliant. |
Chassis Axles | Picklist | The number of chassis axles on the asset. Values include: “Two-Axle,” “Three-Axle,” “Four-Axle,” and “Five-Axle.” No default value. |
Chassis Type | Picklist | The asset chassis type. Values include: “Canadian,” “Combo,” “Extendable,” “Flatbed Container Trailer,” “Gooseneck,” “Heavy-Duty,” “Lightweight,” “Rear B-Train,” and “Straight Frame.” No default value. |
Company/Division | Lookup(Account) | A lookup to the Account record this Company/Division Fleet Asset is owned by. |
Current Location | Text(200) | The current location of the asset provided by the ELD device. |
Days on Lot | Formula (Number) | The number of days a Fleet Asset has spent in an equipment pool lot. |
Domicile | Lookup(Account) | A lookup to the Account record for the domicile of a Fleet Asset. |
Drop Location | Lookup(Account) | A lookup to the Account record for the location of a fleet asset when not assigned to a driver. |
Drop Location Datetime | Date/Time | The date and time a Fleet Asset was dropped at a location. |
ELD Brand | Picklist | The ELD Provider the Fleet Asset belongs to. This field is sent in calls to the Catena integration. Values include: “Eroad,” “Motive,” “Samsara,” and many others. No default value. |
ELD ID | Text(50) (External ID) | The ELD device identifier for the fleet asset. |
ELD Last Update | Date/Time | The most recent date and time the ELD device updated the fleet asset record. |
ELD Model Number | Text(50) | The ELD device model number. |
ELD Serial Number | Text(50) | The ELD device serial number. |
Engine Coolant Temperature (C) | Number(10, 3) | The fleet asset engine coolant temperature in degrees Celsius. |
Engine RPM | Number(10, 0) | The fleet asset engine RPM retrieved from the ELD device. |
Engine State | Picklist | The current state of the fleet asset engine. Values include: “On,” “Idle,” and “Off.” Retrieved from the ELD device. No default value. |
Equipment ID | Text(50) (External ID) | The alternate fleet asset identifier. |
Equipment Type | Lookup(Equipment Type) | A lookup to the Equipment Type record for the associated trailer/chassis fleet asset. |
Fleet Asset Name | Text(80) | The unique name/description of the fleet asset. |
Fuel Card Unit Number | Text(6) (External ID) (Unique Case Insensitive) | The identifier for a Fuel Card when assigned to a Fleet Asset, the Employee ID. |
Fuel Percent Remaining | Number(3, 0) | The remaining fuel for the fleet asset retrieved from the ELD device. |
Geolocation | Geolocation | The geolocation of the fleet asset retrieved from the ELD device. |
Heading (Degrees) | Number(3, 2) | The heading of the fleet asset in motion retrieved from the ELD device. |
In Service Date | Date | The fleet asset in service date. |
Initial Odometer Reading | Number(18, 0) | The initial odometer reading of the fleet asset. |
Initial Odometer Reading Date | Date | The initial odometer reading date of the fleet asset. |
Last Location Change | Date/Time | The date and time of the most recent location change of the fleet asset. |
Last Odometer Reading | Number(18, 0) | The most recent odometer reading of the fleet asset. |
Last Odometer Reading Date | Date | The most recent odometer reading date of the fleet asset. |
Lease Date | Date | The fleet asset lease date. |
License Plate Number | Text(20) | The fleet asset license plate number. |
License Plate State | Picklist | The fleet asset license plate state/province. No default value. |
Next 90-Day Inspection | Date | The next 90-day inspection date for the fleet asset. |
Next Annual Inspection | Date | The next annual inspection date for the fleet asset. |
Odometer Unit | Picklist | The unit of measure for the fleet asset odometer. Values include: “Miles” and “Kilometers.” No default value. |
Out of Service Date | Date | The out of service date for the fleet asset. |
Parent Company/Division | Formula (Text) | The Fleet Asset’s Parent Account Name. |
Purchase Date | Date | The purchase date of the fleet asset. |
Purchase Price | Currency(16, 2) | The purchase price of the fleet asset. |
Reefer Hours | Number(18, 0) | The number of cumulative reefer hours for the fleet asset. |
Registration Expiration | Date | The date of the fleet asset registration expiration. |
Salvage Value | Currency(3, 2) | The monetary salvage price of the fleet asset. |
Speed (kph) | Number(10, 2) | The current speed in kph of the fleet asset retrieved from the ELD device. |
Speed (mph) | Number(10, 2) | The current speed in mph of the fleet asset retrieved from the ELD device. |
Spotted By | Lookup(User) | A lookup to the User record for the individual that spotted the fleet asset. |
Spotted Datetime | Date/Time | The date and time a fleet asset was spotted in the equipment pool. |
Status | Picklist | The current state of the fleet asset. Values include: “Available,” “Breakdown,” “Damaged,” and several more. This field is dependent on the Type field. No default value. |
Trailer Model | Picklist | The fleet asset trailer model. Several values are available in the picklist. No default value. |
Transponder Number | Text(30) | The fleet asset transponder identifier. |
Type | Picklist | The type of fleet asset. Values include: “Tractor,” “Trailer,” “Box Truck,” “Chassis,” and “Container.” No default value. Dependent on the Status field. |
Vehicle Make | Picklist | The fleet asset tractor make. Values include: “Freightliner,” “International,” “Kenworth,” “Mack,” “Peterbilt,” “Volvo,” “Western Star,” and “Other.” No default value. |
Vehicle Model | Picklist | The fleet asset tractor model. Many options. This field is dependent on the Vehicle Make field. No default value. |
VIN | Text(50) (External ID) (Unique Case Insensitive) | The globally unique vehicle identification number for the fleet asset. |
Warranty Cost | Currency(16, 2) | The monetary cost of the fleet asset warranty. |
Warranty Vendor | Text(50) | The fleet asset warranty vendor name. |
Year | Text(4) | The fleet asset model year. |
Fleet Assignment (Obsolete)
This Fleet Management object “marries” drivers and assets to loads. There may be more than one Fleet Assignment record for a “relay” (multi-leg) load.
Field Name | Type | Description |
|---|---|---|
Actual End Date | Date/Time | The completion date for moving a load. |
Actual Start Date | Date/Time | The actual start date for moving a load. |
Assigned | Date/Time | The date and time of the driver assignment. |
Co-Driver | Lookup(Driver) | The Co-Driver for this load. |
Distance (Kilometers) | Number(16, 2) | The distance of this “leg” of the journey in kilometers. |
Distance (Miles) | Number(16, 2) | The distance of this “leg” of the journey in miles. |
Driver | Lookup(Driver) | The driver assigned to the load. |
ELD Route ID | Text(50) (External ID) | The ELD identifier for this driver leg. |
ELD Route Stop IDs | Text(255) | List of route stop ELD IDs. |
Expected Delivery Date | Formula (Date) | The load’s expected delivery date |
Expected Ship Date | Formula (Date) | The load’s expected ship date |
Load | Master-Detail(Load) | The load this assignment is for. |
Load Status | Formula (Text) | The load’s status. |
Name | Auto Number | The unique record identifier. Example: Assignment-{0}. |
Relay | Formula (Checkbox) | “Checked” indicates a relay load. |
Relay End Date | Date/Time | The leg end date and time for relay loads only. |
Relay End Geolocation | Geolocation | The leg end geolocation for relay loads only. |
Relay End Instructions | Long Text Area(1000) | The leg end instructions for relay loads only. |
Relay End Location | Lookup(Account) | A lookup to the Account associated with the leg end location. For relay loads only. |
Relay End Position | Number(2, 1) | The stop number for the relay end position. For relay loads only. |
Relay Leg Number | Number(2, 0) | The leg number for the relay load. |
Relay Start Date | Date/Time | The relay leg start date and time. For relay loads only. |
Relay Start Geolocation | Geolocation | The relay leg start geolocation. For relay loads only. |
Relay Start Instructions | Long Text Area(1000) | The relay leg start instructions. For relay loads only. |
Relay Start Location | Lookup(Account) | A lookup to the Account record associated with the location of the relay leg start. For relay loads only. |
Status | Picklist | The current state of a load. Values include: “Pending,” “Started,” “Converted,” and “Competed.” “Pending” is the default value. |
Tractor/Truck | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with the tractor/truck for this fleet assignment. |
Trailer 1 | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with trailer 1 for this fleet assignment. |
Trailer 2 | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with trailer 2 for this fleet assignment. |
Trailer 3 | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with trailer 3 for this fleet assignment. |
Unassigned | Date/Time | The date and time the driver is removed from a load. |
Unassigned Reason | Picklist | The reason the driver is removed from a load. Values include: “Accident,” “Breakdown,” “Illness/Injury,” “Lateness/Traffic,” “Other,” “Unexcused Absence,” and “Vacation.” No default value. |
Fleet Calendar Entry
This Fleet Management object captures calendar entries for the company, assets, and drivers.
Field Name | Type | Description |
|---|---|---|
City | Text(40) | The city for the preferred location entry. |
Country | Picklist | The country for the preferred location entry. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Driver | Lookup(Driver) | A lookup to the Driver record associated with this Fleet Calendar Entry. |
End Time | Date/Time | The Fleet Calendar Entry end date and time. |
Entry | Auto Number | The unique record identifier. Example: Entry-{0}. |
Fleet Asset | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with the Fleet Calendar Entry. |
Load | Lookup(Load) | A lookup to the Load record associated with the Fleet Calendar Entry. |
Reason | Picklist | The reason for the Fleet Calendar Entry. Values include: “Weekend,” “Holiday,” “PTO,” “Medical,” “Leave,” “Training,” “Location Preference,” “Maintenance,” “Repair,” and “Inspection.” This field is dependent on the Type field. No default value. |
Repeats | Picklist | The selected period for repeating entries. Values include: “Weekly.” No default value. |
Start Time | Date/Time | Entry start date and time. |
State/Province | Picklist | The state/province for preferred location entry. This field is dependent on the Country field. No default value. |
Type | Picklist | A description of the Fleet Calendar Entry. Values include: “Company,” “Driver,” and “Fleet Asset.” No default value. |
Fleet Management Console View
This Fleet Management object for storing Fleet Management Console View filter and UI settings.
Field Name | Type | Description |
|---|---|---|
Appointment End Lead Time (Days) | Number(3, 0) | The number of days of lead time to the end of an appointment. |
Appointment Start Lead Time (Days) | Number(3, 0) | The number of days of lead time to the beginning of an appointment. |
Appointment Status | Picklist (Multi-Select) | The Fleet Load appointment status. |
Company/Division | Lookup(Account) | A lookup to the Account record associated with the Company/Division. |
Company/Division Name | Formula (Text) | The Company/Division name. |
Customer | Lookup(Account) | A lookup to the Account record associated with the customer. |
Default For | Picklist (Multi-Select) | The default selection(s) for the Fleet Management Console View. Values include: “Fleet Management,” “Trip Planning,” “Appointment Scheduling,” and “Equipment Management.” No default value. |
Display Columns | Long Text Area(1000) | The comma-separated list of columns displayed. |
Display Columns 2 | Long Text Area(1000) | The comma-separated list of columns displayed on the second grid of the LWC. |
Domicile | Lookup(Account) | A lookup to the Account record associated with the Domicile. |
Domicile Name | Formula (Text) | The name of the Account location domicile. |
Driver Status | Picklist (Multi-Select) | The current driver status. |
Equipment Pool Type | Picklist | The type of equipment pool. Values include: “Secured,” “Unsecured,” and “Both.” No default value. |
Equipment Status | Picklist (Multi-Select) | The status of the equipment in the pool. Values include “Available,” “Breakdown,” “Damaged,” and many others. No default value. |
Equipment Type | Picklist (Multi-Select) | The type of equipment in the pool. Values include “Chassis,” “Container,” and “Trailer.” No default value. |
First Stop | Lookup(Account) | A lookup to the Account location record associated with the First Stop. |
Fleet Asset Status | Picklist (Multi-Select) | The current status of the Fleet Asset. Controlled by the Fleet Asset Type field. Values include: “Available,” “Breakdown,” “Damaged,” and more. No default value. |
Fleet Asset Type | Picklist | The type of Fleet Asset. Values include: “Tractor,” “Trailer,” “Box Truck,” “Chassis,” and “Container.” No default value. |
Fleet Load Status | Picklist (Multi-Select) | The current status of the Fleet Load. Values include: “Unplanned,” “Partially Planned,” “Planned,” “Dispatched,” “Terminal Transfer,” “Pending Final,” and “Final.” No default value. |
Inbound/Outbound | Picklist | A Fleet Asset movement into our out of a Fleet zone. Values include: “Inbound,” and “Outbound.” No default value. |
Locations | Long Text Area(1000) | The locations available in the Fleet Management Console View. |
Manager | Lookup(User) | A lookup to the User record associated with the Manager. |
Order By | Text(50) | The criteria that orders the view. |
Order By Direction | Picklist | The view order. Values include: “Ascending” and “Descending.” The default value is “Ascending.” |
Owner Name | Formula (Text) | The owner of the view. |
Shared With | Text(18) | The users the view is shared with. |
Team Status | Picklist | The type of Loads displayed in the view. |
Trip Plan Default View | Checkbox | When “Checked,” the default display when viewing Trip Plans. |
View Name | Text(80) | The name of the console view. |
View Type | Picklist | The view type in the console. Values include: “Driver,” “Fleet Asset,” “Load,” “Appointment,” and “Equipment Pool.” No default value. |
Visible Rows | Number(4, 0) | The number of rows in the view. |
Zone | Lookup(Zone) | The Fleet zone in the view. |
Freight Class Calculation Rule
This object defines the NMFC Class versus the density reference data.
Field Name | Type | Description |
|---|---|---|
From Density | Number(10, 2) | The low starting range for density in pounds per cubic foot. |
Name | Auto Number | The unique record identifier. Example: Rule-{0}. |
NMFC Class | Picklist | The NMFC Class for this density range. |
To Density | Number(10, 2) | The high-end range for density in pounds per cubic foot. |
Freight Plan
This object defines fields for complex multi-load moves that require, for example, multiple stops and multiple Carriers.
Field Name | Type | Description |
|---|---|---|
All Loads Invoiced | Checkbox | If “Checked,” all customer and carrier loads have invoices. |
All Loads Quoted | Checkbox | If “Checked,” all customer and carrier loads have accepted quotes. |
Build Status (Obsolete field) | Picklist | Determined based on whether all customer loads are covered by carrier loads. Values include: “Incomplete” and “Complete.” “Incomplete” is the default value. |
Cost Allocation Method | Picklist | The selection for how carrier costs are apportioned to customer loads. Values include: “Weight,” “Linear Feet,” “Handling Unit Count,” “Packaging Unit Count,” “Distance-Weighted Handling Unit Count,” and “Distance-Weighted Packaging Unit Count.” No default value. |
Description | Text Area(255) | The description of the freight plan purpose/scenario. |
Name | Auto Number | The unique freight plan record identifier. Example: Plan-{0}. |
Recurring Load Schedule | Lookup(Recuring Load Schedule) | A lookup to the Recurring Load Schedule record for this freight plan. If this is a cloned Freight Plan, this record is the original schedule it was cloned from. |
Freight Plan Console Configuration
This object contains Freight Plan console filters and templates.
Field Name | Type | Description |
|---|---|---|
Description | Text Area(255) | A description of the filter/template in use. |
Name | Text(80) | The unique filter/template record identifier. |
State | Long Text Area(10,000) | A description of the filter/template definition as a JSON. |
Type | Picklist | The selection for the type of filter/template to use. Values include: “Customer Load Filter” and “Freight Plan Template.” No default value. |
Visibility | Picklist | The selection to determine whether a customer filter or freight plan template is visible to others. Values include: “Public” and “Private.” “Private” is the default value. |
Freight Plan Filter (OBSOLETE)
This object defines customer load filters for the Freight Planner page.
Field Name | Type | Description |
|---|---|---|
Customer | Lookup(Account) | Customer filter criterion. |
Delivery Date End | Date | Date range filter criterion. |
Delivery Date Range (Days) | Number(5, 0) | Date range filter criterion. |
Delivery Date Start | Date | Date range filter criterion. |
Delivery Date Type | Picklist | Date range type criterion. |
Description | Text Area(255) | Description of filter. |
Destination Address | Formula (Text) | Destination address formula field. |
Destination City | Text(40) | Destination filter criterion. |
Destination Country | Picklist | Destination filter criterion. |
Destination Geolocation | Geolocation | Destination latitude/longitude. |
Destination Postal Code | Text(20) | Destination filter criterion. |
Destination Radius | Number(5, 0) | Destination filter criterion. |
Destination State | Picklist | Destination filter criterion. |
Distance Units | Picklist | Radius distance units. |
Filter by Stops | Checkbox | If “true” allow only those loads going through the filter stops. |
Filter Name | Text(80) | The unique record identifier. |
HazMat Loads | Checkbox | HazMat filter criterion. |
Load Status | Picklist (Multi-Select) | Load status filter criterion. |
Maximum Linear Feet | Number(5, 0) | Linear feet filter criterion. |
Maximum Volume | Number(18, 0) | Volume filter criterion. |
Maximum Weight | Number(10, 0) | Weight filter criterion. |
Minimum Linear Feet | Number(5, 0) | Linear feet filter criterion. |
Minimum Volume | Number(18, 0) | Volume filter criterion. |
Minimum Weight | Number(10, 0) | Weight filter criterion. |
Mode | Picklist (Multi-Select) | Mode filter criterion. |
Origin Address | Formula (Text) | Origin address formula field. |
Origin City | Text(40) | Origin filter criterion. |
Origin Country | Picklist | Origin filter criterion. |
Origin Geolocation | Geolocation | Origin latitude/longitude. |
Origin Postal Code | Text(20) | Origin filter criterion. |
Origin Radius | Number(5, 0) | Origin filter criterion. |
Origin State | Picklist | Origin filter criterion. |
Plan Build Status | Picklist (Multi-Select) | Plan build status filter criterion. |
Rows per Page | Number(4, 0) | How many customer loads/line items are displayed per page. |
Sales Status | Picklist (Multi-Select) | Sales status filter criterion. |
Service Level | Picklist (Multi-Select) | Service level filter criterion. |
Ship Date End | Date | Date range filter criterion. |
Ship Date Range (Days) | Number(5, 0) | Date range filter criterion. |
Ship Date Start | Date | Date range filter criterion. |
Ship Date Type | Picklist | Date range type criterion. |
Shipper Location | Lookup(Account) | Shipper location filter criterion. |
Temperature Controlled Loads | Checkbox | Temperature Controlled load search criterion. |
View | Picklist | Load View or Line Item View. |
Volume Units | Picklist | Filter volume units. |
Weight Units | Picklist | Filter weight units |
Freight Plan Filter Stop (OBSOLETE)
This object defines the cross-dock stops associated with a Freight Plan filter.
Field Name | Type | Description |
|---|---|---|
Date Range (Days) | Number(5, 0) | Date range for load filtering. |
Date Type | Picklist | Date type for load filtering. |
End Date | Date | Date for load filtering. |
Freight Plan Filter | Master-Detail(Freight Plan Filter) | Parent freight plan filter record. |
Location | Lookup(Account) | The account representing this cross-dock location. |
Order | Number(2, 0) | The sequence number for this stop. |
Start Date | Date | Date for load filtering. |
Stop Name | Auto Number | The unique record identifier. Example: Stop-{0}. |
Freight Plan Load
This object defines the customer loads and carrier loads that make up a freight plan.
Field Name | Type | Description |
|---|---|---|
FPL Name | Auto Number | The unique record identifier. Example: FPL-{0}. |
Freight Plan | Master-Detail(Freight Plan) | The Master-Detail relationship to the parent Freight Plan record the Freight Plan Load belongs to. |
Invoice Cost Allocation | Currency(16, 2) | The monetary amount of Carrier load invoice costs allocated to this customer load. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Freight Plan Load belongs to. |
Number | Number(3, 0) | The display order of the load in the freight plan. |
Quote Cost Allocation | Currency(16, 2) | The monetary amount of Carrier load quote costs allocated to this customer load. |
Type | Picklist | The selection for the type of Freight Plan Load. Values include: “Customer” and “Carrier.” No default value. |
Freight Plan Template (OBSOLETE)
This object defines pre-configured Freight Plan “skeletons” or templates.
Field Name | Type | Description |
|---|---|---|
Category | Picklist | Category or type of template. |
Consignee Delivery Option | Picklist | Defines how loads are delivered to final destinations. |
Description | Text Area(255) | Description of template purpose. |
Shipper Pickup Option | Picklist | Defines how loads are picked up from initial origins. |
Template Name | Text(80) | Template name. |
Visibility | Picklist | “Public” or “Private.” |
Fuel Card
This Fleet Management object stores third party (Comdata, EFS) fuel cards for management in the TMS.
Field Name | Type | Description |
|---|---|---|
Allow Cash Off Network | Checkbox | A read only field that if “Checked,” the fuel card may not be used off network. |
Alternate Card Number | Text(24) (External ID) (Unique Case Insensitive) | The alternate identifier to the fuel card number. For EFS, the provider driver Id is used. For Comdata, the Card Token is used. |
Asset | Lookup(Fleet Asset) | A lookup to the Fleet Asset field linked to the fuel card. |
Assignment Type | Picklist | The entity the fuel card is assigned to. Values include: “Driver” and “Asset.” “Driver” is the default value. |
ATM Access | Checkbox | If “Checked,” the fuel card may be used at an ATM. |
Card Balance | Currency(10, 2) | For proprietary cards, the available amount of Express Cash. |
Card Type | Picklist | The fuel card type. Values include: “WEX Fleet Card,” “Comdata OnRoad,” and “Comdata Proprietary.” No default value. This field is dependent on the Fuel Card Provider field. |
Cash Enabled | Checkbox | A read only that if “Checked,” is set when express cash is active. |
Cash Limit | Currency(8, 2) | A read only field that is set to the Cash Limit value. |
Cash Reset Day(s) of Week) | Picklist (Multi-Select) | The day(s) of the week when the cash limit for a fuel card resets. Values include: “Monday,” “Tuesday,” “Wednesday,” “Thursday,” “Friday,” “Saturday,” or “Sunday.” No default value. |
Cash Used | Currency(8, 2) | A read only field containing the value of the cash used from the fuel card. |
Company Reference Number | Text(15) | The company cross reference value assigned to the fuel card. |
Credentials Record Id | Text(18) (External ID) | The EFS credentials associated with the card for multiple credentials. |
Diesel Gallon Limit | Number(5, 0) | A read only field containing the limit value of remaining gallons of diesel. |
Driver | Lookup(Driver) | A lookup to the driver record that is currently using the fuel card. |
Employee Number | Formula (Text) | The Unit Number for a related Fleet Asset or the Driver Employee Number. |
Expiration Date | Date | The date the fuel card expires. |
Fuel Card Name | Text(80) | The name of the fuel card. |
Fuel Card Provider | Picklist | The selection for the fuel card provider. Values include: “Comdata” and “EFS.” “EFS” is the default value. This field controls the Card Type field. |
Fuel Limit | Currency(8, 2) | The amount that can be spent on fuel. |
Fuel Purchase Allowed | Checkbox | A read only field that if “Checked,” allowing for fuel purchases with a fuel card. |
Fuel Reset Days of Week | Picklist | The day(s) of the week when the fuel limit for a fuel card resets. Values include: “Monday,” “Tuesday,” “Wednesday,” “Thursday,” “Friday,” “Saturday,” or “Sunday.” No default value. |
Fuel Used | Currency(8, 2) | For limit-based cards, the amount spent on fuel. |
Hand Enter | Picklist | The selection for manually entering fuel card information. Values include: “Allow,” “Disallow,” and “Policy.” No default value. |
Hashed Card Number | Text(50) (Unique Case Insensitive) | The hashed card number sent from Comdata for security purposes. |
Last Transaction | Text(10) | The transaction number of the most recent fuel card transaction. |
Last Used Date | Date | The date the card was most recently used. |
Limit Source | Picklist | The selection for the source of a fuel card limit. Values include: “Policy,” “Card,” and “Both.” No default value. |
Masked Card Number | Text(24) | The last four digits of a Comdata fuel card number for search purposes. |
Multiple Transactions in an Hour | Checkbox | A read only field that when “Checked” allows for multiple transactions on a fuel card in a one hour period. |
One Time Cash Limit | Currency(8, 2) | The allowed amount of cash spent at one time for limit-based cards. |
One Time Fuel Limit | Currency(8, 2) | The allowed amount spent on fuel at one time for limit-based cards. |
Payroll Use | Picklist | The selection to determine how fuel card transactions are determined for accounting purposes. Values include: “Payroll,” “Payroll and Normal,” “Normal,” “Debit,” and “Debit with Limits.” No default value. |
Policy Number | Number(3, 0) | The policy number the card belongs to. |
Reefer Gallon Limit | Number(5, 0) | A read only field set to the allowed reefer gallon limit. |
Status | Picklist | The current state of the fuel card. Values include: “Active,” “Inactive,” “Hold,” “Lost,” “Permanent Hold,” and “Deleted.” No default value. |
Fuel Card Advance
This Fleet Management object captures funds issued to a Fuel Card within the TMS.
Field Name | Type | Description |
|---|---|---|
Amount | Currency(12, 2) | The monetary amount in USD for funds issued to the fuel card in advance. |
Amount Loaded | Currency(12, 2) | The original monetary amount loaded onto the fuel card. |
Confirmation Number | Text(50) (External ID) | The confirmation number returned by the fuel card provider. |
Fees | Currency(12, 2) | The total monetary amount of fees charged for the fuel card advance. |
Fuel Card | Master-Detail(Fuel Card) | The Master-Detail relationship to the parent Fuel Card record the Fuel Card Advance belongs to. |
Funding Type | Picklist | The funding type to advance to the fuel card. Values include: "Cash" and "SmartFunds." No default value. |
Load | Lookup(Load) | A lookup to the associated Load record the fuel card advance is associated with. |
Name | Auto Number | The unique record identifier. Example: FCA-{0}. |
Reference Number | Text(24) (External ID) | The reference number set in the TMS for the fuel card advance. |
Subtract Fees | Checkbox | If “Checked,” Comdata fees are subtracted from the issued amount. |
Fuel Card Authority
This Fleet Management object defines the permissions a user has for performing tasks with fuel cards.
Field Name | Type | Description |
|---|---|---|
Fuel Card Authority Name | Text(80) | The name of the fuel card authority. |
Fuel Card Permissions | Picklist(Multi-Select) | The selected permissions for a user. Values include: “Activate,” “Deactivate,” “Hold,” “Delete,” “Add,” “Subtract,” “Limit,” and “PIN.” No default value. |
User | Lookup(User) | A lookup to the user the fuel card authority is associated with. |
Fuel Card Transaction
This Fleet Management object defines financial transactions for a fuel card.
Field Name | Type | Description |
|---|---|---|
Billing Currency | Picklist | For single currency orgs where the transaction currency needs to be captured. Values include: “USD” and “CAD.” No default value. |
Comdata Key | Formula (Text) | The Transaction ID and the Invoice Number. |
Driver | Lookup(Driver) | A lookup to the Driver associated with the fuel card transaction. |
Fleet Asset | Lookup(Fleet Asset) | A lookup to the Fleet Asset associated with the fuel card transaction. |
Fuel Card | Master-Detail(Fuel Card) | The Master-Detail relationship to the parent Fuel Card record the Fuel Card Transaction belongs to. |
Hand Entered | Checkbox | If “Checked,” the fuel card number was manually entered for a transaction. |
Invoice Number | Text(24) | The identifier for tracking split transactions. |
Location Chain | Text(255) | The name of the location chain where the fuel card transaction occurred. |
Location City | Text(255) | The city location of the fuel card transaction. |
Location Country | Picklist | The country location of the fuel card transaction. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Location Postal Code | Text(10) | The postal code location of the fuel card transaction. |
Location State/Province | Picklist | The state or province of the fuel card transaction. This field is dependent on the Location Country field selection. |
Location Street | Text(255) | The Street address location of the fuel card transaction. |
Name | Auto Number | The unique record identifier. Example: FCT-{0}. |
Supplier ID | Text(6) | The fuel card provider ID assigned to the transaction merchant. |
Transaction Amount | Currency(16, 2) | The total monetary amount of the fuel card transaction. |
Transaction Date | Date/Time | The date and time the fuel card transaction occurred. |
Transaction ID | Text(40) (External ID) | The fuel card provider ID assigned to the transaction. |
Transaction Type | Text(255) | The type of fuel card transaction. |
Fuel Card Transaction Line Item
This Fleet Management object defines one to many relationships for items associated to a Fuel Card Transaction.
Field Name | Type | Description |
|---|---|---|
Amount | Currency(16, 2) | The total monetary amount of the line item. |
Category | Text(36) | The category of the line item. |
Deductible | Checkbox | If "Checked," the line item is deductible. |
Fuel Card Transaction | Master-Detail(Fuel Card Transaction) | The Master-Detail relationship to the parent Fuel Card Transaction record the Fuel Card Transaction Line Item belongs to. |
Fuel Type | Text(30) | The type of fuel for the line item if applicable. |
Line Number | Number(18, 0) | Fuel card provider designated line item number. |
Name | Auto Number | The unique record identifier. Example: Item-{0}. |
Quantity | Number(8, 3) | The quantity of the purchased item. |
Unit Price | Number(8, 3) | The price per unit. |
Use Type | Text(20) | The fuel use type for the line item. |
Fuel Index
The Fuel Index object defines the gas/diesel indexes (usually per EIA) used in fuel surcharge objects to calculate customer and carrier quote fuel surcharges.
Field Name | Type | Description |
|---|---|---|
Data Series Id | Text(100) | The EIA weekly data series Id, such as “PET.EMD_EPD2D_PTE_NUS_DPG.W.” |
Name | Text(80) | The name of the fuel index (usually an EIA designation). |
Fuel Index History
The Fuel Index History object is the repository of the weekly gas/diesel index prices used in the fuel surcharge object to calculate customer and Carrier quote fuel surcharges.
Field Name | Type | Description |
|---|---|---|
Effective Date | Date | The effective date of the index value (usually a Monday for EIA indexes). |
Fuel Index | Master-Detail(Fuel Index) | The Master-Detail relationship to the parent Fuel Index record the Fuel Index History belongs to. |
Name | Auto Number | The unique record identifier. Example: Index-{0}. |
Value | Currency(4, 3) | The monetary value of the index as of the effective date. |
Fuel Surcharge
This object contains fuel surcharge schedule setup information.
Field Name | Type | Description |
|---|---|---|
Auto-Update Quotes/Invoices | Picklist | Selection that determines if the fuel calculation is frozen or can be updated if the fuel index changes. Values include: “Yes” and “No.” “Yes” is the default value. |
Current Week Start Day | Picklist | The day of the week considered the start of the week for fuel index selection purposes. Values include: “Sunday,” “Monday,” “Tuesday,” “Wednesday,” “Thursday,” “Friday,” and “Saturday.” “Monday” is the default value. |
Fuel Index | Master-Detail(Fuel Index) | The Master-Detail relationship to the parent Fuel Index record the Fuel Surcharge belongs to. |
Fuel Index End | Currency(6, 3) | The ending/highest fuel index monetary cost in the schedule. |
Fuel Index Increment | Currency(6, 3) | The fuel index increment amount for the schedule from entry to entry. |
Fuel Index Start | Currency(6, 3) | The starting/lowest fuel index monetary cost in the schedule. |
Fuel Index Value | Picklist | The selection for which fuel index to use in the fuel surcharge calculation. Values include: “Current Week,” “Prior Week,” “Two-Week Average,” “Three-Week Average,” “Four-Week Average,” and “Prior Calendar Month.” “Current Week” is the default value. |
Fuel Surcharge Source | Picklist | The selection choice for the source of fuel surcharges. Values include: “TMS” and “Breakthrough Fuel.” “TMS” is the default value. |
Name | Text(80) | The fuel surcharge schedule name. |
Percent Increment | Percent(3, 2) | The percent increment from entry to entry for percent-of-line-haul fuel surcharges. |
Percent Start | Percent(3, 2) | The percent start for percent-of-line-haul fuel surcharges. |
Rate Increment | Currency(6, 8) | The rate increment monetary amount from entry to entry for rate-per-mile fuel surcharges. |
Rate Start | Currency(6, 3) | The initial monetary amount for rate-per-mile fuel surcharges. |
Type | Picklist | Selection for the type of fuel surcharge object. Values include: “Percent of Line Haul,” “Rate per Mile,” and “Rate per Kilometer.” “Percent of Line Haul” is the default value. |
Fuel Surcharge Entry
This object contains the ordered entries for a fuel surcharge schedule/object.
Field Name | Type | Description |
|---|---|---|
Entry | Text(80) | The fuel surcharge entry name. |
From Value | Currency(6, 3) | The fuel surcharge entry gas price minimum monetary amount. |
Fuel Surcharge | Master-Detail(Fuel Surcharge) | The Master-Detail relationship to the parent Fuel Surcharge record the Fuel Surcharge Entry belongs to. |
Percent | Percent(3, 2) | The percent-of-line-haul amount. |
Rate | Currency(6, 4) | The rate-per-mile monetary amount. |
Row | Number(5, 0) | The row number within the fuel surcharge schedule. |
To Value | Currency(6, 3) | The fuel surcharge entry gas price maximum monetary amount. |