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. Following the TMS objects are the Accounting Seed objects and fields that are added when installing the Accounting Seed package.
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!
Accessorial
The Accessorial object contains pre-populated, read-only reference data that describes “generic” accessorial charges defined in the TMS. You may add to this list, but please do not delete or modify existing records.
Field Name | Type | Description |
---|---|---|
Customer Charge Code | Text(20) | When populated, these codes are included in EDI 210 transactions. |
Customer Portal Selection | Checkbox | If “Checked,” the accessorial is available within the Customer Portal. |
Enabled | Checkbox | If “Checked,” the accessorial is visible and available for use. |
Mode | Picklist (Multi-Select) | The mode(s) this accessorial applies to. Values include: “Truckload,” “LTL,” “Intermodal,” “Drayage,” “Ocean FCL,” “Ocean LCL,” ‘Air Freight,” “Flatbed,” “Bulk,” and “Parcel.” No default value. |
Name | Text(80) | The name and description of the accessorial. |
Pre-Quote | Checkbox | “Checked” means an accessorial is available when configuring a load. |
Type | Picklist | The accessorial is applied on: “Pickup,” “Delivery,” or the “Load.” No default value. |
Accessorial Exclusion
The Accessorial Exclusion object contains records that allow for Carriers that do not support a set of accessorial types to be excluded from loads.
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A Lookup to the associated Accessorial name/description record. |
Accessorial Exclusion Name | Auto Number | The unique record Identifier. Example: AE-{0}. |
Carrier Service | Lookup(Carrier Service) | A lookup to the associated Carrier Service record. |
Carrier Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Accessorial Exclusion belongs to. |
Effective Date | Date | The date an exclusion begins. If a load’s Stop One Expected Date is less than the Exclusion Effective Date, then the exclusion is not applied. |
Exclusion Type | Formula (Text) | The exclusion is applied on: “Pickup,” “Delivery,” or the “Load.” |
Expiration Date | Date | The date an exclusion expires. If the load’s Stop One Expected Date is greater than the Exclusion Expiration Date, then the exclusion is not applied. |
Lane | Lookup(Lane) | A lookup to the Lane record associated with the lane to apply the exclusion. (Only select a lane or a location). |
Location | Lookup(Account) | A lookup to the Account record associated with the location to apply the exclusion. (Only select a lane or location). |
Reason | Text(100) | The description of the exclusion. |
Account (SFDC Object)
The Account object is the foundational object of Salesforce. Note that customers, shippers, consignees, and carriers are all modeled as Account records.
Field Name | Type | Description |
---|---|---|
Accounting Status | Picklist | Flag for the Pub/Sub Accounting integration. Values include: "Ready for Accounting," "Sent to Accounting," "Publish Error." |
Customer Sales Rep | Lookup(User) | A lookup to the User record associated with the Customer Sales Rep Account. |
DBA Name | Text(80) | The Doing Business As Name. |
Default Payment Method | Picklist | The selection for the payment method. Values include: “ACH" (NACHA File), “Check.” No default value. |
Posting City | Text(40) | The Posting City alias for load boards. |
Posting State/Province | Picklist | The Posting State/Province alias for load boards. No default value. |
Shipping Latitude for Reports | Formula (Number) | Latitude coordinates for supporting TMS Analytics. |
Shipping Longitude for Reports | Formula (Number) | Longitude coordinates for supporting TMS Analytics. |
Transportation Profile | Lookup(Transportation Profile) | A Lookup to the associated Transportation Profile record for the associated Account. |
Timezone | Picklist | The time zone for the account. No default value. |
TMS Type | Picklist (Multi-Select) | A selection for the account type. Values include: “Prospect,” “Customer,” “Shipper/Consignee,” “Carrier,” “Customs Broker,” “Factoring Company,” etc. No default value. |
TMS Type for Sharing | Text(100) | The sharing rule compatible copy of the TMS Type field. |
UN Location Code | Text(6) | The UN Location code. Example: “CAMTR” for Montreal. Required for Ocean Full Container Loads. |
Account ELD
This Fleet Management object contains ELD-specific location information for this account.
Field Name | Type | Description |
---|---|---|
Account | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Account ELD belongs to. |
ELD ID | Text(50) (External ID) | The ELD provider identifier for this account/location. |
ELD Provider | Picklist | The only ELD Provider, “Samsara“ is selected by default. |
Geofence Radius | Number (10, 0) | The Geofence radius for arrival/departure events. Circle only. |
Geofence Type | Picklist | The shape of the Geofence: “Circle” or “Polygon.” “Circle” is the default value. |
Geofence Units | Picklist | The measurement units for the Geofence: “ft” or “m.” “Ft.” is the default value. |
Name | Auto Number | The unique record identifier. Example: ELD-{0}. |
Advance Payment Authority
This object defines EPayment issuance authority levels for TMS users.
Field Name | Type | Description |
---|---|---|
Contact | Lookup(Contact) | A lookup to the associated Contact record. |
Default EPayment Credentials | Text(18) | The Credentials ID for EPayments. |
ePayment Recipient Required | Checkbox | "Checked" means a user requires a recipient when saving or issuing an EPayment. |
Issue Authority | Picklist | The type of authority the current user has to issue EPayments. Values include: “Assigned Carrier Only,” “Any Authorized Vendor,” and “Assigned Driver Only.” No default value. |
Name | Auto Number | The unique record identifier. Example: Auth-{0}. |
Per Day Count | Number(2,0) | The maximum number of EPayments that a user can issue per day. |
Per Day Max | Currency(5, 0) | The maximum monetary amount that a user can issue per day. |
Per Load Limit | Percent(5, 0) | The percent of the approved Carrier quote total for a load that can be issued as a Comchek. |
Per Load Maximum | Currency(5, 0) | The maximum monetary amount that can be issued as a Comchek for one load. |
User | Lookup(User) | A lookup to the associated user record granted authority. |
Advance Payment Authority Credentials
This object defines the credentials that users with Advance Payment Authority can issue EPayments.
Field Name | Type | Description |
---|---|---|
Advance Payment Authority | Master-Detail(Advance Payment Authority) | The Master-Detail relationship to the parent Advance Payment Authority record the Advance Payment Authority Credentials belong to. |
Credentials | Text(18) | The ID of the Credentials record. |
Advance Payment Authority Txn Type
This object defines the EPayment Transaction Types that users with Advance Payment Authority are allowed to issue EPayments for.
Field Name | Type | Description |
---|---|---|
Advance Payment Authority | Master-Detail(Advance Payment Authority) | The Master-Detail relationship to the parent Advance Payment Authority record the Advance Payment Authority Txn Type belongs to. |
EPayment Transaction Type | Master-Detail(EPayment Transaction Type) | The Master-Detail relationship to the parent EPayment Transaction Type record the Advance Payment Authority Txn Type belongs to. |
Advance Payment Fee
This object defines the Carrier Advance Payment Fee schedule rows.
Field Name | Type | Description |
---|---|---|
Charge | Currency(5, 2) | The monetary amount for the charge paid via EFS/Comchek. |
Fee | Currency(5, 2) | The monetary amount paid to the broker. |
From Payment Amount | Currency(5, 2) | The monetary amount sent via EFS/Comchek and cannot be greater than the “To Payment Amount” field. |
Name | Auto Number | The unique record identifier. Format: Fee-{0}. |
To Payment Amount | Currency(5, 2) | The monetary amount sent via EFS/Comchek. |
API Accessorial
This object defines API-specific accessorial codes used in quoting and tendering loads while using API integrations such as Project44.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the API Accessorial belongs to. |
API Provider | Picklist | The API provider using the accessorial code. Values include: “Project44,” “Worldwide Express,” “Blue Grace,” “AccuFrate,” and “Banyan.” No default value. |
Code | Text(80) | The Carrier API-specific code for the accessorial. |
Subcode | Text(50) | The Banyan API-specific subcode for the accessorial. This field is required for the Banyan API integration. |
Bank Account
This object defines Bank Account information for various accounts such as Carriers, Factoring companies, and vendors.
Field Name | Type | Description |
---|---|---|
Account | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Bank Account belongs to. |
Account Number | Text (Encrypted)(17) | The account number for the payment destination financial institution. |
Account Type | Picklist | The bank Account Type. Values include: “Checking” and “Savings.” No default value. |
ACH Active | Checkbox | The active bank account for the vendor. When “Checked,” Account Type, Routing Number, and Account Number are required fields. |
ACH Company Discretionary Data | Text(20) | The NACHA field for a Company’s internal use. |
ACH Company Information | Text(40) | The NACHA field for the Immediate Origin, FEIN, or Taxpayer Identification Number. |
ACH Company Name | Text((16) | The NACHA field representing the Payer’s company name. |
ACH Immediate Origin Name | Text(23) | The NACHA field for a Company Name originating the payment. |
ACH Payee Name | Text(22) | The NACHA field for the company name receiving the payment. |
ACH Reference Code | Text(3) | The NACHA field that contains the prefix value for the reference code on the header record. |
ACH Remittance Document | Picklist | The type of remittance document. Values include: “ACH Remittance Detail” and “ACH Remittance Summary.” No default value. |
Bank Name | Text(40) | The name financial institution for the payment destination. |
Confirm Account Number | Text Encrypted(17) | The second account number entry for confirmation purposes. |
Routing Number | Text(9) | The routing number of the financial institution for the payment destination. |
Carrier Equipment Type
This object tracks which equipment types are available for a given Carrier’s Transportation Profile.
Field Name | Type | Description |
---|---|---|
Equipment Type | Master-Detail(Equipment Type) | The Master-Detail relationship to the parent Equipment Type record the Carrier Equipment Type belongs to. |
Name | Auto Number | The unique record identifier. Format: Equipment-{0}. |
Number | Number(18-0) | The quantity of equipment type the Carrier operates. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Carrier Equipment Type belongs to. |
Carrier Exclusion
This object defines Carriers that are not used for a given Account and Transportation Profile.
Field Name | Type | Description |
---|---|---|
Carrier | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Carrier Exclusion belongs to. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record to exclude. |
Effective Date | Date | The start date for the Carrier exclusion. |
Exclusion Type | Picklist | The stop type to exclude selection. Values include: “Exclude Pickup,” “Exclude Delivery,” and “Exclude Pickup and Delivery.” “Exclude Pickup and Delivery” is the default value. |
Expiration Date | Date | The end date for the exclusion. If no Effective Date is provided, an exclusion will be effective until the Expiration Date. |
Lane | Lookup(Lane) | A lookup to the Lane record to exclude the Carrier. If no lane is provided, then the Carrier is excluded from all lanes. |
Location | Lookup(Account) | A lookup to the Account record location to exclude the Carrier. If no location is provided, then the Carrier is excluded from all locations. |
Name | Auto Number | The unique record identifier. Format: Exclusion-{0}. |
Reason | Text(100) | The reasoning for excluding the Carrier. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Carrier Exclusion belongs to. |
Carrier Liability Limit
This object captures the Carrier insurance liability limits based on country and NMFC class. Limits are typically a rate per pound.
Field Name | Type | Description |
---|---|---|
Carrier Service | Master-Detail(Carrier Service) | The Master-Detail relationship to the parent Carrier Service record the Carrier Liability Limit belongs to. |
Commodity Condition | Picklist | A description of the cargo. Values include: “New” and “Used.” No default value. |
Country | Picklist (Multi-Select) | The country this limit applies to. Values include: “CA,” “MX,” and “US.” No default value. |
Maximum Liability | Currency(10, 2) | The maximum liability monetary amount for any load of this class. |
Mode | Text(80) | The mode name of the Carrier Service. |
Name | Auto Number | The unique record identifier. Example: Limit-{0}. |
NMFC Class | Picklist (Multi-Select) | The NMFC Class(es) this limit applies to. No default value. |
Rate | Currency(10,2) | The monetary rate per unit weight. |
Weight Units | Picklist | The unit of measurement for the weight. Values include: “lbs.” or “kg.” “Lbs.” is the default value. |
Carrier Markup
This object allows for cost-plus markup parameters on Carrier quotes for specific customer-Carrier combinations.
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record this Carrier Markup is associated with. |
Carrier Markup Group | Lookup(Carrier Markup Group) | A lookup to the Carrier Markup Group record associated with the Carrier Markup. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record this Carrier Markup is associated with. If there is no value, the markup applies to all Carrier Services that do not have a specific record. |
Effective Date | Date | The optional begin date for the Carrier markup. |
Expiration Date | Date | The optional end date for the Carrier markup. |
Fuel Surcharge | Lookup(Fuel Surcharge) | A lookup to the Fuel Surcharge record associated with this Carrier Markup. |
Lane | Lookup(Lane) | A lookup to the Lane record associated with this Carrier Markup. |
Markup Type | Picklist | A selection of the criteria for the markup. Values include: “Freight,” “Fuel,” and “Accessorial.” No default value. |
Maximum Carrier Quote | Currency(10, 2) | The maximum monetary quote amount for a specific Carrier Service. |
Maximum Load Weight | Number(18, 0) | Criterion for filtering based on the maximum weight of the load. |
Maximum Markup Amount | Currency(16, 2) | The maximum monetary markup amount for a specific Carrier Service. |
Maximum Markup Amount - Floor | Currency(16, 2) | The maximum monetary markup amount floor value to return from SMC3. |
Maximum Markup Amount - Minimum | Currency(16, 2) | The maximum monetary markup amount minimum value to return from SMC3. |
Maximum Markup Amount - Tariff Rate | Currency(16, 2) | The maximum monetary markup amount tariff rate value to return from SMC3. |
Minimum Carrier Quote | Currency(10, 2) | The minimum monetary quote amount for a specific Carrier Service. |
Minimum Customer Freight Charge | Currency(16, 2) | The minimum monetary customer freight charge after the markup. |
Minimum Load Weight | Number(18, 0) | Criterion for filtering based on the minimum weight of the load. |
Minimum Markup Amount | Currency(16, 2) | The minimum markup amount for a specific Carrier Service. |
Minimum Markup Amount - Floor | Currency(16, 2) | The minimum monetary markup floor amount returned from SMC3. |
Minimum Markup Amount - Minimum | Currency(16, 2) | The minimum monetary markup minimum amount returned from SMC3. |
Minimum Markup Amount - Tariff Rate | Currency(16, 2) | The minimum monetary markup tariff rate amount returned from SMC3. |
Minimum Markup Percent | Percent(16, 2) | The minimum markup percent for a specific Carrier Service. |
Minimum Markup Percent - Floor | Percent(16, 2) | The minimum markup floor percent to return from SMC3. |
Minimum Markup Percent - Minimum | Percent(16, 2) | The minimum markup minimum percent to return from SMC3. |
Minimum Markup Percent - Tariff Rate | Percent(16, 2) | The minimum markup tariff rate percent to return from SMC3. |
Mode | Lookup(Mode) | A lookup to the Mode record associated with the Carrier Markup. This field is set by the Carrier Service if provided. |
Name | Auto Number | The unique record identifier. Example: Markup-{0}. |
NMFC Class | Picklist (Multi-Select) | The NMFC classes for this record. Only relevant to the LTL mode. No default value. |
Target Markup Percent | Percent(16, 2) | The suggested target markup percent. Used in the calculation for the target markup. |
Target Markup Percent - Floor | Percent(16, 2) | The suggested target floor markup percent to return from SMC3. |
Target Markup Percent - Minimum | Percent(16, 2) | The suggested target minimum markup percent to return from SMC3. |
Target Markup Percent - Tariff Rate | Percent(16, 2) | The suggested target tariff rate markup percent to return from SMC3. |
Transaction Fee | Currency(16, 2) | The suggested transaction fee to add to the suggested target markup percent. Used in the calculation for the target markup. |
Weight Units | Picklist | The unit of weight measurement for markup groups. Values include: “lbs” and “kg.” “Lbs.” is the default value. |
Carrier Markup Group
This object defines a group of Carrier Markup records.
Field Name | Type | Description |
---|---|---|
Description | Text(255) | Description of the Carrier Markup group. |
Name | Text(80) | The name of the Carrier Markup group. |
Carrier Quote
This object contains Carrier Quotes generated by Carriers to move a load.
Field Name | Type | Description |
---|---|---|
A/P Ignore | Checkbox | When “Checked,” historical loads are not included in A/P calculations. |
Accepted | Checkbox | If “Checked,” a Carrier quote is accepted. |
Accessorial Charges | Currency(16, 2) | The accessorial monetary charges for the Carrier quote. |
Auto-Tender | Checkbox | If “Checked," the Carrier quote to be processed by the Carrier Engagement Automation job. |
Billable Weight | Number(16, 2) | The greater of the DIM Weight or regular Weight. |
Book It | Checkbox | An Email loop support field for Book It Now feature. If “Checked,” the Carrier has the option to select Book It Now from the Carrier Portal. |
Book It Source | Picklist | The source of the Carrier quote Book It Now request. Values include: “TMS,” “Truckstop,” and “Trucker Tools Load Board.” No default value. |
Calculation Type | Picklist | The selection for calculating a stored rate quote. Values include: “Base,” “Minimum,” and “Maximum.” No default value. |
Carrier API Login Group | Text(40) | A group of customer-specific rates for specific Carriers. A Project44 login group that provides LTL quotes. This value changes per customer. (See the Project44 Carrier Aggregator documentation for more information.) |
Carrier Quote | Auto Number | The unique record identifier. Example: Carrier Quote {0}. |
Carrier Service | Lookup(Carrier Service) | A lookup to the associated Carrier Service record associated with the Carrier quote. |
Carrier Total | Currency(16, 2) | The total Carrier quote monetary amount. |
Deficit Charge | Currency(10, 2) | An LTL tariff support monetary amount field. |
Deficit Rate | Currency(16, 2) | An LTL tariff support monetary amount field. |
Deficit Weight | Number(12, 0) | An LTL tariff support field measured in pounds. |
Destination Movement Type | Picklist | The terminal Destination movement type. Values include: “Direct,” “Interline,” “Partner,” and “Unspecified.” “Unspecified” is the default value. |
Destination Terminal Code | Text(50) | A Read-Only terminal code field returned by SMC3 for LTL Carrier Quotes. |
Destination Terminal Email | A Read-Only email address field returned by SMC3 for LTL Carrier Quotes. | |
Destination Terminal Location | Text Area(255) | A Read-Only terminal location field returned by SMC3 for LTL Carrier Quotes. |
Destination Terminal Phone | Phone | A Read-Only phone number field returned by SMC3 for LTL Carrier Quotes. |
DIM Weight | Number(16, 2) | The dimensional weight total in the weight units of the load as calculated by the Rate Entry. |
Direct/Interline | Picklist | Service information for a Carrier quote. Values include: “Direct,” “Interline,” “Partner,” and “Unspecified.” “Unspecified” is the default value. |
Disclaimer | Long Text Area(5000) | Any disclaimer text related to the Carrier quote. A value can be populated with API-based quotes from AccuFrate, Banyan, or Project44. |
Discount | Currency(16, 2) | A discount monetary amount applied to the freight charges. |
Discount Percent | Percent(3, 2) | The discount as a percentage of the freight charges. |
Effective Date | Date | The date the Carrier quote goes into effect. The effective date is usually the day the Carrier quote was created. |
Estimated Delivery Date | Date | The estimated delivery date for the load based on the service class and/or the transit days from the Carrier quote. |
Estimated Pickup Date | Date | The estimated pickup date for the load based on the service class. |
Estimated Transit Time (Days) | Number(3, 0) | The estimated transit time in days for the load for this service class. |
Freight Charge Applied | Text(10) | An LTL Tariff support field. This field indicates whether the Net Freight Charge are based on the tariff rate, minimum, or floor values. |
Freight Charge Notes | Text(200) | Notes related to the freight charge. |
Freight Charge Quantity | Number(16, 2) | The number of freight charge units. |
Freight Charge Unit | Picklist | A description of the measurement of a freight charge. “Fixed Cost” is the default value, but other selections are available including: “Percent of Amount,” “Per Day,” “Per Cubic Foot,” and "Per HU Position." |
Freight Charge Unit Price | Currency(16, 2) | The monetary cost associated with the Freight Charge Unit. Example: $500 per day. |
Freight Charges | Currency(16, 2) | The gross monetary freight charges before any discount. |
Freight Charges After Discount | Formula (Currency) | An LTL Tariff support field representing the gross freight charges minus any applicable monetary discount. |
Freight Charges after Discount/Minimums | Formula (Currency) | An LTL Tariff support field representing the greater monetary amount between the Freight Charges After Discount or the Minimum Freight Charge Floor. |
Freight Surcharge | Currency(16, 2) | An LTL Tariff support field for the monetary cost associated with shipping a load. |
Freight Surcharge Application | Text(10) | An LTL Tariff support field for when a Freight Surcharge was applied to the Net or Gross Freight Charge amount. |
Freight Surcharge Percentage | Percent(16, 2) | An LTL Tariff support for the percentage applied to calculate the Freight Surcharge. |
Fuel Surcharge | Currency(16, 2) | The fuel surcharge monetary amount. |
Fuel Surcharge Notes | Text(200) | Notes regarding the fuel surcharge. |
Fuel Surcharge Quantity | Number(16, 2) | The quantity of fuel surcharge units. |
Fuel Surcharge Unit | Picklist | Per-xxx fuel surcharge unit. Values include: “Fixed Cost,” “Per Mile,” “Per Kilometer,” and “Percent of Freight.” “Fixed Cost” is the default value. |
Fuel Surcharge Unit Price | Currency(14, 4) | The monetary charge for each fuel surcharge unit. |
Liability Coverage | Currency(16, 2) | The monetary amount of liability coverage offered by the Carrier and calculated from the Carrier Liability Limit. |
Liability Coverage Exceeded By | Currency(16, 2) | Any cargo monetary value more than the Carrier liability coverage amount. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Carrier Quote belongs to. |
Margin | Percent(6, 2) | An LTL Workbench support field for the margin percentage for a Carrier quote from an RFP and not from the Carrier Quote Assistant. |
Markup | Currency(16, 2) | An LTL Workbench support field for the markup monetary amount for a Carrier quote from an RFP and not from the Carrier Quote Assistant. |
Master Invoice Number | Text(50) (External ID) | The invoice number for multiple invoices. |
Messages | Long Text Area(5000) | Any messages related to a Carrier quote. Sometimes populated with API-based quotes from AccuFrate, Banyan, Blue Grace, Project44, and Worldwide Express. |
Minimum Freight Charge Floor | Currency(10, 2) | An LTL Tariff support field for the minimum monetary charge for transporting a load. This minimum charge is defined in the Tariff Schedule. |
Movement Type | Picklist | A description of ocean load movement. Values include: “Door to Door,” “Door to Port,” “Port to Door,” and “Port to Port.” No default value. |
Net Freight Charges | Currency(16, 2) | The Net Freight Charges field is the greater monetary amount between the Freight Charges field minus any Discounts and the Minimum Freight Charge Floor plus any Freight Surcharges. |
Order Number | Formula (Text) | The load’s customer order number. |
Origin Movement Type | Picklist | Description of the movement of a load from the origin terminal. Values include: “Direct,” “Interline,” “Partner,” and “Unspecified.” “Unspecified” is the default value. |
Origin Terminal Code | Text(50) | A Read-Only terminal code value returned by SMC3 for LTL Carrier quotes. |
Origin Terminal Email | A Read-Only email address value returned by SMC3 for LTL Carrier quotes. | |
Origin Terminal Location | Text Area(255) | A Read-Only terminal location value returned by SMC3 for LTL Carrier quotes. |
Origin Terminal Phone | Phone | A Read-Only phone number value returned by SMC3 for LTL Carrier quotes. |
Pickup Cutoff Time | Time | The latest available pickup time for the Carrier on the quote. |
Pickup Only | Checkbox | If “Checked,” set pickup-only flag for Project44 tender API calls. A PRO number is not assigned when dispatching the load. |
Priority | Picklist | This field is the Priority of the Rate Entry for the Carrier quote based on the lane and carrier combination. Values include: “1,” “2,” and “3.” |
Quote/Contract Id | Text(100) | The quote/contract ID returned with an API quote and is used when tendering a load. This value is returned by many API integrations. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record associated with the stored rate the Carrier quote is based on. |
Rate Entry Source | Lookup(Transportation Profile) | A lookup to the Transportation Profile record associated with the Rate Entry used in the Carrier quote. |
Reason for Acceptance | Picklist | The explanation for accepting a Carrier quote. Values include: “Customer Preference” and “Transit Time Requirement.” No default value. |
Removal Charge | Number(16, 2) | Any additional charges for removing a Carrier. These charges are for informational purposes. |
Removal Charge Accessorial | Text(255) | The accessorial name for a Carrier removal charge. |
Removal Comments | Text(255) | The explanation for removing a Carrier. |
Removal Reason | Picklist | The reason for carrier removal. Values include: “Load Not Ready,” “Carrier Breakdown,” and “Carrier Cancelled.” No default value. |
RFP | Lookup(RFP) | A lookup to the RFP record associated with the Carrier quote. An LTL Workbench support field for creating Carrier quotes for an RFP. Carrier Quotes created for an RFP are not created from the Freight Quote Assistant. |
Routing | Text(255) | A description of complex routing for Ocean load Carrier quotes. |
Sales Floor | Currency(16, 2) | The minimum monetary amount for customer sales reps to quote to customers. |
Same-Day Tender Cutoff Time | Time | The latest time on the same day for the Carrier to tender a load. |
Selection Reason | Picklist | The reason provided when not selecting the lowest cost Carrier quote on the portal Quote Wizard. Values include: “Faster Transit Time Required” and “Past Carrier Performance.” No default value. |
Service Class | Text(255) | A description of the Carrier Service class. |
Service Class Code | Text(20) | The Carrier Service class code provided by the Banyan or Project44 APIs. |
Settlement Comments | Text(255) | Internal comments related to settlement. |
Settlement Contact | Lookup(Contact) | A lookup to the Contact record associated with the Carrier for settlement issues. |
Settlement Documents Received | Picklist (Multi-Select) | Settlement documents provided by the Carrier to date. This field selects from the Settlement Document Types global picklist. No default value. |
Settlement Issues | Picklist (Multi-Select) | The reason(s) preventing quote-invoice settlement. Values include: “Vendor Invoice Missing,” “Proof of Delivery Missing,” “Lumper Receipt Missing,” “Fuel Receipt Missing,” “Weight Certificate Missing,” and “Other (see comments).” No default value. |
Settlement Status | Picklist | The state of the Carrier quote-invoice settlement process. Values include: “Pending,” “Documents Requested,” “Documents Received,” and “Approved for Payment.” Default value is “Pending.” |
Settlement Status as of | Date/Time | The date and time of the most recent the Settlement Status changes. |
Tariff Minimum | Currency(10, 2) | The minimum tariff monetary amount from the SMC3 API. |
Tender Accepted By | Text(100) | The name of the user accepting the tender. |
Tender Accepted By Email | The email address of the user accepting the tender. | |
Tender Accepted Date | Date/Time | The date and time when the tender was accepted by the Carrier via Email Loop. |
Tender CC List | Text(250) | The email addresses added to the tender email. |
Tender Contact | Lookup(Contact) | A lookup to the Contact record associated with the recipient of the load tender email. |
Tender Declined Comments | Text Area(255) | Additional comments explaining why the Carrier declined the load tender. |
Tender Declined Reason | Picklist | The reason the Carrier declined the load tender. Values include: “Equipment Breakdown,” “Equipment No Longer Available,” and “Other.” No default value. |
Tender Expiration Date | Date/Time | The date and time the Carrier quote tender expires. |
Tender Hold | Checkbox | If “Checked,” a load cannot be tendered. |
Tender Hold Reason | Text Area(255) | The explanation for the load tender hold. |
Tender Sent By | Lookup(User) | A lookup to the User record responsible for sending the load tender. |
Tender Sent Date | Date/Time | The date and time the load tender was sent to the Carrier. |
Tender Status | Picklist | The current state of the load tender. Values include: “Queued,” “Sent,” “Assigned,” “Rejected,” “Removed,” “Expired,” and “On Hold.” No default value. |
Tracking Information | Text(255) | The IP address and browser type of the TMS Site email recipient. |
Variance Description | Text(255) | The explanation as to why the invoice total does not match the Carrier quote total. |
Variance Reason | Picklist (Multi-Select) | The reason(s) why the invoice does not match the Carrier quote. Values include: “Lumper Charges,” “Fuel Charges,” “Detention Charges,” and “Other Charges.” No default value. |
Vendor | Lookup(Account) | A lookup to the Account record associated with the Carrier Quote. The capacity provider for the load. Usually the Carrier. |
Vendor Invoice Date | Date | The vendor invoice issue date provided by the Carrier Portal or the invoice processor. |
Vendor Invoice Number | Text(40) | The vendor invoice number provided by the Carrier Portal or the invoice processor. |
Vendor Payment Terms | Lookup(Payment Terms) | A lookup to the Payment Terms record associated with the Carrier invoice. |
Vendor Settlement Total | Currency(16, 2) | The invoice monetary total provided by HubTran or the Carrier Portal. |
Vendor Settlement Variance | Formula (Currency) | The Vendor Settlement Total minus the Carrier Quote Total monetary amount. |
Carrier Quote Accessorial
This object contains accessorial charges specific to a Carrier quote.
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record associated with the Carrier Quote Accessorial. |
Carrier Accessorial | Lookup(Carrier Accessorial) | A lookup to the Carrier Accessorial record associated with the Carrier Quote Accessorial. |
Carrier Quote | Master-Detail(Carrier Quote) | The Master-Detail relationship to the parent Carrier Quote record the Carrier Quote Accessorial belongs to. |
Charge | Currency(16, 2) | The monetary charge from the Carrier for this accessorial. |
Code | Text(20) | The standard accessorial code employed by the Carrier. Used by the Banyan, HubTran, and Project44 APIs. |
Name | Text(80) | The Carrier-specific name and description of an accessorial. |
Notes | Text(200) | The optional details related to the accessorial charge. |
Quantity | Number(16, 2) | The number of units included on the Carrier quote accessorial. |
Quote/Contract Id | Text(100) | The identifier used with the Falvey integration to match the insurance certificate number on the Customer load with the accessorial record. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record associated with the Carrier Quote Accessorial. |
Stop | Lookup(Stop) | A lookup to the Stop record associated with the Carrier Quote Accessorial. |
Unit | Picklist | The cost unit of measure. “Fixed Cost” is the default value with many other options including: “Percent of Amount,” “Per Cubic Foot,” “Per Hour,” "Per HU Position," etc. |
Unit Price | Currency(16, 2) | The per-unit price of the Carrier quote accessorial. |
User Added | Checkbox | If “Unchecked,” an API-generated quote automatically added the Carrier quote accessorial charges based on the Origin/Destination conditions. If “Checked,” the Carrier quote accessorial charges were manually added by the user. |
Carrier Quote Freight Charge Item
This object contains line itemized freight charges specific to an LTL Carrier quote.
Field Name | Type | Description |
---|---|---|
Carrier Quote | Master-Detail(Carrier Quote) | The Master-Detail relationship to the parent Carrier Quote record the Carrier Quote Freight Charge Item belongs to. |
Discount % | Percent(3, 2) | The discount percent associated with the freight charge item. |
Discount Amount | Formula(Currency) | The discount amount associated with the freight charge item. |
Freight Charge | Currency(10,2) | The pre-discount freight charge monetary amount associated with this freight charge item. |
Freight Charge Item Number | Auto Number | The unique record identifier. Example: Freight Charge Item-{000}. |
Item | Lookup(Line Item) | A lookup to the Line Item record associated with the Carrier Quote Freight Charge Item. |
Item Description | Text(255) | The description the freight charge item. |
Net Freight Charge | Formula(Currency) | The freight charge monetary amount including the discount amount associated with the freight charge item. |
NMFC Class (Rated As) | Picklist | The NMFC Class of the freight charge item. No default value. |
Rate | Currency(10,2) | The monetary rate associated with the freight charge item. |
Weight | Number(18,0) | The weight in pounds of the line item associated with the freight charge item. |
Carrier Service
This object defines how Carriers quote, tender, and update the status of loads.
Field Name | Type | Description |
---|---|---|
API Provider | Text(50) | The API Provider name for API-based Carrier Services. This field contains the name of any quoting, tendering, tracking, and image retrieval API. |
Batch Status Emails | Checkbox | If “Checked,” Carrier load status requests are sent via a batch email process. |
Carrier | Lookup(Account) | A lookup to the Account record associated with the Carrier Service. |
Carrier Service Owner | Lookup(User) | A lookup to the User record associated with the Carrier Service. This field denotes who owns the Carrier relationship. This is the Carrier Sales Rep assigned on the load in the Automated Tender Process. (Carrier Automation Engagement – only place this is used unless custom logic is built for customer.) |
Credentials | Text(18) | For API-based Carrier Services, this field contains the Record ID credentials. This information is retrieved from the TMS Admin section within Credentials |
Dimension Units | Picklist | The dimensional units for L/W/H thresholds. Values include: “in,” “cm,” “ft,” and “m.” “In” is the default value. |
EDI Provider | Picklist | When the Tender Method is EDI, this field can be set to “Kleinschmidt,” “Cleo,” “Custom EDI,” or “Orderful,” depending on the EDI in use. No default value. This field is dependent on the Tender Method field selection. |
Enabled | Checkbox | If “Checked,” this Carrier Service can be used to quote and tender loads. |
Load Tender Page Settings | Picklist (Multi-Select) | A selection of the fields displayed to the Carrier when accepting or declining the tender. Values include: “Email signature,” and “Carrier Details.” To accept a tender, “Email signature” requires a name and email address while “Carrier Details” prompts for a required or optional set of field set-driven information. No default value. |
Logo Document Id | Text(18) | The record ID of a document/image that displays on the Customer Portal for this Carrier Service. |
Maximum HU Count | Number(10, 0) | The maximum handling unit count for the Carrier Service. |
Maximum HU Height | Number(16, 2) | The maximum handling unit height dimension for the Carrier Service. |
Maximum HU Length | Number(16, 2) | The maximum handling unit length dimension for the Carrier Service. |
Maximum HU Weight | Number(18, 0) | The maximum per-handling unit weight for the Carrier Service. |
Maximum HU Width | Number(16, 2) | The maximum handling unit width dimension for the Carrier Service. |
Maximum Linear Feet | Number(10, 2) | The maximum linear feet of a load for the Carrier Service. |
Maximum Volume | Number(18, 0) | The maximum load volume for the Carrier Service. |
Maximum Weight | Number(18, 0) | The maximum load weight for the Carrier Service. This field is required field to use the Carrier Service. |
Minimum Linear Feet | Number(10, 2) | The minimum linear feet of a load for the Carrier Service. |
Minimum Weight | Number(18, 0) | The minimum load weight the Carrier Service supports. This field is required to use the Carrier Service. |
Mode | Master-Detail(Mode) | The Master-Detail relationship to the parent Mode record the Carrier Service belongs to. |
Mode Name | Formula (Text) | The mode name. For example, “Truckload.” |
Name | Text(80) | The name of the Carrier Service. |
Pickup Cutoff Time | Time | The latest available pickup time for the Carrier Service for a quote. |
Pickup Only | Checkbox | When “Checked,” Project44 load tendering API calls are noted as pickup only. A PRO number is not assigned when dispatching the load. |
Quote Contact | Lookup(Contact) | A lookup to the Contact record email email-based Carrier Service quotes. |
Quote Method | Picklist | The method used to request quotes. Values include: “Email,” “Phone,” “Fax,” “API,” and “Stored Rate.” No default value. |
Rating | Picklist | The rating of Carrier performance with “A” through “F” values. |
Same-Day Tender Cutoff Time | Time | The latest time a load may be tendered for the Carrier Service on the same day. |
Service Notes | Long Text Area(1000) | Service notes are available on the Customer Portal and users can view them in the quote list. |
Settlement Contact | Lookup(Contact) | A lookup to the Contact record for settlement-related issues. |
Status Contact | Lookup(Contact) | A lookup to the Contact record associated with email-based load status requests. This field is provided from the Carrier Quote. |
Status Method | Picklist | The method used to obtain the status of a load. Values include: “Email,” Phone,” and “API.” No default value. |
Tender Contact | Lookup(Contact) | A lookup to the Contact record associated with tendering a load via email. |
Tender Method | Picklist | The method used to tender loads. Values include: “Email,” “Fax,” “API,” and “EDI.” No default value. |
Transportation Profile | Lookup(Transportation Profile) | A lookup to the Transportation Profile record associated with the Carrier and Carrier Service. |
VLTL | Checkbox | “Checked” to indicate VLTL Carrier Service records. |
Volume Units | Picklist | The unit of volume for VLTL load volume. Values include: “Cubic Feet,” “Cubic Inches,” “Cubic Meters,” “Gallons,” and “Liters.” No default value. |
Weight Units | Picklist | The unit of weight for loads. Values include: “lbs” or “kg.” No default value. These fields are required to use the Carrier Service. |
Checklist Item
This Fleet Management object contains inspection report checklist item fields.
Field Name | Type | Description |
---|---|---|
Category | Picklist | The name of the item on the Inspection Report. Several values available including: “Air Lines,” “Brakes,” and “Emergency Equipment.” No default value. |
Checklist Item | Text(80) | The name of the checklist item. |
Inspection Comments | Text(255) | The comments regarding the inspection. |
Inspection Report | Master-Detail(Inspection Report) | A Master-Detail relationship to the parent Inspection Report record the Checklist item belongs to. |
Order | Number(4, 0) | The order of the items in the Inspection Report. |
Service Technician Comments | Text Area(255) | The comments from the service technician performing the inspection. |
Status | Picklist | The current state of the checklist item. Values include: “Pending,” “Passed,” and “Failed.” “Pending” is the default value. |
Claim
This object contains fields regarding damages, shorts, and other types of customer claims against defective loads.
Field Name | Type | Description |
---|---|---|
Amount Claimed | Currency(16, 2) | The monetary amount claimed for damages, etc. |
Carrier Claim Number | Text(50) | The Carrier claim system identifier if a claim was entered on the Carrier’s web site. |
Claim Date | Date | The date the user created a claim. |
Claim Number | Auto Number | The unique record claim identifier. Example: Claim {0}. |
Description | Rich Text Area(5000) | A text area to describe the details of the claim and attach images. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Claim is against. |
Status | Picklist | The state of the claim. Values include: “Open” and “Closed.” “Open” is the default value. |
Commodity
This object captures reference data related to recurring line-item commodities.
Field Name | Type | Description |
---|---|---|
Commodity Catalogue | Lookup(Commodity Catalogue) | A lookup to the Commodity Catalogue record associated with the Commodity. |
Density Maximum | Number(10, 2) | The maximum limit for filtering commodities based on the line-item density. |
Density Minimum | Number(10, 2) | The minimum limit for filtering commodities based on the line-item density. |
Description | Text(255) | A description of the commodity. |
Dimension Units | Picklist | The dimensional units for the handling unit of a commodity. Values include: “in,” “cm,” “ft,” and “m.” No default value. |
Effective Date | Date | The date the commodity becomes active. |
Expiration Date | Date | The date the commodity becomes inactive. |
Extended Price | Currency(16, 2) | The monetary cost of the commodity. |
Handling Units | Picklist | A description of the container for the commodity. Some examples include, “Barrels,” Boxes,” “Crates,” and “Other.” No default value. |
HazMat | Checkbox | If “Checked,” the line-item commodity is a hazardous material. |
HazMat Class/Division | Picklist | The HazMat category of the commodity, such as “9” or “2.1.” No default value. |
HazMat Contact | Lookup(Contact) | A lookup to the Contact record associated with the HazMat information for the commodity. |
HazMat Number | Text(4) | The United Nations number code for the HazMat material. |
HazMat Number Type | Picklist | A description of the HazMat Number. Values include: “UN” or “NA.” No default value. |
HazMat Packaging Group | Picklist | The group identifier for the packaging of HazMat materials. Values include: “I,” “II,” or “III.” No default value. |
Height | Number(16, 2) | The height of the commodity Handling Unit. |
HS Code | Text(7) | The Harmonized System (HS) code for commodity tax/tariff purposes. |
HTS Code | Text(12) | The Harmonized Tariff Schedule code for commodity tax/tariff purposes. |
HU Count | Number(18, 0) | The number of Handling Units of the commodity. |
Is Active | Formula(Checkbox) | If “Checked,” the commodity is active based on the effective and expiration dates. |
Item Number | Text(50) (External ID) | The unique identifier or SKU for the commodity. |
Length | Number(16, 2) | The length of the commodity Handling Unit. |
Name | Auto Number | The unique record identifier. Example: Commodity-{0}. |
NMFC Class | Picklist | The standard NMFC class for an LTL load. No default value. |
NMFC Number | Text(20) | The NMFC Number for an LTL load. |
Packaging Units | Picklist | The type of packaging unit. Packaging unit selections include: “Boxes,” “Cases,” Packages,” and many others. No default value. |
PU Count | Number(18, 0) | The quantity of packaging units. |
Schedule B Code | Text(12) | The Schedule B code for tax/tariff purposes. |
Stackable | Checkbox | If “Checked,” the commodity Handling Unit is stackable. |
Turnable | Checkbox | If “Checked,” the commodity Handling Unit is turn-able. |
Weight | Number(18, 0) | The weight of the commodity. |
Weight Units | Picklist | A selection of the unit of measure. Values include: “lbs” or “kg.” No default value. |
Width | Number(16, 2) | The width of the commodity Handling Unit. |
Commodity Catalogue
This object contains reference data related to recurring line-item commodities.
Field Name | Type | Description |
---|---|---|
Description | Text Area(255) | The description of the commodity catalogue. |
Global | Checkbox | If “Checked,” the catalogue can be accessed from the Enhanced Commodity Search dialog. |
Name | Text(80) | The unique record identifier. |
Contact (SFDC Object)
This is a standard Salesforce object. The TMS contributes one field to this object.
Field Name | Type | Description |
---|---|---|
Transportation Role | Picklist | The role of the contact with values: “Shipping,” “Receiving,” “HazMat,” “Quoting,” “Tendering,” “Status,” “Settlement,” “Billing,” and “Driver.” No default value. |
Container
This object defines the ocean/rail/drayage shipping container information for loads.
Field Name | Type | Description |
---|---|---|
Actual Arrival Date (D) | Date | The arrival date of a container to the port of discharge. |
Actual Arrival Time (D) | Time | The arrival time of a container to the port of discharge. |
Actual Departure Date (L) | Date | The departure date of a container from the port of loading. |
Actual Departure Time (L) | Time | The departure time of a container from the port of loading. |
Available Date (D) | Date | The date a container is available at the port of discharge. |
Available Time (D) | Time | The time a container is available at the port of discharge. |
Booking Number | Formula (Text) | The booking number of the ocean voyage. |
Container Number | Text(80) | The name of the container, such as “BNSF1234567.” |
Container Status | Picklist | The current state of the container. No default value. |
Container Status Comments | Text Area(255) | Comments regarding the status of the container. |
Customer | Formula (Text) | The name of the customer for the load. |
Discharged Date (D) | Date | The discharged date of a container from the port of discharge. |
Discharged Time (D) | Time | The discharged time of a container from the port of discharge. |
Earliest Pickup Date (L) | Date | The earliest pickup date for a container at the port of loading. |
Earliest Pickup Time (L) | Time | The earliest pickup time for a container at the port of loading. |
Earliest Return Date – Demurrage (L) | Date | The earliest return date for demurrage for a container at the port of loading. |
Earliest Return Time – Demurrage (L) | Time | The earliest return time to avoid demurrage for a container at the port of loading. |
Equipment Type | Lookup(Equipment Type) | A lookup to the Equipment Type record associated with the Container. |
Estimated Arrival Date (D) | Date | The estimated arrival date of a container to the port of discharge. |
Estimated Arrival Time (D) | Time | The estimated arrival time of a container to the port of discharge. |
Estimated Departure Date (L) | Date | The estimated departure date of a container from the port of loading. |
Estimated Departure Time (L) | Time | The estimated departure time of a container from the port of loading. |
Gated In Empty Date (D) | Date | The gated in empty date of a container from the port of discharge. |
Gated In Empty Time (D) | Time | The gated in empty time of a container from the port of discharge. |
Gated In Full Date (L) | Date | The gated in full date of a container at the port of loading. |
Gated In Full Time (L) | Time | The gated in full time of a container at the port of loading. |
Gated Out Empty Date (L) | Date | The gated out empty date of a container at the port of loading. |
Gated Out Empty Time (L) | Time | The gated out empty time of a container at the port of loading. |
Gated Out Full Date (D) | Date | The gated out full date of a container at the port of discharge. |
Gated Out Full Time (D) | Time | The gated out full time of a container at the port of discharge. |
Geolocation | Geolocation | The latitude and longitude location of the container. |
Geolocation as of | Date/Time | The date and time that a container location was most recently updated. |
Import/Export | Formula (Text) | The type of shipment for the container. Possibilities are “Import,” “Export,” and “Domestic.” |
Last Free Date - Demurrage (D) | Date | The date of last free demurrage for the container at the port of discharge. |
Last Free Date - Detention (D) | Date | The date of last free detention for the container at the port of discharge. |
Last Free Date - Detention (L) | Date | The date of last free detention for the container at the port of loading. |
Last Free Time - Demurrage (D) | Time | The time of last free demurrage for the container at the port of discharge. |
Last Free Time - Detention (D) | Time | The time of last free detention for the container at the port of discharge. |
Last Free Time - Detention (L) | Time | The time of last free detention for the container at the port of loading. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Container belongs to. |
Load Status | Formula (Text) | The status of the load. |
Load/Unload Type | Picklist | The loading and unloading type for the container. Values include: “Drop and Hook,” and “Live Load/Unload.” No default value. |
Loaded On Board Date (L) | Date | The date the container was loaded on board the vessel at the port of loading. |
Loaded On Board Time (L) | Time | The time the container was loaded on board the vessel at the port of loading. |
Master Bill of Lading Number | Formula (Text) | The load identifier for container tracking. |
Mode | Formula (Text) | The load’s mode name. |
Port/Terminal of Discharge | Lookup(Account) | A lookup to the Account record associated with the discharge port/terminal. |
Port/Terminal of Discharge Timezone | Formula (Text) | The discharge port/terminal IANA time zone. |
Port/Terminal of Load | Lookup(Account) | A lookup to the Account record associated with the load port/terminal. |
Port/Terminal of Load Timezone | Formula (Text) | The load port/terminal IANA time zone. |
Route Information | Long Text Area(500) | The description of the itinerary for the voyage(s) that a container will undertake. |
SCAC | Text(6) | The SCAC identifier of the ocean/rail Carrier of the container. |
Scheduled Arrival Date (D) | Date | The scheduled arrival date for a container at the port of discharge. |
Scheduled Arrival Time (D) | Time | The scheduled arrival time for a container at the port of discharge. |
Scheduled Departure Date (L) | Date | The scheduled departure date for a container at the port of loading. |
Scheduled Departure Time (L) | Time | The scheduled departure time for a container at the port of loading. |
Terminal Cut-Off Date (L) | Date | The cut—off date for the terminal at the port of loading. |
Terminal Cut-Off Time (L) | Time | The cut—off time for the terminal at the port of loading. |
Tracking | Picklist | The selection to determine if a container is tracked. Values include: “Off” or “On.” “Off” is the default value. |
Tracking Number | Text(40) (External ID) | The tracking number for the third-party API providing container tracking information. |
Tracking Provider | Text(40) | The name of the third-party API providing container tracking information. |
Vessel | Text(100) | The name of the vessel the container is on. |
Container Console Configuration
This object defines the user filters created in the Container Console.
Field Name | Type | Description |
---|---|---|
Default | Checkbox | If “Checked,” this is the default filter when the console is opened. |
Name | Text(80) | The name of the filter. |
State | Long Text Area(10000) | The JSON serialized filter definition. |
Visibility | Picklist | The selection for the visibility for the filter console. Values include: “Public” or “Private.” “Private” is the default value. |
Container/Trailer (Obsolete)
This object defines ocean container information for loads. Ocean loads will fill one or more containers.
Field Name | Type | Description |
---|---|---|
Container/Trailer Number | Text(80) | Name of container, such as “BNSF1234567”. |
Cargo Weight | Number(18, 0) | Cargo weight in container. |
Container Drop-Off Location | Text Area(255) | Where dray driver should drop container. |
Container Pickup Location | Text Area(255) | Where dray driver should pick up container. |
Contents Description | Text Area(255) | Free-form description of container contents. |
Description | Formula (Text) | Name of Equipment Type parent record. |
Equipment Type | Master-Detail(Equipment Type) | The parent Equipment Type record. |
Gross Weight | Formula (Number) | Cargo Weight + Tare Weight. |
ISO Size Type | Formula (Text) | The ISO Size Type of the parent Equipment Type record. |
ISO Type Group | Formula (Text) | The ISO Type Group of the parent Equipment Type record. |
Load | Master-Detail(Load) | The load this container is associated with. |
Maximum Weight | Number(18, 0) | The maximum loaded weight allowed for this container. |
Original Reference | Lookup(Container/Trailer) (Obsolete) | References container from customer load if this belongs to a carrier load in a freight plan. |
Overweight | Formula (Checkbox) | “true” if the maximum weight is exceeded. |
Sealing Party | Picklist | Which party has placed a seal on the container. |
Seal Number | Text(40) | The seal identifier placed on the container. |
Supplied By | Picklist | “Carrier” or “Shipper.” |
Tare Weight | Number(18, 0) | The empty weight of the container. |
Temperature Setting | Number(3,2) | The temperature setting for temperature controlled loads. |
Temperature Units | Picklist | “Fahrenheit” or “Celsius”. |
Verification Delegated | Checkbox | “true” if VGM delegated to third party. |
Verification Signature | Text(100) | Signature of VGM verifier. |
Verification Signature Date | Date/Time | Date and time of VGM signature. |
Verified Gross Mass | Number(10,2) | Verified Gross Mass of container. |
VGM Determination Date | Date/Time | Date and time of VGM determination. |
VGM Submitted | Checkbox | “true” if VGM submitted (to INTTRA). |
Volume | Number(18, 0) | Volume of line items in container. |
Volume Units | Formula (Text) | Volume units of parent load record. |
Weight Units | Formula (Text) | Weight units of parent Load record. |
Container/Trailer Line Item (Obsolete)
This object defines ocean container line item contents information for a specific load and container.
Field Name | Type | Description |
---|---|---|
Item | Auto Number | Record identifier. |
Container/Trailer | Lookup(Container/Trailer) (Obsolete) | The parent container. |
Handling Units | Formula (Text) | The handling units of the contained line item. |
Handling Unit Count | Number(18, 0) | The number of handling units in the container for the line item. |
Item Description | Formula (Text) | The line item description. |
Line Item | Master-Detail(Line Item) | The line item allocated to this container (in whole or part). |
Packaging Units | Formula (Text) | The packaging units of the contained line item. |
Packaging Unit Count | Number(18, 0) | The number of packaging units in the container for the line item. |
Summary | Formula (Text) | Computed summary of line item contents. |
Volume | Formula (Number) | Volume of line item in container. |
Volume Units | Formula (Text) | Volume units of parent line item record. |
Weight | Formula (Number) | The weight of the line item specific to this container. |
Weight Units | Formula (Text) | The line item weight units. |
Credit Limit
This object contains shared credit limit records that can be assigned to customer Transportation Profiles.
Field Name | Type | Description |
---|---|---|
A/R Current | Currency(16, 2) | The current accounts receivable monetary amount across related customers. |
A/R Past Due | Currency(16, 2) | The past due accounts receivable monetary amount across related customers. |
A/R Unbilled | Currency(16, 2) | The unbilled accounts receivable and accepted customer quotes monetary amount across related customers. |
Credit Limit Amount | Currency(16, 2) | The global credit limit monetary amount shared by related customers. |
Credit Limit Available | Formula (Currency) | The global remaining credit limit monetary amount shared by related customers. |
Credit Limit Utilized | Formula (Percent) | The global used credit limit monetary amount shared by related customers. |
Description | Text Area(255) | A description of the credit limit. |
Name | Text(80) | The unique record identifier. |
Unapplied Cash/Credit Memos | Currency(16, 2) | Any additions to the credit limit available monetary amount shared by related customers. |
Customer Invoice
This object contains load-specific invoice fields that are sent to the customer or accounting system.
Field Name | Type | Description |
---|---|---|
Accessorial Charges | Currency(16, 2) | The total accessorial monetary charges included on the invoice. |
Accounting Processed Date | Date/Time | The date and time the invoice was processed; for example, when it was exported to QuickBooks. |
Accounting Status | Picklist | Flag for the Pub/Sub Accounting integration. Values include: "Ready for Accounting," "Sent to Accounting," "Publish Error." |
Adjustments | Currency(16, 2) | This field holds any customer invoice changes that result in monetary adjustments to the Customer Invoice. The reason for these changes could be for a re-weigh, re-classification, etc. |
Balance Due | Formula (Currency) | The Balance Due field is the result of the Invoice Total field minus the Paid Amount field and the Payment Discount field. This field is Read-Only. |
Billing Account | Formula (Text) | The Billing Contact’s Account name. |
Billing Contact | Lookup(Contact) | A lookup to the Contact record associated with the Billing Account the Customer Invoice is sent to. |
Billing Contact Email | Formula (Text) | The Billing Contact email address. This field can also be used while list view filtering to find missing email addresses. |
Billing Method | Picklist | Selected method for sending a Customer Invoice. Values include: “Email,” “EDI,” or “Print.” “Email” is the default selection. |
Customer Quote | Lookup(Customer Quote) | A lookup to the Customer Quote record the Customer Invoice was created from. |
Date Sent | Date/Time | The Customer Invoice Date Sent field is set when the Customer Invoice is sent via email or as a bulk email/print of the Customer Invoices list. |
Days Past Due | Formula (Number) | The number of days past due for outstanding Customer Invoices. |
Dispute Contact | Lookup(Contact) | A lookup to the Contact record associated with the Dispute Contact for this Customer Quote. |
Dispute Date | Date/Time | The date and time a dispute was created in the TMS. |
Dispute Detail | Text Area(255) | A detailed description of the Dispute. |
Dispute Reason | Picklist (Multi-Select) | General category describing the dispute. Values include: “Pricing,” “Damaged Load,” “Late Load,” “Lost Load,” and “Other.” No default value. |
Dispute Resolution | Text Area(255) | A detailed description of resolving the dispute. |
Dispute Resolved Date | Date/Time | The date and time that a dispute is resolved. |
Dispute Status | Picklist | The current state of a dispute. Values include: “Open” or “Closed.” No default value. |
Disputed | Checkbox | “Checked” indicates a Customer Invoice is in dispute. |
EDI Processed Date | Date/Time | The date and time the Customer Invoice was sent via an EDI 210 transaction. |
Freight Charge Notes | Text(200) | Notes related to the freight cost. |
Freight Charge Quantity | Number(16, 2) | The number of freight charge cost units. |
Freight Charge Unit | Picklist | The cost type for the freight charge. No default value. |
Freight Charge Unit Price | Currency(16, 2) | The monetary cost for a unit of freight charge. |
Fuel Surcharge | Currency(16, 2) | The fuel surcharge line item monetary amount for this Customer Invoice. |
Fuel Surcharge Notes | Text(200) | Notes related to the fuel surcharge cost. |
Fuel Surcharge Quantity | Number(16, 2) | The number of fuel surcharge cost units. |
Fuel Surcharge Unit | Picklist | The cost type for the fuel surcharge. Values include: “Fixed Cost,” “Per Mile,” “Per Kilometer,” and “Percent of Freight.” No default value. |
Fuel Surcharge Unit Price | Currency(14, 4) | The monetary cost for a unit of fuel surcharge. |
Ignore Invoice Document Requirements | Checkbox | When “Checked,” allows for the creation of customer invoices without documents, particularly for Truck Ordered, Not Used cases. |
Invoice Date | Date | The date the Customer Invoice was generated. |
Invoice Due Date | Date | The date the Customer Invoice is due. |
Invoice Number | Text(80) | The Customer Invoice Number. |
Invoice Status | Picklist | The current state of a Customer Invoice. Values include: “Pending,” “Approved,” “Invoiced,” “Paid,” “Short Paid,” and “On Hold.” “Pending” is the default value. |
Invoice Status Comments | Text Area(255) | This field includes specific information when a Customer Invoice is set to “On Hold.” |
Invoice Total | Currency(16, 2) | The total monetary amount due on the Customer Invoice. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Customer Invoice belongs to. |
Master Invoice Number | Text(50) (External ID) | When a set of invoices are collected into a single email or printed as one PDF document, all member Customer Invoices will have the same Master Invoice Number. |
Net Freight Charges | Currency(16, 2) | The Net Freight Charges monetary amount. |
Paid Amount | Currency(16, 2) | The current total monetary amount paid toward this Customer Invoice. |
Payment Discount | Currency(16, 2) | Any monetary discount that can be applied to this Customer Invoice, such as advance payment. |
Payment Discount Taken | Currency(16, 2) | Any monetary discount applied to the Customer Invoice, rolled up from the child payment records. |
POD Received | Formula (Checkbox) | If “Checked,” a POD is attached to the load. |
POD Required | Checkbox | If “Checked,” a POD is required to send a Customer Invoice to the customer. |
Tax Amount | Currency(16, 2) | The rollup of monetary tax amounts from child tax records. |
Transportation Total | Currency(16, 2) | The monetary sum of the Net Freight Charges, Fuel Surcharge, and Accessorial Charges. |
Customer Invoice Accessorial
This object contains accessorial line item charges for a Customer Invoice.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the Customer Invoice Accessorial belongs to. |
Charge | Currency(16, 2) | The monetary charge on the Customer Invoice for this accessorial. |
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Invoice Accessorial belongs to. |
Name | Text(80) | The name and description of the accessorial. |
Notes | Text(200) | Optional details related to the accessorial charge. |
Quantity | Number(16, 2) | The number of units for the accessorial. |
Stop | Lookup(Stop) | A lookup to the stop this accessorial is associated with. |
Unit | Picklist | The type of accessorial cost category. There are many options including, “Fixed Cost,” “Percent of Amount,” “Per Cubic Foot,” “Per HU Position,” etc. No default value. |
Unit Price | Number(16, 2) | The per-unit monetary cost of an accessorial. |
Customer Invoice Adjustment
This object contains charges for re-weighs, re-classifications, and other unexpected load configuration issues.
Field Name | Type | Description |
---|---|---|
Adjustment Amount | Currency | The monetary amount of the Customer Invoice Adjustment. |
Category | Picklist | The type or category of Customer Invoice Adjustment. Values include: “Re-Class,” “Re-Weigh,” and “Other.” No default value. |
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Invoice Adjustment belongs to. |
Description | Text(80) | The description of the Customer Invoice Adjustment. |
Customer Invoice Document
This object defines customer-specific documents required for Customer Invoice generation.
Field Name | Type | Description |
---|---|---|
Accessorials | Text(255) | One or more applied accessorial charges that renders the Customer Invoice document required. |
Action | Picklist | Selection for including specific documentation for a Customer Invoice. Values include: “Never Include,” “Always Include,” “Always Include POD,” “Include if Present,” “Include if Accessorial Present,” and “Include if POD.” “Never Include” is the default value. |
Carrier Upload | Checkbox | If “Checked,” the document is available in document picklists to give Carriers the ability to upload this type of document. |
Customer | Lookup(Account) | A lookup to the Contact record this customer invoice document refers to. If “null” this is a global rule. |
Document Type | Picklist | Selection for the type of document this record refers to. Many document types are available. Do not make changes to the values of existing entries on the list. |
Modes | Text(255) | On or more Mode Ids whose presence makes this Customer Invoice Document record relevant. |
Name | Auto Number | The unique record identifier. Example: CID-{0}. |
Synonyms | Text(200) | Synonym used by Samsara ELD when uploading driver documents. This field is used when a document type doesn’t match what is available in the TMS. |
Customer Invoice Tax
This object contains (Canadian sales) tax records for a Customer Invoice.
Field Name | Type | Description |
---|---|---|
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Invoice Tax belongs to. |
Name | Auto Number | The unique record identifier. Example: Tax-{0}. |
Sales Tax | Lookup(Sales Tax) | A lookup to the Sales Tax record this customer invoice tax is calculated from. |
Stop | Lookup(Stop) | A lookup to the destination stop record (if unique) this customer invoice tax is calculated against. |
Tax Amount | Currency(16, 2) | The monetary amount as calculated by the Taxable Total multiplied by the Tax Rate. |
Tax Rate | Percent(3,3) | The Tax Rate percentage applied to the Taxable Total field. |
Taxable Total | Currency(16, 2) | The allocation of the total transportation monetary cost that this tax is calculated on. |
Customer Payment
This object contains any Customer Payments toward Customer Invoices.
Field Name | Type | Description |
---|---|---|
Accounting Processed Date | Date/Time | The date and time the Customer Payment was processed; for example, when it was exported to QuickBooks. |
Check/Reference Number | Text(50) (External ID) | The check or transaction number of the Customer Payment. |
Comments | Text Area(255) | Any comments related to the Customer Payment. |
Customer Invoice | Master-Detail(Customer Invoice) | The Master-Detail relationship to the parent Customer Invoice record the Customer Payment belongs to. |
Description | Text(80) | The name/description of the Customer Payment. |
Discount | Currency(16, 2) | The monetary payment discount amount taken by the customer. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Customer Invoice Payment belongs to. |
Payment Amount | Currency(16, 2) | The total net payment amount. |
Payment Date | Date | The date the Customer Payment was made. |
Payment Type | Picklist | The type of payment made by the customer. Values include: “Company Check,” “ACH,” “Wire,” “Credit Card,” and “Other.” No default value. |
Customer Quote
This object contains the customer quote fields for loads or potential loads.
Field Name | Type | Description |
---|---|---|
A/R Ignore | Checkbox | Set to “Checked” for any quotes that should not contribute to A/R calculations. |
Accept Link | Formula (Text) | Email Loop Link URL for accepting a Customer Quote. |
Accessorial Charges | Currency(16, 2) | The total accessorial monetary charges for this customer quote. |
Billable Weight | Number(16, 2) | The billable weight total in the weight units of the load. The greater of DIM Weight and regular Weight. |
Billing Status | Picklist | The status of any related invoice to the customer quote. Values include: “Pending,” “Approved,” “Adjusted,” and “Invoiced.” “Pending” is the default value. |
Calculation Type | Picklist | When calculating a rate, the type of calculation to perform. Values include: “Base,” “Minimum,” and “Maximum.” No default value. |
Carrier Quote | Lookup(Carrier Quote) | A lookup to the Carrier Quote record associated with the Customer Quote. |
Comments | Text Area(255) | Any comments related to the customer quote. |
Credit Hold | Checkbox | Indicates if a Customer quote is on hold due to insufficient credit. |
Customer Contact | Lookup(Contact) | A lookup to the Contact record for the customer contact to receive the Customer Quote. |
Customer Quote | Auto Number | The unique record identifier. Example: Customer Quote {0}. |
Customer Quote Total | Currency(16, 2) | The total monetary amount quoted to a customer. This field is required to send a Customer Quote. |
Decline Link | Formula (Text) | The email loop link URL for Declining a Customer Quote. |
Deficit Charge | Currency(10,2) | The deficit charge monetary amount based on an SMC3 tariff. |
Deficit Rate | Currency(16,2) | The deficit rate based on an SMC3 tariff. |
Deficit Weight | Number(12,0) | The deficit weight in pounds based on an SMC3 tariff. |
Destination City | Text(40) | A shipment’s last stop consignee City. |
Destination Location | Lookup(Account) | A lookup to the Account record for a shipment’s last stop consignee location. |
Destination Postal Code | Text(20) | A shipment’s last stop consignee Postal Code. |
Destination State/Province | Picklist | A shipment’s last stop consignee State/Province. |
DIM Weight | Number(16, 2) | The dimensional weight as calculated by the Rate Entry. This is a Read-Only field. |
Discount | Currency(16,2) | The total monetary discount amount from an SMC3 tariff. |
Discount Percent | Percent(3,2) | The total discount percentage from an SMC3 tariff. |
Distance (Kilometers) | Number(10, 2) | Populated with the negotiated distance if this is a stored-rate quote. This field is Read-Only. |
Distance (Miles) | Number(10, 2) | Populated with negotiated distance if this is a stored-rate quote. This field is Read-Only. |
Expiration Date | Date/Time | The date and time the Customer Quote expires. |
Freight Charge Applied | Text(10) | The Net Freight Charges applied to a Customer Quote based on the tariff Rate (R), Minimum (M), or Floor (F). |
Freight Charge Notes | Text(200) | Notes describing the freight charges on the customer quote. |
Freight Charge Quantity | Number(16, 2) | The quantity of freight charge units on the customer quote. |
Freight Charge Unit | Picklist | The rate type cost of a freight charge. “Fixed Cost” is the default value, but many others are available including: “Percent of Amount,” Per Cubic Foot,” Per Gallon,” "Per HU Position," etc. |
Freight Charge Unit Price | Currency(16, 2) | The monetary cost for each freight charge unit. |
Freight Charges | Currency(16, 2) | The monetary cost of freight charges based on the SMC3 tariff. |
Freight Charges After Discount | Formula (Currency) | Freight charges after the Discount is applied from the SMC3 tariff. |
Freight Markup | Lookup(Carrier Markup) | A lookup to the Carrier Markup record associated with the Customer Quote for freight. |
Freight Surcharge | Currency(16,2) | The Freight Surcharge monetary amount. |
Freight Surcharge Application | Text(10) | Indicates whether the Freight Surcharge was applied to the Net (N) or Gross (G) Amount. |
Freight Surcharge Percentage | Percent(16,2) | Freight Surcharge percentage used to calculate the Freight Surcharge. |
Fuel Markup | Lookup(Carrier Markup) | A lookup to the Carrier Markup record associated with the Customer Quote for fuel. |
Fuel Surcharge | Currency(16, 2) | The fuel surcharge amount added to the Customer Quote. |
Fuel Surcharge Notes | Text(200) | Notes describing the fuel surcharge. |
Fuel Surcharge Quantity | Number(16, 2) | The quantity of fuel surcharge units. |
Fuel Surcharge Source | Formula (Text) | The origin of a fuel surcharge. Possible values are “TMS” or “Breakthrough Fuel.” This field is Read-Only. |
Fuel Surcharge Unit | Picklist | The type of fuel surcharge. Values include: “Fixed Cost,” “Per Mile,” “Per Kilometer,” and “Percent of Freight.” “Fixed Cost” is the default value. |
Fuel Surcharge Unit Price | Currency(14, 4) | The monetary amount of each fuel surcharge unit. |
Load | Lookup(Load) | A lookup to the Load record associated with this Customer Quote. |
Load Summary | Formula (Text) | A summary of the load origin and destination information. Included on the Customer Rate and Load Confirmation email template. |
Locked | Checkbox | If “Checked,” a Customer Quote is locked and cannot be updated. |
Messages | Long Text Area(5000) | The related field to Messages on the Carrier Quote field. Provides for the ability to store optional accessorials for ocean loads. |
Minimum Freight Charge Floor | Currency(10,2) | The Minimum Charge amount for a customer quote as defined in the Tariff Schedule. |
Movement Type | Picklist | The shipment type for ocean loads. Values include: “Door to Door,” “Door to Port,” “Port to Door,” and “Port to Port.” No default value. |
Net Freight Charges | Currency(16, 2) | The monetary amount for Freight Charges. |
Origin City | Text(40) | The origin stop city for no-load quotes. |
Origin Location | Lookup(Account) | A lookup to the Account record for the origin location for no-load quotes. |
Origin Postal Code | Text(20) | The origin postal code for no-load quotes. |
Origin State/Province | Picklist | The origin state/province code for no-load quotes. |
Pricing | Picklist | The type of rate quoted. The default value is “Spot,” and “Contract” is also available. |
Quote Date | Date | The date the Customer Quote was created. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record upon which the stored rate customer quote is based. This field is Read-Only. |
Rate per Kilometer | Formula (Currency) | The quote total divided by the distance (from quote or load). This field is Read-Only. |
Rate per Mile | Formula (Currency) | The quote total divided by the distance (from quote or load). This field is Read-Only. |
Rebate Amount | Currency(16, 2) | The rebate monetary amount as determined by the customer’s rebate program. |
Rebate Invoice | Lookup(Vendor Invoice) | A lookup to the Vendor Invoice record that contains the associated rebate invoice for the customer quote. |
Rebate Program Entry | Lookup(Rebate Program Entry) | A lookup to the Rebate Program Entry record that calculates the rebate for the customer quote. |
Routing | Text(255) | The description of complex routing information for an ocean load Customer Quote. |
Site URL | Text(200) | An internal field used to support URL links email templates. |
Status | Picklist | Value describing the state of the Customer Quote. The default value is “Pending,” and other values include: “Quoted,” “Accepted,” “Rejected,” “Cancelled,” “Expired,” and “Replaced.” |
Tariff Minimum | Currency(10, 2) | The tariff minimum monetary amount from the SMC3 tariff. |
Tax Amount | Currency(16, 2) | The rollup of “child” tax record monetary Tax Amounts. This field is Read-Only. |
Tracking Information | Text Area(255) | The IP address and browser type of the TMS Site email recipient. This field is Read-Only. |
Transportation Total | Currency(16, 2) | The monetary sum of Net Freight Charges, Fuel Surcharge, and Accessorial Charges. |
Customer Quote Accessorial
This object contains Customer Quote Accessorial charge line items.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the Customer Quote Accessorial belongs to. |
Charge | Currency(16, 2) | The monetary amount for this accessorial. |
Customer Quote | Master-Detail(Customer Quote) | The Master-Detail relationship to the parent Customer Quote record the Customer Quote Accessorial belongs to. |
Markup | Lookup(Carrier Markup) | A lookup to the Carrier Markup record associated with the Carrier Quote Accessorial. |
Name | Text(80) | The name/description of the accessorial. |
Notes | Text(200) | The optional details related to the accessorial charge. |
Quantity | Number(16, 2) | The number of units for an accessorial. |
Quote/Contract Id | Text(100) | The identifier used with the Falvey integration to match the insurance certificate number on the customer load with the accessorial record. |
Rate Entry | Lookup(Rate Entry) | A lookup to the Rate Entry record associated with the Customer Quote Accessorial. |
Stop | Lookup(Stop) | A lookup to the Stop record the accessorial is associated with. |
Unit | Picklist | The type of accessorial cost category. The default value is “Fixed Cost,” and many others available including: “Percent of Amount,” “Per Cubic Foot,” and “Per HU Position.” |
Unit Price | Currency(16, 2) | The per-unit monetary cost of the accessorial. |
Customer Quote Freight Charge Item
This object contains line itemized freight charges specific to a Customer Quote.
Field Name | Type | Description |
---|---|---|
Customer Quote | Master-Detail(Customer Quote) | The Master-Detail relationship to the parent Customer Quote record the Customer Quote Freight Charge Item belongs to. |
Discount % | Percent(3, 2) | The discount percent associated with this Freight Charge item. |
Discount Amount | Formula(Currency) | The discount monetary amount associated with this Freight Charge item. |
Freight Charge | Currency(10,2) | The pre-discount Freight Charge monetary amount associated with this Freight Charge item. |
Freight Charge Item Number | Auto Number | The unique record identifier. Example: Freight Charge Item-{000}. |
Item | Lookup(Line Item) | A lookup to the Line Item record this Freight Charge item relates to. |
Item Description | Text(255) | The item description of this Freight Charge item. |
Net Freight Charge | Formula(Currency) | The Freight Charge monetary amount including the Discount amount associated with this Freight Charge item. |
NMFC Class (Rated As) | Picklist | The NMFC Class for this Freight Charge item. No default value. |
Rate | Currency(10,2) | The monetary rate associated with this Freight Charge item. |
Weight | Number(18,0) | The weight in pounds of the line-item associated with this Freight Charge item. |
Customer Quote Tax
This object contains (Canadian sales) tax records for a Customer Quote.
Field Name | Type | Description |
---|---|---|
Customer Quote | Master-Detail(Customer Quote) | The Master-Detail relationship to the parent Customer Quote record the Customer Quote Tax belongs to. |
Name | Auto Number | The unique record identifier. Example: Tax-{0}. |
Sales Tax | Lookup(Sales Tax) | A lookup to the Sales Tax record this tax is calculated from. |
Stop | Lookup(Stop) | A lookup to the destination Stop record (if unique) this tax is calculated for. |
Tax Amount | Currency(16, 2) | The monetary amount of the Taxable Total multiplied by the Tax Rate. |
Tax Rate | Percent(3,3) | The Tax Rate percentage applied to the Taxable Total field. |
Taxable Total | Currency(16, 2) | The allocation of the total transportation monetary costs that this tax is calculated for. |
Customer Reference Number
This object defines customer-specific load and stop reference number requirements.
Field Name | Type | Description |
---|---|---|
Customer Reference | Auto Number | The unique record identifier. Example: Customer Reference-{0}. |
Load Validation Status | Picklist (Multi-Select) | The Load Statuses that are considered when validating the absence/presence of this customer reference number. Values include: “Tendered,” “Assigned,” “Dispatched,” “In Transit,” and “Delivered.” No default value. |
Mode | Picklist (Multi-Select) | The load Modes that will be considered when validating the absence/presence of this customer reference number. Values include: “Truckload,” “LTL,” “Intermodal,” “Drayage,” “Ocean FCL,” “Ocean LCL,” “Air Freight,” “Flatbed,” “Bulk,” and “Parcel.” No default value. |
TMS Field | Picklist | The Load and Stop fields that can be chosen as the customer reference number. Values include, “PO Number,” “PRO Number,” “Pickup/Delivery Number,” “Order Number,” and “Booking Number.” This field is dependent upon the TMS Object field. No default value. |
TMS Object | Picklist | Select the TMS object “Load” or “Stop” which controls the TMS Field dependent picklist. No default value. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Customer Reference Number belongs to. |
Customs Broker
This object defines customer-specific Customs Broker information for cross-border loads.
Field Name | Type | Description |
---|---|---|
Account | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Customs Broker belongs to. |
Broker | Auto Number | The unique record identifier. Example: Broker-{0}. |
Default | Checkbox | “Checked” for the primary Broker for a given country-to-country lane. |
Destination Country | Picklist (Multi-Select) | The lane destination country or countries for this broker. Values include: “CA,” “MX,” and “US.” No default value. |
Notes | Long Text Area(3000) | Notes specific to this Broker-Customer combination. |
Origin Country | Picklist (Multi-Select) | The lane origin country or countries for this Broker. Values include: “CA,” “MX,” and “US.” No default value. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Customs Broker belongs to. |
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. |
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 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. |
Enabled 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). |
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. |
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. |
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. |
Carrier | Formula (Text) | The Carrier record this driver contact record is related to. |
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. |
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. 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. |
Dispatch Status | Picklist | The current driver status. Values include: “Available” and “Unavailable.” “Available” is the default value. |
Do Not Hire | Checkbox | If “Checked,” the field indicates to not hire the driver. |
DOB | Date | The driver date of birth. |
Domicile | Formula (Text) | The mailing city and state from the driver contact record. |
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 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. |
Hire Date | Date | The date the driver was hired. |
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 contact record phone number. |
Primary Driver | Checkbox | When “Checked,” the driver is the primary driver in the cab. |
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. |
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. |
Tractor/Truck | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with the Tractor/Truck. |
Tractor/Truck as of | Date/Time | The date and time for the tractor/truck. |
Trailer 1 | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with Trailer 1. |
Trailer 1 as of | Date/Time | The date and time for Trailer 1. |
Trailer 2 | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with Trailer 2. |
Trailer 2 as of | Date/Time | The date and time for Trailer 2. |
Trailer 3 | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with Trailer 3. |
Trailer 3 as of | Date/Time | The date and time for Trailer 3. |
Trailers | Number(1, 0) | The quantity of associated trailers. |
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 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 |
---|---|---|
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,” “Orderful,” “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,” “Orderful,” “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,” “Orderful,” “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,” “Orderful,” and “Custom EDI.” No default value. |
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,” and “210.” 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}. |
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 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. |
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. |
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 tractor/truck and trailer/chassis assets.
Field Name | Type | Description |
---|---|---|
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. |
Current Location | Text(200) | The current location of the asset provided by the ELD device. |
Drop Location | Lookup(Account) | A lookup to the Account record for the location of a fleet asset when not assigned to a driver. |
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 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. |
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. |
Status | Picklist | The current state of the fleet asset. Values include: “In Service” and “Out of Service.” No default value. |
Trailer Model | Picklist | The fleet asset trailer model. Several values are available in the picklist. No default value. |
Type | Picklist | The type of fleet asset. Values include: “Tractor,” “Trailer,” “Box Truck,” and “Chassis.” No default value. |
Vehicle Make | Picklist | The fleet asset tractor make. Values include: “Freightliner,” “International,” “Kenworth,” “Mack,” “Peterbilt,” “Volvo,” and “Western Star.” No default value. |
Vehicle Model | Picklist | The fleet asset tractor model. 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
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,” 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. |
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. |
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 (EFS) fuel cards for management in the TMS.
Field Name | Type | Description |
---|---|---|
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. |
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. |
Driver | Lookup(Driver) | A lookup to the driver record that is currently using the fuel card. |
Fuel Card Name | Text(80) | The name of the fuel card. |
Fuel Card Provider | Picklist | The selection for the fuel card provider. Values include: “EFS.” No default value. |
Hand Enter | Picklist | The selection for manually entering fuel card information. Values include: “Allow,” “Disallow,” and “Policy.” No default value. |
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. |
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. |
Status | Picklist | The current state of the fuel card. Values include: “Active,” “Inactive,” “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. |
Confirmation Number | Text(50) (External ID) | The confirmation number returned by the fuel card provider. |
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. |
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. |
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. |
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. |
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. |
Inbound Email
This object contains inbound emails with attachments from third parties, such as Carrier invoice emails.
Field Name | Type | Description |
---|---|---|
Body | Rich Text Area(110000) | The text body of the inbound email. |
From | The inbound email sender. | |
Name | Auto Number | The unique record identifier. Example: Email-{0}. |
Status | Picklist | The selection for the status of the email. Values include: “New” and “Processed.” “New” is the default value. |
Subject | Text(255) | The subject of the inbound email. |
Incident
This Fleet Management object stores driver/asset incidents.
Field Name | Type | Description |
---|---|---|
Detailed Description | Rich Text Area (100,000) | Incident details. |
Incident Date/Time | Date/Time | The incident date and time. |
Incident ID | Auto Number | The unique record identifier. Example: Incident-{0}. |
Reported Date/Time | Date/Time | The date and time the incident was reported. |
Status | Picklist | The current state of the incident. Values include: “Open” and “Closed.” No default value. |
Summary | Text Area(255) | A summary of the incident. |
Type | Picklist | The incident type. Values include: “Personnel Issue,” and “Traffic Accident.” No default value. |
Inspection Report
This Fleet Management object captures fleet asset inspection reports.
Field Name | Type | Description |
---|---|---|
Category | Picklist | The category of the inspection. Values include: “Driver,” “Service Technician,” “USDOT,” “State Police,” and “Local Police.” No default value. |
Checklist Items | Roll-Up Summary (COUNT Checklist Item) | A rollup count of the checklist items from the inspection report. |
Description | Text Area(255) | A description of the inspection report. |
Fleet Asset | Lookup(Fleet Asset) | A lookup to the fleet asset record under inspection. |
Fuel Level | Percent(3, 0) | The percentage of fuel in the fleet asset fuel tank. |
Inspection Date | Date | The date of the inspection. |
Inspection Report | Auto Number | The unique record identifier. Example: Report-{0}. |
Inspection Report Template | Lookup(Inspection Report Template) | A lookup to the Inspection Record Template record used to create the inspection report. |
Inspection Status | Picklist | The current state of the inspection. Values include: “Pending,” “Started,” and “Complete.” “Pending” is the default value. |
Inspector (Contact) | Lookup(Contact) | A lookup to the Contact record for the associated inspector |
Inspector (Driver) | Lookup(Driver) | A lookup to the Driver record for the associated inspector. |
Inspector (User) | Lookup(User) | A lookup to the User record for the associated inspector. |
Items Failed | Roll-Up Summary (COUNT Checklist Item) | A rollup count of failed inspection items from the inspection report. |
Items Passed | Roll-Up Summary (COUNT Checklist Item) | A rollup count of passed inspection items from the inspection report. |
Items Pending | Roll-Up Summary (COUNT Checklist Item) | A rollup count of pending inspection items from the inspection report. |
Odometer Reading | Number(18, 0) | The mileage from the odometer reading at the inspection. |
Oil Life | Percent(3, 0) | The percentage of the remaining oil life. |
Overall Condition | Picklist | The condition of the asset under inspection. Values include: “Excellent,” “Good – Safe to Operate,” and “Poor – Unsafe to Operate.” No default value. |
Service Facility | Lookup(Account) | A lookup to the Account associated with the location of the inspection. |
Inspection Report Template
This Fleet Management object captures inspection report templates for cloning.
Field Name | Type | Description |
---|---|---|
Category | Picklist | The category of inspection. Values include: “Driver,” “Service Technician,” “USDOT,” “State Police,” and “Local Police.” No default value. |
Description | Text Area(255) | A description of the Inspection report template. |
Template Name | Text(80) | The unique record identifier. |
Inspection Report Template Item
This Fleet Management object captures inspection report template items for cloning.
Field Name | Type | Description |
---|---|---|
Category | Picklist | The category for the inspected item. No default value. |
Inspection Report Template | Master-Detail(Inspection Report Template) | The Master-Detail relationship to the parent Inspection Report Template record the Inspection Report Template Item belongs to. |
Order | Number(3, 0) | The order number of the item in the parent template list of items. |
Template Item | Text(80) | The unique record identifier. |
Insurance Policy
This object contains insurance policy information for Carriers and is used to evaluate Carrier fitness.
Field Name | Type | Description |
---|---|---|
Address | Text Area(255) | The location address of the insurance agent. |
Agent Company | Text(255) | The company name of the insurance agent. |
Agent Email | The email address of the insurance agent. | |
Agent First Name | Text(50) | The first name of the insurance agent. |
Agent Last Name | Text(50) | The last name of the insurance agent. |
Agent Phone | Phone | The phone number of the insurance agent. |
Agent Title | Text(50) | The job title of the insurance agent. |
Cancel Date | Date | The date an insurance policy was cancelled. |
City | Text(100) | The city location of the insurance agent. |
Country | Picklist | The country location of the insurance agent. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Coverage Amount | Currency(18, 0) | The monetary coverage amount for an insurance policy. |
Deductible | Currency(18, 0) | The monetary deductible amount for an insurance policy. |
Description | Text(100) | A description of the insurance policy populated by RMIS. |
Effective Date | Date | The insurance policy effective date. |
Expiry Date | Date | The insurance policy expiration date. |
Fax | Phone | The fax number for the insurance agent. |
Insurance Company | Text(255) | The insurance company name. |
Phone | Phone | The phone number of the Insurance company. |
Policy Number | Text(80) | The record identifier. |
Postal Code | Text(20) | The postal code location of the insurance agent. |
Reefer Breakdown Coverage | Picklist | The determination of insurance coverage for reefer breakdowns. Values include: “No” and “Yes.” “No” is the default value. |
Reefer Breakdown Deductible | Currency(18, 0) | The monetary amount of deductible for reefer breakdown claims. |
Source | Picklist | The origin of the insurance information. Values include: “Carrier,” “RMIS,” or “Assure Assist.” “Carrier is the default value.” |
State/Province | Text(30) | The state/province location of the insurance agent. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Insurance Policy belongs to. |
Type | Picklist | The policy type of insurance held by the Carrier. Values include: “Auto,” “BIPD,” “Bond,” “Cargo,” “Cargo with Reefer Breakdown,” “General,” “Workers Compensation,” and “Other.” No default value. |
Intermediate Carrier Stop
This object contains added stops for a Freight Plan Template (between customer load origins and destinations).
Field Name | Type | Description |
---|---|---|
Address | Formula (Text) | A formula field that contains the shipping address when a location field is populated. |
Freight Plan Template | Master-Detail(Freight Plan Template) | The Master-Detail relationship to the parent Freight Plan Template record the Intermediate Carrier Stop belongs to. |
Location | Lookup(Account) | A lookup to the Account location this Intermediate Carrier Stop is associated with. |
Number | Number(3, 0) | The order number of this intermediate stop. |
Stop Name | Text(80) | The name of the stop. |
Stop Type | Picklist | An informational field indicating the stop type. Values include: “Cross Dock,” “Airport,” “Seaport,” “Rail Terminal,” and “Other.” No default value. |
Lane
This object defines a specific origin-destination pair. Eight types of origins and destinations are supported:
Country | City/State | Zip 5 | Location (Account Record) |
State/Province | Zip 3 | Postal Code | Zone |
Field Name | Type | Description |
---|---|---|
Destination | Formula (Text) | The summary of destination information for the lane. |
Destination City | Text(40) | The destination city name of the lane. |
Destination Country | Picklist | The destination country name for the lane. Values include: “BE,” “CA,” “FR,” “MX,” “TN,” and “US.” No default value. |
Destination Location | Lookup(Account) | A lookup to the Account record location the Destination Location is associated with. |
Destination Location Name | Formula (Text) | The Destination Location Account name. |
Destination Postal Code | Text(20) | The destination complete postal code of the lane. |
Destination State/Province | Picklist | The destination state/province for the lane. This field is dependent on the selection from the Destination Country field. No default value. |
Destination Type | Picklist | The selection for the type of destination of the lane. Values include: “Country,” “State,” “City/State,” “Zip3,” “Zip5,” “Postal Code,” “Location,” and “Zone.” No default value. |
Destination Zip3 | Text(3) | The destination Zip3 code of the lane. |
Destination Zip5 | Text(5) | The destination Zip5 code of the lane. |
Destination Zone | Lookup(Zone) | A lookup to the Zone record the destination zone reference the lane is associated with. |
Destination Zone Name | Formula (Text) | The destination zone reference name. |
Lane | Text(80) | The name of the lane. For example, “Chicago to Houston.” |
Match Priority | Number(4, 0) | The order of priority for stored rate matches. |
Origin | Formula (Text) | The summary of origin information for the lane. |
Origin City | Text(40) | The origin city name of the lane. |
Origin Country | Picklist | The origin country for the lane. Values include: “BE,” “CA,” “FR,” “MX,” “TN,” and “US.” No default value. |
Origin Location | Lookup(Account) | A lookup to the Account record the Origin Location is associated with. |
Origin Location Name | Formula (Text) | The Origin Location Account name. |
Origin Postal Code | Text(20) | The origin complete postal code of a lane. |
Origin State/Province | Picklist | The origin state/province for the lane. This field is dependent on the selection from the Origin Country field. No default value. |
Origin Type | Picklist | The selection for the type of origin of the lane. Values include: “Country,” “State,” “City/State,” “Zip3,” “Zip5,” “Postal Code,” “Location,” and “Zone.” No default value. |
Origin Zip3 | Text(3) | The origin Zip3 code of the lane. |
Origin Zip5 | Text(5) | The origin Zip5 code of the lane. |
Origin Zone | Lookup(Zone) | A lookup to the Zone record the origin zone reference the lane is associated with. |
Origin Zone Name | Formula (Text) | The origin zone reference name. |
Line Item
The object contains the actual contents of loads – what is moved from origin to destination.
Each load has one or more Line Item records.
Field Name | Type | Description |
---|---|---|
Area | Number(10, 2) | The area of the handling units. |
Area Units | Picklist | The units of measure for the area of handling units. Values include: “Square Feet” and “Square Meters.” “Square Feet” is the default value. |
Auto-Calculate Area and Volume | Checkbox | If “Checked,” Area and Volume are auto-calculated based on Handling Unit count and dimensions. |
Cargo Summary | Text Area(255) | The summary of line item contents. |
Delivery Stop | Lookup(Stop) | A lookup to the Stop record for the associated delivery stop. |
Density | Number(10, 2) | The density of the line item based on weight and dimensions. |
Dimension Units | Picklist | The unit of measure for the Length/Width/Height of a line item Handling Unit (HU). Values include: “in,” “cm,” “ft,” and “m.” “In” is the default value. |
Extended Price | Currency(16, 2) | The price (to the ultimate consumer) of the line item. |
Handling Units | Picklist | The type of handling unit for a line item. Some examples include: “Bags,” “Boxes,” and “Containers.” No default value. |
HazMat | Checkbox | “Checked” when a line item is a hazardous material. |
HazMat Class/Division | Picklist | The classification of hazardous material. Some examples include: “1.1,” “2.1,” and “3.” No default value. |
HazMat Contact | Lookup(Contact) | A lookup to the Contact record for the shipper in case of emergency. |
HazMat Number | Text(4) | The United Nations number code for hazardous materials. |
HazMat Number Type | Picklist | The oversight type responsible for the HazMat numbering. Values include: “UN” and “NA.” No default value. |
HazMat Packaging Group | Picklist | The hazardous material grouping category. Values include: “I,” “II,” and “III.” No default value. |
Height | Number(16, 2) | The height of a handling unit. |
HS Code | Text(7) | The Harmonized System (HS) code for tax/tariff purposes. |
HTS Code | Text(12) | The Harmonized Tariff Schedule code for tax/tariff purposes. |
HU Count | Number(18, 0) | The Handling Unit Count. |
Item Description | Text(255) | A description of the item being shipped. |
Item Number | Text(80) | The Line Item identifier, such as a SKU number. |
Length | Number(16, 2) | The length of a handling unit. |
Linear Feet | Number(10, 2) | The linear feet required in a standard container/equipment. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Line Item belongs to. |
NMFC Class | Picklist | The standard NMFC class for an LTL load. Some values include: “50,” “77.5,” and “100.” No default value. |
NMFC Number | Text(20) | The NMFC Number for an LTL load. |
Original Reference | Lookup(Line Item) | A lookup to the Line Item record that is populated for Carrier loads in a freight plan and refers to the original customer load line item. |
Packaging Units | Picklist | The type of packaging unit. Some values include: “Baskets,” “Boxes,” and “Crates.” No default value. |
Pickup Stop | Lookup(Stop) | A lookup to the Stop record that is the location of the first stop. |
PU Count | Number(18, 0) | The number of packaging units for a line item. |
Schedule B Code | Text(12) | The Schedule B code for tax/tariff purposes. |
Stackable | Checkbox | “Checked” if the handling units are stackable. |
Turnable | Checkbox | “Checked” if the pallet can be turned sideways to fit more in the trailer. |
Volume | Number(18, 0) | The volume of the line item. |
Volume Units | Picklist | The units of measure for the volume of a line item. Values include: “Cubic Feet,” “Cubic Inches,” “Cubic Meters,” “Cubic Centimeters,” “Gallons,” and “Liters.” No default value. |
Weight | Number(18, 0) | The total weight of the line item. |
Weight Units | Picklist | The unit of measure for the weight of the line item. Values include: “lbs” and “kg.” “Lbs” is the default value. |
Width | Number(16, 2) | The width of a Handling Unit for the line item. |
Load
The foundational TMS object, representing a shipment that needs to be moved by a Carrier.
Field Name | Type | Description |
---|---|---|
Accounting Notes | Text Area(255) | The accounting notes passed to HubTran. |
API Load Id | Text(30) | The API-specific load ID (shipment ID from the Project44 API) for booking and tracking loads. |
Area Units | Picklist | The measurement unit type for the area of the load. Values include: “Square Feet” and “Square Meters.” “Square Feet” is the default value. |
Auto-Tender Status | Picklist | The current state of the load that is subject to the Auto-Tender process. Values include: “In Process,” “Successful,” “Unsuccessful,” and “Removed.” No default value. |
Benchmark Rate | Currency(16, 2) | The benchmark rate for the LTL workbench support field. |
Bill of Lading Number | Text(55) | The BOL document number as provided or generated for the load. |
Booking Number | Text(30) | The booking number for the load on an ocean Carrier. |
Cargo Summary | Long Text Area(1500) | The rollup of line-item Cargo summary fields. |
Cargo Value | Currency(16, 2) | The total monetary value of the load’s cargo. |
Carrier | Lookup(Account) | A lookup to the Account record responsible for moving the load. |
Carrier Bill To | Lookup(Account) | A lookup to the Account record responsible for paying vendor or Carrier invoice(s). |
Carrier Engagement Automation | Picklist (Multi-Select) | A selection for automation engagement to allow Carriers to post and tender loads. Values include: “Auto-Tender” and “Auto-Post.” No default value. |
Carrier Load | Checkbox | If “Checked,” this is a Carrier load in a freight plan or is any load NOT associated with a freight plan. |
Carrier Portal | Checkbox | If “Checked,” the load is exposed to the Carrier Portal for Carriers to submit quotes. |
Carrier Quote Link | URL(255) | An email loop link URL that allows for Carriers to submit quotes. |
Carrier Quote Total | Currency(16, 2) | The approved Carrier quote monetary amount. |
Carrier Remit To | Lookup(Account) | A lookup to the Account of the associated Carrier or Factoring Company to send the Carrier’s invoice(s). |
Carrier Rerate Notification | Checkbox | If “Checked,” the load information has changed and requires a rerate. |
Carrier Sales Rep | Lookup(User) | A lookup to the User record for the Carrier sales Rep. responsible for the load. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record used to move the load. |
Carrier Settlement Link | URL(255) | An email loop link URL that allows for settlement with the Carrier. |
Carrier Status Link | URL(255) | An email loop link URL that allows for sharing the status of the load. |
Carrier Uploads | Picklist (Multi-Select) | Documents received from the Carrier and attached to the load record. Values include: “BOL,” “POD,” “Invoice,” and “Weight Certificate.” No default value. |
Check Call Comments | Text Area(255) | A field for notes relating to check call statuses from the Carrier. |
City Lane | Text(100) (External ID) | An internal field to optimize lane searches. |
Clearance Number | Text(50) | The Customs clearance ID for international loads. |
COD Amount | Currency(16, 2) | The COD monetary amount to be collected on load delivery. |
COD Payment Terms | Picklist | The specific COD payment terms. Values include: “Prepaid” and “Collect.” No default value. |
COD Remit To | Lookup(Account) | A lookup to the Account record associated with the COD remit to. |
Commodity Condition | Picklist | The state of the commodity on the load. Values include: “New” and “Used.” No default value. |
Container/Trailer Number | Text(40) | The container or trailer number. |
Country Lane | Text(40) (External ID) | An internal field to optimize lane searches. |
Credit Limit Source | Picklist | The selection for the account to check for available credit. Values include: “Customer” and “Customer Bill To.” “Customer” is the default value. |
Customer | Lookup(Account) | A lookup to the Account record associated with this customer. The company responsible for the load. |
Customer Bill To | Lookup(Account) | A lookup to the Account record associated with this customer bill-to. The company billed for the load. |
Customer Check Acceptable | Checkbox | “Checked” indicates a customer check is acceptable for COD payment. |
Customer Invoice Documents Received | Checkbox | “Checked” if all the documents required for a customer invoice have been received. |
Customer Invoice Tax Amount | Currency(16, 2) | The monetary amount of all taxes on all Carrier invoices related to this load. |
Customer Invoice Total | Currency(16, 2) | The monetary amount of all customer invoices related to this load. |
Customer Invoice Transportation Total | Formula (Currency) | The sum of all customer invoices related to this load excluding taxes. |
Customer Load | Checkbox | If “Checked,” this is NOT a Carrier load as part of a freight plan. |
Customer Load Id | Text(50) | A load identifier field for Breakthrough Fuel and other purposes. |
Customer Payment Total | Currency(16, 2) | The total monetary sum of all customer payments related to this load. |
Customer Portal Threshold Surpassed | Checkbox | If “Checked,” the Portal HU Count or Weight Threshold of the customer TP were exceeded during load creation in the customer Portal. |
Customer Quote Tax Amount | Currency(16, 2) | The approved customer quote monetary tax amount. |
Customer Quote Total | Currency(16, 2) | The approved customer quote monetary amount. |
Customer Quote Transportation Total | Formula (Currency) | The approved customer quote monetary amount excluding taxes. |
Customer Rerate Notification | Checkbox | If “Checked,” the load information has changed and requires a rerate. |
Customer Sales Rep | Lookup(User) | A lookup to the User record associated with the customer sales rep. overseeing the load. |
Customer Tracking Link | URL(255) | A link to the community site where the CustomerShipmentTracking LWC is installed for customer load tracking. |
Customs Broker | Lookup(Account) | A lookup to the Account record associated with the customs broker for the load. |
Delivery Status | Formula (Text) | The load delivery status based on the last stop Arrival Status. |
Destination | Formula (Text) | The last stop destination city/state/country for the load. |
Distance (Kilometers) | Number(16, 2) | The total distance the load moves between the first stop and last stop based on truck routes in kilometers. |
Distance (Miles) | Number(16, 2) | The total distance the load moves between the first stop and last stop based on truck routes in miles. |
Document Options | Lookup(Document Options) | A lookup to the Document Options record when creating emails and PDF documents for the load. |
Driver | Lookup(Contact) | A lookup to the Contact record associated with the driver for the load. |
Driver Assignment Status | Picklist | A field for Fleet Management only. The driver assignment status for the load. Values include: “Hold,” “Unassigned,” “Partially Assigned,” and “Assigned.” No default value. |
Driver Comments | Text Area(255) | Comments from the driver assigned to the load. Can be entered via Trucker Tools phone application, for example. |
Driver Name | Text(50) | The name of the driver for the load. |
Driver Phone | Phone | The phone number of the driver for the load. |
EDI Decline Reason | Picklist | The reason the load order was declined (EDI 204). Values include: “Delivery Appointment Issue,” “Exceeded Capacity Limit,” “Incorrect Rate,” “Overweight Shipment,” “Short Lead Time Org Change,” “Tendered After Pickup Appointment,” “Transit Time Issue,” and “Unsuitable Pickup Appointment / Lack of Dock Space.” No default value. |
EDI Provider | Picklist | Service selection for sending and receiving EDI load information. Values include: “Kleinschmidt,” “Cleo,” “Orderful,” and “Custom EDI.” No default value. |
EDI Quote Currency | Text(3) | Informational only. The currency of any EDI provided quote from the load tender transaction. |
EDI Quote Total | Currency(16, 2) | Informational only. The quote total monetary amount of any EDI provided quote from the load tender transaction. |
EDI Response Deadline | Date/Time | The date and time before which an EDI 204 must be accepted or declined for the load with an EDI 990. |
EDI SCAC | Text(10) | The SCAC code sent for inbound EDI 204 tenders via Orderful. |
EDI Status | Picklist | The EDI status for 204 load tender transactions. Values include: “Pending,” “Accept,” “Decline,” “Update Pending from Customer,” “Updated by Customer,” and “Cancelled by Customer.” No default value. |
Entry Number | Text(50) | A government identifier used for cross-border import loads. |
Equipment Type | Lookup(Equipment Type) | A lookup to the Equipment Type record associated with the Carrier moving the load. |
Expected Delivery Date | Formula (Date) | The expected date of the last stop for the load. |
Expected Ship Date | Formula (Date) | The expected date of the first stop for the load. |
Faster Transit Comments | Long Text Area(1000) | Comments provided by the customer when faster transit is requested. |
First Stop | Lookup(Stop) | A lookup to the Stop record for the first stop of the load. |
Fleet | Checkbox | If “Checked,” the load is assigned via Fleet Management. |
Freeze Distance | Checkbox | If “Checked,” the load mileage is not overwritten with PC Miler data. |
Hashcode | Text(40) | A unique Hash code for Email Loop URL security. |
HazMat | Checkbox | “Checked” whenever the load contains hazardous material. |
Import/Export | Picklist | A selection for the destination of the load. Values include: “Import,” “Export,” and “Domestic.” No default value. |
In Freight Plan | Formula (Checkbox) | If “Checked,” the load is part of a freight plan. |
Insurance Amount | Currency(16, 2) | The total monetary amount of insurance for the load. Only used for EDI integrations. |
Insurance Certificate Number | Text(50) | The insurance certificate number provided by the Falvey insurance API. |
Insurance Certificate PDF Link | URL(255) | The URL to the insurance certificate. |
Insurance Policy Status | Picklist | The current state of the insurance policy for the load. Values include: “Pending,” “Authorized,” and “Voided.” No default value. |
Insurance Policy Status as of | Date/Time | The date and time of the most recent Insurance Policy Status update. |
Insurance Premium Amount | Currency(16, 2) | The monetary premium amount for the requested insurance policy for the load. |
Insurance Premium Application | Picklist | The specification for how an insurance premium has been applied to the load. Values include: “Added to Customer Quote,” and “Deducted from Carrier Quote.” No default value. |
Insurance Provider | Text(80) | The name of the company providing the insurance policy for the load. |
Insurance Provider Fee | Currency(16, 2) | Technology fee for the insurance integration. |
Insurance Service Fee | Currency(16, 2) | Customer fee added to the insurance premium. |
Insurance Shipment Id | Text(80) | The shipment ID returned from the insurance provider for identification purposes. |
Insured Amount | Currency(16, 2) | The cargo value of a load plus the insurance buffer percentage. |
Last Location Update Sent | Date/Time | The date and time the most recent EDI 214 location update was sent. |
Last Reported City | Text(40) | The most recent reported city for the load location. |
Last Reported Country | Picklist | The most recent reported country for the load location. Values include: “US,” “CA,” and “MX.” No default value. |
Last Reported Geolocation | Geolocation | The most recent reported latitude/longitude for the load location. |
Last Reported Location | Formula (Text) | The most recent reported city + state + country for the load location. |
Last Reported State/Province | Picklist | The most recent reported state/province for the load location. No default value. |
Last Stop | Lookup(Stop) | A lookup to the Stop record associated with the last stop for the load. |
Last Tracking Update | Date/Time | The most recent date and time a location update was received for the load. |
Last Tracking Update Source | Text(50) | The provider of the most recent tracking update for the load. |
Linear Feet | Number(10, 2) | The total linear footage on-the-truck for the load. This rolls up the linear footage measurements for the line items included on the load. |
Load Number | Text(80) | The unique record identifier. |
Load Posting Description | Text(200) | A description of the load that is sent to load boards. |
Load Sequence Number | Auto Number | An internal field to uniquely identify the load. |
Load Status | Picklist | Defines where the load is in the overall process. Values include: “Unassigned,” “Quotes Requested,” “Quotes Received,” “Tendered,” “Assigned,” “Dispatched,” “In Transit,” “Delivered,” “Completed,” “Cancelled,” “Declined,” and “Expired.” “Unassigned” is the default value. |
Load Status Comments | Text(255) | Load status text updates provided by the Carriers. |
Load Status Requested | Checkbox | If “Checked,” a load status email request has been sent to the Carrier for the load. |
Margin % (Invoiced) | Formula (Percent) | The calculated margin percentage is calculated based on the Customer and Vendor invoice totals. Margin (Invoiced) / Customer Invoice(s). |
Margin % (Paid) | Formula (Percent) | The calculated margin percentage is calculated based on the cash receipt and cash disbursement total amounts. Margin (Paid) / Customer Payment(s). |
Margin % (Quoted) | Formula (Percent) | The calculated margin percentage is calculated based on the accepted Customer and Carrier quote totals. Margin (Quoted) / Customer Quote Amount. |
Margin (Invoiced) | Formula (Currency) | The calculated margin amount is calculated based on the Customer and Vendor Invoice totals. Customer Invoice(s) – Carrier Invoice(s) for the load. |
Margin (Paid) | Formula (Currency) | The calculated margin amount is calculated based on the Cash Receipt and Cash Disbursement totals. Customer Payment(s) – Carrier Payment(s) for the load. |
Margin (Quoted) | Formula (Currency) | The calculated margin amount is calculated based on the accepted Customer quote totals and the Carrier quote totals. Approved Customer Quote – Approved Carrier Quote for the load. |
Master Bill of Lading Number | Text(55) | A load identifier number for container tracking. |
Master BOL Option | Picklist | Feld defines the Carrier BOL’s Shipper and Consignee for documentation. Values include: “Shipper to Consignee,” “Shipping Agent to Receiving Agent,” “Shipper to Receiving Agent,” and “Shipping Agent to Consignee.” “Shipper to Consignee” is the default value. |
Max Pay Amount | Currency(16, 2) | The maximum monetary amount allowed for the Carrier cost for the load. |
Mileage API Borders | Picklist | A setting to control routes across international borders. Values include: “Borders Closed” and “Borders Open.” “Borders Closed” is the default value. |
Mode | Lookup(Mode) | A lookup to the Mode record associated with the load. Usually selected at load creation. |
Mode Name | Formula (Text) | The mode name of the load. |
Next Check Call | Date/Time | The date and time of the next check call with the Carrier or driver for the load. |
Notify Party | Lookup(Contact) | A lookup to the Contact record associated with the party to notify for ocean load mode. |
Offer Rate | Currency(16, 2) | The monetary rate offered to Carriers for the load. |
Offer Rate Type | Picklist | The rate type for the load. Values include: “Fixed Cost,” “Rate per Mile,” and “Rate per Kilometer.” No default value. |
Order Date | Date | The date the customer ordered the load. |
Order Number | Text(50) (External ID) (Unique Case Insensitive) | A globally unique order number for the customer of the load. |
Order Total | Currency(16, 2) | The total monetary value amount of the load to the customer. |
Origin | Formula (Text) | The first stop city/state/country of the load. |
OTD Counter | Formula (Number) | A representation of the arrival time of the load to a stop. “0” if load is late, “1” the load is early or on time. |
Other Carrier Capabilities | Picklist (Multi-Select) | The Carrier requirements necessary for the load. Values include: “Bonded (Canada),” “Bonded (US),” “CARB-Truck Compliant (California),” “CARB-TRU Compliant (California),” “C-TPAT Certified (US),” “FAST Certified (US),” “HazMat Certified (US),” “SmartWay Certified (US),” “Tanker Endorsed,” “TDG Certified (Canada),” “TSA Certification,” and “TWIC Certification.” No default value. |
Other Instructions | Long Text Area(3000) | Miscellaneous load instructions for the Carrier in addition to any pickup/delivery instructions. |
Payment Terms | Picklist | The terms for payment of the load. Values include: “Prepaid,” “Collect,” and “Third Party.” No default value. |
Pickup/Delivery Status | Long Text Area(1500) | The Carrier status summary information for each load stop. |
PO Number | Text(100) | The customer purchase order number for the load. |
POD Received | Checkbox | If “Checked,” proof of delivery has been received. This field is set automatically from the Carrier/driver status update pages if a POD is uploaded. |
Postal Code Lane | Text(60) (External ID) | An internal field to optimize lane searches. |
PRO Number | Text(40) | For LTL loads, the Carrier assigns a PRO Number to the load. |
Rate Export Date | Date/Time | This field is set when the LoadDex Rate Data upload batch process runs. |
Receiving Agent | Lookup(Account) | A lookup to the Account record associated with the receiving agent for the load. |
Recurring Load Schedule | Lookup(Recurring Load Schedule) | A lookup to the Recurring Load Schedule record. For cloned loads, this field contains the original Recurring Load Schedule. |
Relay | Checkbox | If “Checked,” the load is a Fleet Management load with multiple driver legs. |
Requested delivery Date | Date | The date requested for faster transit. |
Requested Delivery Time | Time | The time requested for faster transit. |
Rerate Fingerprint | Text(100) | The stored image of a load configuration used to detect changes to the load information. |
Review Before Tender | Boolean | If “Checked,” the customer portal load requires internal review. |
RFP | Lookup(RFP) | A lookup to the RFP record associated with the load via the LTL Workbench. |
Sales Status | Picklist | The broker sales status on the quoted load. Values include: “Pending,” “Won,” and “Lost.” “Pending” is the default value. |
Save & Rate Chosen | Checkbox | "Checked" when a load is created from clone or EDI with the Save & Rate option. Synchronizes the FQA with rating that happens asynchronously in a platform event. |
Schedule Status | Picklist | The current schedule status of the load. Values include: “On Schedule” and “Behind Schedule.” No default value. |
Service Level | Lookup(Service Level) | A lookup to the Service Level record associated with the speed of service (standard or expedited) of the Carrier. |
Ship From Address | Formula (Text) | The street, city, state, and postal code address of the first stop of the load. |
Ship Status | Formula (Text) | The Arrival Status for the first stop of the load. |
Ship To Address | Formula (Text) | The street, city, state, and postal code address of the last stop of the load. |
Shipping & Handling | Currency(16, 2) | The monetary amount for load shipping and handling charges. |
Shipping Agent | Lookup(Account) | An lookup to the Account record associated with the shipping agent for the load. |
Shipping Instructions Due Date | Date | The date by which the final shipping instructions must be sent to the ocean Carrier. |
Shipping Instructions Version | Number(2, 0) | The version number of the next shipping instructions to be sent to INTTRA for an Ocean FCL mode load. |
Site URL | Text(200) | An internal field to support email link generation. |
State Lane | Text(40) (External ID) | An internal field to optimize lane searches. |
Stops | Roll-Up Summary (COUNT Stop) | The number of stops for the load. |
Tax Exempt | Checkbox | If “Checked,” the load is exempt from freight taxes for billing purposes. |
Team | Checkbox | If “Checked,” a driver team is required for the load. |
Temperature Controlled | Checkbox | If “Checked,” the load is temperature controlled. |
Temperature Run Type | Picklist | The selection for the temperature control setting. Values include: “Continuous” and “Cycle.” No default value. |
Temperature Setting Maximum | Number(4, 0) | The maximum temperature for the load. |
Temperature Setting Minimum | Number(4, 0) | The minimum temperature for the load. |
Temperature Units | Picklist | The temperature measurement units for the load. Values include: “F” and “C.” No default value. |
Tender Accept Link | URL(255) | An Email Loop Link URL for accepting the load tender. |
Tender Accepted Date | Date/Time | The date and time the Carrier accepted the load tender. |
Tender Decline Link | URL(255) | An Email Loop Link URL for declining the load tender. |
Terminal Cutoff Date | Date/Time | The date and time before which an ocean container must arrive at the terminal. |
Total Area | Number(10, 2) | The total area of the handling units of the load. |
Total Insurance Premium | Currency(16, 2) | The Insurance premium amount plus the service fee plus the provider fee. |
Total Volume | Number(18, 0) | The total volume as a sum of the line-item volumes of the load. |
Total Weight | Number(18, 0) | The total weight as a sum of the line-item weights of the load. |
Tracking Duration | Picklist | Total time to track a load. Several values available including: "1 hour," "4 hours," and "7 days." |
Tracking Notes | Text Area(255) | Notes sent when tracking a load. |
Tracking Number | Text(40) | The Tracking ID of third-party load status tracking providers. Information is obtained from MacroPoint and other integrators. |
Tracking Number (Customer) | Text(40) | The Tracking ID of the customer’s third-party load status tracking providers. Outbound updates are sent to this API integration. |
Tracking Provider | Text(40) | The third-party providing tracking information for the load. |
Tracking Provider (Customer) | Text(40) | The customer’s third-party load status tracking provider. Outbound updates are sent to this API integration. |
Tracking Update Email List | Text Area(255) | Comma separated list of email addresses to receive tracking notifications. MacroPoint only. |
Tracking Update Interval | Picklist | The update interval for a tracking session. Values include: "15 minutes," "30 minutes," "60 minutes," "2 hours," "4 hours," "8 hours," and "12 hours." No default value. |
Tractor Number | Text(40) | The power unit identifier provided by the Carrier. |
Ultimate Consignee | Lookup(Account) | A lookup to the Account record associated with the ultimate consignee in the case of xxx-to-port Ocean FCL loads. This information is needed for shipping instructions. |
Vendor | Lookup(Account) | A lookup to the Account record associated with the capacity provider for the load. Usually, this company is the Carrier. |
Vendor Invoice Processor | Picklist | The company responsible for processing vendor invoices. Values include: “HubTran” or blank. No default value. |
Vendor Invoice Total | Currency(16, 2) | The total monetary sum of all the Carrier/Vendor invoices related to the load. Note that the API name of this field is: “CarrierInvoiceTotal__c.” |
Vendor Payment Total | Currency(16, 2) | The total monetary sum of all Carrier/Vendor payments related to the load. Note that the API name of this field is “CarrierPaymentTotal__c.” |
VGM Cutoff Date | Date/Time | The date and time by which the container VGM documentation must be submitted to the Ocean Carrier. |
Volume Units | Picklist | The volumetric units for the Total Volume field. Values include: “Cubic Feet,” “Cubic Inches,” “Cubic Meters,” “Cubic Centimeters,” “Gallons,” and “Liters.” No default value. |
Warehouse Contact | Lookup(Contact) | A lookup to the Contact record associated with the Warehouse for any instructions. |
Weight Units | Picklist | The unit of measure of weight for the Total Weight field. Values include: “lbs” and “kg.” “Lbs” is the default value. |
Zip3 Lane | Text(7) (External ID) | An internal field to optimize lane searches. |
Zip5 Lane | Text(11) (External ID) | An internal field to optimize lane searches. |
Load Accessorial
This object contains accessorial charges associated with a load.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | The Master-Detail relationship to the parent Accessorial record the Load Accessorial belongs to. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Load Accessorial belongs to. |
Name | Text(80) | The accessorial name/description. |
Provider | Picklist | The company that originates the accessorial. Values include: “Carrier” and “Third Party.” “Carrier” is the default value. |
Stop | Lookup(Stop) | A lookup to the Stop record associated with this load accessorial. |
Load Email
This object defines additional email addresses that are added to specific outbound emails from the TMS.
Field Name | Type | Description |
---|---|---|
Contact | Lookup(Contact) | A Lookup to the associated Contact record associated with this load email. |
Document Option Actions | Picklist (Multi-Select) | The outbound email type to use the email for. "Carrier Load Tender," "Customer Invoice," etc. |
Email Address | The email address used. | |
Email Recipient Type | Picklist | The email send type: "To," "CC," or "BCC." |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Load Email belongs to. |
Name | Auto Sequence | The unique record identifier. Example: LE-{0}. |
Target Email | Formula (Text) | The email address from the User, Contact, or Email Address field. |
User | Lookup(User) | A lookup to the User record associated with this load email. |
Load Entry Reference
This object contains account specific configurable references for entry on the customer portal.
Field Name | Type | Description |
---|---|---|
Label | Picklist | Selection options for load reference labels. Values include: “Order Number,” “Reference Number,” and “PO Number.” No default value. |
Reference Name | Auto Number | The unique record identifier. Example: Reference-{0}. |
Required | Checkbox | If “Checked,” the load entry is required on the customer portal. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Load Entry Reference belongs to. |
Type | Picklist (Multi-Select) | Load entry selection field for the customer or stop locations. Values include: “Customer,” “Pickup,” and “Delivery.” No default value. |
Load Involved
This Fleet Management object captures loads involved in Incident records.
Field Name | Type | Description |
---|---|---|
Comments | Text Area(255) | Comments regarding the load involved in the incident. |
Incident | Master-Detail(Incident) | The Master-Detail relationship to the parent Incident record the Load Involved belongs to. |
Load | Lookup(Load) | A lookup to the Load record associated with the load involved incident. |
Load Involved ID | Auto Number | The unique record identifier. Example: Load Involved-{0}. |
Open Claims | Picklist | Selection for if there are open claims against the load. Values include: “Yes” and “No.” No default value. |
Load Posting
This object stores load postings made to the DAT, LoadBoard Network, and Internet Truckstop load boards.
Field Name | Type | Description |
---|---|---|
Allow Booking | Checkbox | If “Checked,” a Carrier is allowed to book from the load board (Truckstop Only). |
Description | Text(200) | A description of the load/cargo. |
Equipment Type | Text(100) | The desired equipment type to appear in the load posting. |
Equipment Type Code | Text(100) | The code for the desired equipment type to appear in the load posting. |
Full Truckload | Checkbox | “Checked” for FTL loads and “Unchecked” for LTL loads. |
Last Update | Date/Time | The date and time the load posting was created or most recently updated. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Load Posting refers to. |
Load Board | Picklist | The selection of the load board to post to. Values include: “DAT,” “Truckstop 2,” “TransCore,” “LoadBoard Network,” and “Trucker Tools Load Board. No default value. |
Load Board Posting ID | Text(40) | The internal load board posting ID. |
Offer Rate | Currency(16, 2) | The monetary rate offered by the user posting the load. |
Offer Rate Type | Picklist | The selection for the type of rate offered for the load posting. Values include: “Fixed Cost” and “Rate per Mile.” “Fixed Cost” is the default value. |
Original Poster | Lookup(User) | A lookup to the User record associated with the original poster of the load. |
Posting | Auto Number | The unique record identifier. Example: Posting-{0}. |
Truck Length | Number(18, 0) | The length (in feet) of the desired truck. |
Load Reference
This object stores load and stop EDI reference numbers received from 204 EDI tender transactions.
Field Name | Type | Description |
---|---|---|
Label | Text(100) | Label or Text for reference number. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Load Reference belongs to. |
Name | Auto Number | The unique record identifier. Example: Reference-{0}. |
Stop | Lookup(Stop) | A lookup to the Stop record associated with the stop-level reference numbers. |
Stop Number | Number(18, 0) | The order number of the stop. |
Type | Text(30) | The type of reference number. |
Value | Text(200) | The value of the reference number. |
Mode
This object defines the transportation modes supported within the TMS installation.
Field Name | Type | Description |
---|---|---|
Carrier Application | Checkbox | If “Checked,” the Equipment Type is available in the online Carrier application. |
Cust Portal Past Date Tender Msg | Rich Text Area(500) | A header message displayed on the load and Carrier Quote page of the Customer Portal when the pickup date is in the past. |
Cust Portal Same Day Pickup Msg | Rich Text Area(500) | A header message displayed on the load and Carrier Quote page of the Customer Portal when the pickup date is today. |
Cust Portal Same Day Tender Disabled Msg | Rich Text Area(500) | A header message displayed on the Carrier Quote page of the Customer Portal when the Tender Cutoff time has passed. |
Customer Portal Description | Text(255) | The text displayed on the mode selection page in the Customer Portal. |
Customer Portal Icon | Text(255) | The Salesforce ID of the image used for the mode icon in the Customer Portal. |
Customer Portal Selection | Checkbox | When “Checked,” this mode appears on the Customer Portal. |
Default Equipment Category | Picklist | Used by the LaneIQ Network for database queries. Values include, "Van," "Flatbed," "Reefer," "Specialized," and "Ocean/Intermodal." No default value. |
Default Equipment Type | Lookup(Equipment Type) | A lookup to the Equipment Type record associated with the mode. |
Enabled | Checkbox | If “Checked,” the mode can be selected when defining Carrier Services. |
LTL | Checkbox | If “Checked,” the mode is an LTL mode. |
Maximum Weight | Number(18, 0) | The maximum weight default for the mode. This field is used when creating Carrier Services. |
MCP Mode | Text(80) | The mode specified when using MyCarrierPackets. |
Minimum Weight | Number(18, 0) | The minimum weight default for the mode. This field is used when creating Carrier Services. |
Name | Text(80) | The mode name, such as “LTL.” |
Order | Number(2, 0) | The listed ordering of modes. |
Past Date Tender Message | Rich Text Area(500) | A header message displayed for internal users on the Carrier Quote Builder and Carrier Quote List of the load page, and the Carrier Quote record when the pickup date is in the past. |
Render Item Number and Desc Fields Last | Checkbox | When “Checked,” the Item Number and Item Description display as the last two fields in the line-item entry prior to Pickup Stop and Delivery Stop. |
Required Application Documents | Picklist (Multi-Select) | The documents that are required to upload during the online Carrier application process. Values include: “Completed W9 Tax Form,” “Certificate of Insurance,” and “Operating Authority.” No default value. |
Rerate Notification | Checkbox | If “Checked,” the mode information has changed and requires a rerate. |
RMIS Code | Text(10) | The RMIS-specific integration code for this mode. |
Same Day Pickup Message | Rich Text Area(500) | A header message displayed for internal users on the Carrier Quote Builder and Carrier Quote List of the load page, and the Carrier Quote record when the pickup date is today. |
Same Day Tender Disabled Message | Rich Text Area(500) | A header message displayed for internal users on the Carrier Quote Builder and Carrier Quote List of the load page, and the Carrier Quote record when the Tender Cutoff Time has passed. |
Show Carrier on Shipment Tracking | Checkbox | If “Checked,” the Carrier name and logo are displayed in the CustomerShipmentTracking LWC. |
Show Containers on Load Creation | Checkbox | If “Checked,” the container list is displayed when building a new load. |
Weight Units | Picklist | During the auto-creation of Carrier Services, this field provides for the weight units for the minimum and maximum weight fields on a load. Values include: “lbs” and “kg.” “Lbs” is the default value. |
Payment Terms
This object defines vendor payment term details.
Field Name | Type | Description |
---|---|---|
Carrier Application | Checkbox | If “Checked,” the Equipment Type is available in the online Carrier Application. |
Enabled | Checkbox | If “Checked,” the Payment Terms are available. |
Name | Text(80) | A description of the Payment Terms. |
Order | Number(3, 0) | The order of the Payment Terms in picklists. |
Payment Days Due | Number(3, 0) | The number of days before a payment is due. |
Payment Discount % | Percent(3, 2) | The percent discount from the quote total to be applied to the invoice. |
Portal Selection | Checkbox | If “Checked,” the Payment Terms are available to Carriers on the Carrier Portal. |
Type | Picklist | The selection for the type of Payment Terms. Values include: “Vendor,” which is the default value. |
PerformanceIQ Configuration
This object captures the settings of the PerformanceIQ component and current org storage limits.
Field Name | Type | Description |
---|---|---|
Configuration State | Long Text Area(10000) | The JSON serialized settings of the PerformanceIQ component. |
Data Storage | Number(18, 0) | The org’s current data usage in MB. |
Data Storage Max | Number(18, 0) | The org’s maximum allowable data usage in MB. |
File Storage | Number(18, 0) | The org’s current file usage in MB. |
File Storage Max | Number(18, 0) | The org’s maximum allowable file usage in MB. |
Name | Auto Number | The unique record identifier. Example: Configuration-{0}. |
Person Involved
This Fleet Management object captures persons involved in Incident records.
Field Name | Type | Description |
---|---|---|
Comments | Text(255) | Comments regarding a person involved in an incident. |
Contact | Lookup(Contact) | A lookup to the Contact record associated with the incident. |
Employee/Contractor | Lookup(User) | A lookup to the User record associated with the Employee/Contractor involved in the incident. |
Follow-Up Action | Text(255) | A description of the follow-up action that is required. |
Follow-Up Date/Time | Date/Time | The date and time for follow-up. |
Incident | Master-Detail(Incident) | The Master-Detail relationship to the parent Incident record the Person Involved belongs to. |
Person Involved ID | Auto Sequence | The unique record identifier. Example: Person Involved-{0}. |
Reported Date/Time | Date/Time | The date and time an incident was reported. |
Reported Incident | Checkbox | If “Checked,” the person reporting was involved in the incident. |
Role | Picklist | The role of the person involved. Values include: “Police,” “Witness,” “Direct,” and “Other.” No default value. |
Supervisor | Lookup(User) | A lookup to the User record associated with the supervisor of the person involved. |
Portal Configuration
This object defines the text content on the Customer Self-Serve Portal.
Field Name | Type | Description |
---|---|---|
Cargo Insurance Authorization | Rich Text Area(10000) | The text is displayed to the customer when authorizing insurance on the last page of the Quote Wizard. |
Cargo Insurance Excluded Commodities | Rich Text Area(10000) | The message is displayed to the customer when clicking the “View Excluded Commodities” link and authorizing insurance on the last page of the Quote Wizard. |
Cargo Insurance Opt Out | Rich Text Area(10000) | The message is displayed to the customer if they opt out of insurance by unchecking the “Show Cargo Insurance Options” checkbox. |
Cargo Insurance Overview | Rich Text Area(10000) | The message is displayed to the customer when clicking the “Learn More” link regarding insurance. |
Credit Hold Message | Rich Text Area(10000) | The message is displayed to the customer if they have exceeded their credit limit. |
Load Entry Only Message | Rich Text Area(10000) | The message is displayed to the customer after non-LTL load has been created and cannot be quoted via the Customer Portal. |
Load Entry Page Footer | Rich Text Area(10000) | The footer text displayed to the customer on the load entry page. |
Mode Selection Page Header | Rich Text Area(10000) | The header text displayed when the customer is selecting a mode. |
Name | Auto Name | The unique record identifier. Example: Configuration-{0}. |
No Carrier Quotes Message | Rich Text Area(10000) | The text that is displayed to the customer if no LTL API quotes are available for a load. |
Post-Tender Page Footer | Rich Text Area(10000) | The footer text that is displayed after a customer tenders a load. |
Pre-Tender Page Footer | Rich Text Area(10000) | The footer text that is displayed before a customer tenders a load. |
Quote List Page Footer | Rich Text Area(10000) | The footer text that is displayed on the LTL API quote list page. |
Review Before Tender Message | Long Text Area(10000) | The message displayed to the customer if loads require internal review after tendering from the Customer Portal. |
Tender Failed Alert Email | The email address to send alerts when a Customer Portal tender fails. |
Queued Transaction
This object contains asynchronously executed inbound and outbound web API transactions.
Field Name | Type | Description |
---|---|---|
Content Type | Text(50) | Mime type of data packet. |
Direction | Picklist | Values include: “Inbound” and “Outbound.” No default value. |
Error Detail | Long Text Area(2000) | The details of any processing error. |
Fingerprint | Text(200) | The unique Hash code for duplicate detection. |
In Process | Checkbox | If "Checked,” the transaction has been queued by the batch process. |
Payload 1 | Long Text Area(130,000) | The packet payload. |
Payload 2 | Long Text Area(130,000) | The packet payload remainder if it does not fit completely in Payload1. |
Processing Time | Number(10, 3) | How long (in seconds) it takes to process the transaction. |
Processor | Text(100) | The service that processes the transaction. |
Request IP Address | Text(20) | The sender IP address for inbound packets. |
Status | Picklist | The processing status for the packet/transaction. Values include: "Pending," "Processed," "Failed," "Retry Failed," and "Invalid." "Pending" is the default value. |
Status (Indexed) | Text(40) (External ID) | The indexed version of the Status field used for quick start() method. |
Transaction | Auto Number | The unique Record Identifier. Example: Transaction-{0}. |
Rate Calculation
This object allows users to define blended Carrier rate estimates based on internal and load board data.
Field Name | Type | Description |
---|---|---|
Active | Checkbox | If “Checked,” the rate calculation is active and will be calculated for loads. |
Description | Text Area(255) | The text description of the rate calculation. |
Lane | Lookup(Lane) | A lookup to the Lane record to use for matching purposes. |
Match Priority | Number(4,0) | The match priority for evaluating the best match to a load. |
Mode | Master-Detail(Mode) | The Master-Detail relationship to the parent Mode record the Rate Calculation belongs to. |
Name | Text(80) | The unique record identifier. |
Rate Calculation Rule
This object allows users to define blended carrier rate estimates based on internal and load board data.
Field Name | Type | Description |
---|---|---|
Data Source | Picklist | The source of the data for rate calculations. Values include: “TMS,” “DAT,” “FreightWaves,” "LaneIQ Network," “Truckstop,” and “Custom Source.” No default value. |
Distance Units | Picklist | The unit of measure for distance in rate calculation rules. Values include: “Miles” and “Kilometers.” “Miles” is the default value. |
Equipment Category | Picklist | The equipment category applicable to this rate calculation rule. Values include: “Van,” “Flatbed,” “Reefer,” “Specialized,” and “Ocean/Intermodal.” This field is dependent on the Data Source field. No default value. |
Lookback Days | Picklist | The number of days’ worth of data to include in the rate calculation rule. Values include: “3,” “7,” “15,” “30,” and “N/A.” This field is dependent on the Paid/Posted field. No default value. |
Name | Auto Number | The unique record identifier. Example: Rule-{0}. |
Paid/Posted | Picklist | Values include: “Paid,” “Posted,” “Contracted,” and “N/A.” “Paid” is the default value. This field is dependent on the Data Source field. |
Rate Calculation | Master-Detail(Rate Calculation) | The Master-Detail relationship to the parent Rate Calculation record the Rate Calculation Rule belongs to. |
Rate Type | Picklist | The type of rate the rate calculation rule applies to. Values include: “Spot,” and it is the default value. |
Search Radius | Picklist | The radius size for the rate calculation rule. Values include: “10,” “25,” “50,” “75,” “100,” “125,” “150,” “200,” and “N/A.” This field is dependent on the Data Source field. No default value. |
Threshold | Number(5, 0) | The minimum number of loads required to match this rule. |
Weight | Percent(3, 2) | The weighting factor percentage for this rule in the blended rate. |
Rate Entry
This object defines pre-negotiated lane rates for customers and Carriers.
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record for the associated rate entry. |
Accessorial Name | Formula (Text) | The name of the accessorial associated with the rate entry. |
Apply Discounts To | Picklist | The selection for applicable discounts. Values include: “Charges” and “Rates.” “Charges” is the default value. |
Apply Surcharge To | Picklist | The selection for applicable surcharges. Values include: “Net” and “Gross.” “Net” is the default value. |
Auto-Apply | Checkbox | If "Checked," automatically apply the Accessorial Rate Entry during the rating process. |
Auto-Tender | Checkbox | If “Checked," allow the Carrier Quote to be auto-tendered. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record associated with the rate entry. |
Category | Picklist | The selection for the category of rate entry. Values include: “Customer” and “Carrier.” No default value. |
Destination Free Days | Number(3, 0) | The number of days a container can sit at the port of receipt before accruing demurrage charges. |
Direct/Interline | Picklist | An LTL Workbench support field selecting the type of movement for the rate entry. Values include: “Direct,” “Interline,” “Partner,” and “Unspecified,” “Direct - Direct,” “Direct - Interline,” and many others. No default value. |
Effective Date | Date | The date when a rate entry becomes valid. |
Estimated Transit Time (Days) | Number(3, 0) | The number of days to ship a load at the service level specified. |
Expected Load Volume | Number(10, 0) | The expected load volume for this (RFP) lane. |
Expiration Date | Date | The date after which the rate entry is no longer valid. |
Fleet Loads Only | Checkbox | If “Checked,” only Fleet loads will match the rate entry. |
Fuel Surcharge | Lookup(Fuel Surcharge) | A lookup to the Fuel Surcharge record associated with the rate entry. |
Lane | Lookup(Lane) | A lookup to the Lane record associated with this rate entry. |
Lane Match Option | Picklist | The selection for the lane match option for the rate entry. Values include: “Intrastate Only” and “Interstate Only.” No default value. |
LTL Surcharge | Percent(2, 2) | The LTL tariff percentage for the rate entry. |
Match Priority | Number(4, 0) | A number representing the match priority for the rate entry for a lane. |
Maximum Alternation Weight | Number(5, 0) | The maximum alternation weight threshold based on the appropriate tariff schedule for LTL loads. |
Minimum Charge Discount | Percent(2, 2) | The minimum charge discount percentage based on the appropriate tariff schedule for LTL loads. |
Minimum Charge Floor | Currency(5, 2) | The minimum monetary amount for the charge floor based on the appropriate tariff schedule for LTL loads. |
Mode | Lookup(Mode) | A lookup to the Mode record associated with Carrier Service and Carrier rates. The mode selected by the user for customer rates. |
Movement Type | Picklist | An ocean FCL field for selecting the type of movement of the load. Values include: “Door to Door,” “Door to Port,” “Port to Door,” and “Port to Port.” No default value. |
NMFC Class 100 = | Picklist | The NMFC Class 100 input. No default value. |
NMFC Class 110 = | Picklist | The NMFC Class 110 input. No default value. |
NMFC Class 125 = | Picklist | The NMFC Class 125 input. No default value. |
NMFC Class 150 = | Picklist | The NMFC Class 150 input. No default value. |
NMFC Class 175 = | Picklist | The NMFC Class 175 input. No default value. |
NMFC Class 200 = | Picklist | The NMFC Class 200 input. No default value. |
NMFC Class 250 = | Picklist | The NMFC Class 250 input. No default value. |
NMFC Class 300 = | Picklist | The NMFC Class 300 input. No default value. |
NMFC Class 400 = | Picklist | The NMFC Class 400 input. No default value. |
NMFC Class 50 = | Picklist | The NMFC Class 50 input. No default value. |
NMFC Class 500 = | Picklist | The NMFC Class 500 input. No default value. |
NMFC Class 55 = | Picklist | The NMFC Class 55 input. No default value. |
NMFC Class 60 = | Picklist | The NMFC Class 60 input. No default value. |
NMFC Class 65 = | Picklist | The NMFC Class 65 input. No default value. |
NMFC Class 70 = | Picklist | The NMFC Class 70 input. No default value. |
NMFC Class 77.5 = | Picklist | The NMFC Class 77.5 input. No default value. |
NMFC Class 85 = | Picklist | The NMFC Class 85 input. No default value. |
NMFC Class 92.5 = | Picklist | The NMFC Class 92.5 input. No default value. |
Notes | Long Text Area(2000) | Notes related to optional accessorials for the rate entry. |
Prevent Deficit Rating | Checkbox | If “Checked,” deficit weights on LTL loads are not allowed when using SMC3 rates. |
Pricing Notes | Long Text Area(10000) | Notes regarding pricing that are displayed in the Freight Quote Assistant. |
Pricing Owner | Lookup(User) | A lookup to the User record associated with pricing this (RFP) rate entry. |
Priority | Picklist | The Carrier preference level for a lane. Values include: “1,” “2,” and “3.” No default value. |
Quote/Contract Id | Text(100) | The Quote identifier passed on to quotes created based on the rate entry. |
Rate Adjustment Factor | Number(1, 4) | An LTL tariff schedule field for multiplying rates. |
Rate Entry | Auto Number | The unique record identifier. Example: Rate Entry {0}. |
Rate Type | Picklist | The Freight/Fuel/Accessorial rate type. Values include: “Freight+Fuel+Accessorial,” “Freight+Fuel,” “Freight,” “Fuel,” and “Accessorial.” No default value and is required to create a new rate entry. |
RFP | Lookup(RFP) | A lookup to the RFP record associated with this rate entry. |
Sales Floor | Currency(16, 2) | The lowest monetary amount that may be quoted to a customer. |
Service Level | Lookup(Service Level) | A lookup to the Service Level record associated with the rate entry. Values include: “Standard” or “Expedited.” |
Shipper Comments | Text Area(255) | Comments from the shipper related to the (RFP) lane. |
Status | Picklist | The status of the rate entry. Values include: “Pending,” “Quoted,” “Accepted,” “Rejected,” and “Cancelled.” “Pending” is the default value. |
Tariff Description | Text Area(255) | A text description of the tariff for the rate entry. |
Tariff Effective Date | Date | The date when a tariff becomes valid. |
Tariff Name | Picklist | The name of the tariff schedule to apply to the rate entry. No default value. |
TL Surcharge | Percent(2, 2) | A percentage surcharge for a Truckload rate entry. |
Transportation Profile | Master-Detail(Transportation Profile) | The Master-Detail relationship to the parent Transportation Profile record the Rate Entry belongs to. |
Weight Break 1 | Text(100) | Weight Break 1 Description. |
Weight Break 1 Discount | Percent(2, 2) | Weight Break 1 discount percent. |
Weight Break 2 | Text(100) | Weight Break 2 Description. |
Weight Break 2 Discount | Percent(2, 2) | Weight Break 2 discount percent. |
Weight Break 3 | Text(100) | Weight Break 3 Description. |
Weight Break 3 Discount | Percent(2, 2) | Weight Break 3 discount percent. |
Weight Break 4 | Text(100) | Weight Break 4 Description. |
Weight Break 4 Discount | Percent(2, 2) | Weight Break 4 discount percent. |
Weight Break 5 | Text(100) | Weight Break 5 Description. |
Weight Break 5 Discount | Percent(2, 2) | Weight Break 5 discount percent. |
Weight Break 6 | Text(100) | Weight Break 6 Description. |
Weight Break 6 Discount | Percent(2, 2) | Weight Break 6 discount percent. |
Weight Break 7 | Text(100) | Weight Break 7 Description. |
Weight Break 7 Discount | Percent(2, 2) | Weight Break 7 discount percent. |
Weight Break 8 | Text(100) | Weight Break 8 Description. |
Weight Break 8 Discount | Percent(2, 2) | Weight Break 8 discount percent. |
Weight Break 9 | Text(100) | Weight Break 9 Description. |
Weight Break 9 Discount | Percent(2, 2) | Weight Break 9 discount percent. |
Weight Break 10 | Text(100) | Weight Break 10 Description. |
Weight Break 10 Discount | Percent(2, 2) | Weight Break 10 discount percent. |
Weight Break 11 | Text(100) | Weight Break 11 Description. |
Weight Break 11 Discount | Percent(2, 2) | Weight Break 11 discount percent. |
Rate Entry Calculation
This object defines the Base, Minimum, and Maximum calculations for a Rate Entry.
Field Name | Type | Description |
---|---|---|
Amount Field | Text(100) | The load or quote field name to calculate the rate entry cost. |
Calculation Type | Picklist | The selection for the type of rate entry calculation. Values include: “Base,” “Minimum,” and “Maximum.” No default value. |
DIM Factor | Number(5, 6) | The dimensional weight factor for Billable Weight-Based rate entry calculations. |
Distance Override | Number(10, 1) | When using a distance-based rate entry calculation, this field can be used for overriding the load distance for stored rate quoting. |
Equipment Type | Lookup(Equipment Type) | A lookup to the Equipment Type record associated with this rate entry calculation. |
Handling Units | Picklist | The type of Handling Unit related to this rate entry calculation. Values include: “Bales,” “Boxes,” “Cases,” and many others. No default value. |
HU Calculation Method | Picklist | The method used for handling units for rate entry calculations. Values include: “Actual” and “Adjusted by HU Max Weight.” No default value. |
HU Max Weight | Number(16, 2) | The maximum weight per handling unit when performing handling unit-based rate entry calculations. |
Name | Auto Number | The unique record identifier. Example: Rate Entry Calc-{0}. |
NMFC Class | Picklist (Multi-Select) | The NMFC class for this rate entry calculation. No default value. |
Packaging Units | Picklist | The type of Packaging Unit related to this rate entry calculation. Values include: “Bales,” “Boxes,” “Cases,” and many others. No default value. |
Rate Entry | Master-Detail(Rate Entry) | The Master-Detail relationship to the parent Rate Entry record the Rate Entry Calculation belongs to. |
Rate Method | Picklist | The method used for the rate entry calculation. Some values include: “API,” “Manual,” “Per Mile,” “Per Cubic Foot,” “Per Stop,” "Per HU Position," and many others. This field is dependent on the Calculation Type field. No default value. |
Volume Units | Picklist | The unit of measure for volume-based calculations. Values include: “Cubic Feet,” “Cubic Inches,” “Cubic Meters,” “Cubic Centimeters,” “Gallons,” and “Liters.” No default value. |
Weight Units | Picklist | The unit of measure for weight-based calculations. Values include: “lbs,” “kg,” and “cwt.” “Lbs” is the default value. |
Rate Entry Calculation Axis
This object defines costing axes for matrix-based Rate Entry Calculations.
Field Name | Type | Description |
---|---|---|
Axis Type | Picklist | The axis delineation type for rate entry calculations. Some values include: “Distance,” “Weight,” “Linear Feet,” “Handling Unit Count,” and others. No default value. |
Axis Units | Picklist | The axis delineation units. Some values include: “Miles,” “lbs,” “Cubic Feet,” “in,” and others. This field is dependent on the Axis Type field. No default value. |
Dimension | Picklist | The dimension for the rate entry calculation axis. Values include: “X-Axis” and “Y-Axis.” No default value. |
Name | Auto Number | The unique record identifier. Example: Axis-{0}. |
Range Boundary | Picklist | The range boundary for the rate entry calculation axis. Values include: “Include Maximum” and “Include Minimum.” This field is dependent on the Range Type field. No default value. |
Range Type | Picklist | The type of range for the rate entry calculation axis. Values include: “Numeric Range,” “String Range,” and “Values.” This field is dependent on the Axis Type field. No default value. |
Rate Entry Calculation | Master-Detail(Rate Entry Calculation) | The Master-Detail relationship to the parent Rate Entry Calculation record the Rate Entry Calculation Axis belongs to. |
Rate Entry Calculation Axis Value
This object defines the costing axis “hash marks” for matrix-based Rate Entry Calculations.
Field Name | Type | Description |
---|---|---|
Maximum | Number(14, 4) | The maximum value for a numeric range-based hash mark. |
Maximum String | Text(100) | The maximum value for a string range-based hash mark. |
Minimum | Number(14, 4) | The minimum value for a numeric range-based hash mark. |
Minimum String | Text(100) | The minimum value for a string range-based hash mark. |
Name | Auto-Number | The unique record identifier. Example: Axis Value-{0}. |
Order | Number(4, 0) | The mash mark numbered order. |
Rate Entry Calculation | Master-Detail(Rate Entry Calculation) | The Master-Detail relationship to the parent Rate Entry Calculation record the Rate Entry Calculation Axis Value belongs to. |
Rate Entry Calculation Axis | Lookup(Rate Entry Calculation Axis) | A lookup to the Rate Entry Calculation Axis record associated with the Rate Entry Calculation Axis Value. |
Values | Test(255) | The comma-separated list of values the hash mark represents. |
Rate Entry Calculation Cell
This object defines rate cells for matrix-based Rate Entry Calculations.
Field Name | Type | Description |
---|---|---|
Name | Auto Number | The unique record identifier. Example: Cell-{0}. |
Rate Entry Calculation | Master-Detail(Rate Entry Calculation) | The Master-Detail relationship to the parent Rate Entry Calculation record the Rate Entry Calculation Cell belongs to. |
Value | Number(14, 4) | The rate to employ in costing the rate entry. |
X Axis Value | Lookup(Rate Entry Calculation Axis Value) | A lookup to the Rate Entry Calculation Axis Value record associated with the Rate Entry Calculation Cell. The Rate Entry Calculation X Axis Value. |
Y Axis Value | Lookup(Rate Entry Calculation Axis Value) | A lookup to the Rate Entry Calculation Axis record associated with the Rate Entry Calculation Cell. The Rate Entry Calculation Y Axis Value. |
RateIQ Rate Source
This object defines the custom source fields associated with .CSV file upload Rate Entries.
Field Name | Type | Description |
---|---|---|
Data Source | Picklist | The custom source for the data used in RateIQ rate calculations. The Values include: “Custom Source” and none. No default value. |
Destination City | Text(40) | The load’s destination city. |
Destination Country | Text(40) | The load’s destination country. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Destination Geolocation | Geolocation | The load’s destination geolocation. |
Destination Postal Code | Text(20) | The load’s destination postal code. |
Destination State | Picklist | The load’s destination state. This field is dependent on the Destination Country field. No default value. |
Distance | Number(18, 0) | The route distance. |
Distance Units | Picklist | The unit of measure for the route distance. Values include: “Miles” and “Kilometers.” No default value. |
Equipment Category | Picklist | The equipment type for the load. Values include, “Van,” “Flatbed,” “Reefer,” “Specialized,” and “Ocean/Intermodal.” No default value. |
Freight + Fuel | Currency(16, 2) | The combined freight and fuel monetary amount. |
Freight Charge | Currency(16, 2) | The freight charge monetary amount. |
Fuel Surcharge | Currency(16, 2) | The fuel surcharge monetary amount. |
Mode | Master-Detail(Mode) | The Master-Detail relationship to the parent Mode record the RateIQ Rate Source belongs to. |
Name | Auto Number | The unique record identifier. Example: Rate Record-{0}. |
Origin City | Text(40) | The load’s origin city. |
Origin Country | Picklist | The load’s origin country. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Origin Geolocation | Geolocation | The load’s origin geolocation. |
Origin Postal Code | Text(20) | The load’s origin postal code. |
Origin State | Picklist | The load’s origin state. This field is dependent on the Origin Country field. No default value. |
Ship Date | Date | The load’s ship date. |
Rebate Program
This object defines programs for creating rebates on customer loads.
Field Name | Type | Description |
---|---|---|
Description | Text(255) | The description of the rebate program. |
Rebate Program Name | Text(80) | The unique record identifier. |
Rebate Recipient | Lookup(Account) | A lookup to the Account record associated with the rebate program. |
Type | Picklist | The type of rebate program. Values include: “Association” and “Customer Direct.” No default value. |
Rebate Program Entry
This object defines entries for a rebate program.
Field Name | Type | Description |
---|---|---|
Mode | Lookup(Mode) | A lookup to the Mode record associated with the Rebate Program Entry. |
Rebate Percent | Percent(3, 2) | The percentage of the customer quote pre-tax total. |
Rebate Program | Master-Detail(Rebate Program) | The Master-Detail relationship to the parent Rebate Program record the Rebate Program Entry belongs to. |
Rebate Program Entry | Auto Number | The unique record identifier. Example: Rebate-{0}. |
Record Export Definition
This object defines an export record that is part of an export file and will contain fields.
Field Name | Type | Description |
---|---|---|
Field Separator | Text(5) | The value used to separate fields in the export file. |
File Export Definition | Master-Detail(File Export Definition) | The Master-Detail relationship to the parent File Export Definition record the Record Export Definition belongs to. |
Name | Auto Number | The unique record identifier. Example: RED-{000}. |
Record Format | Picklist | The format of the exported record. Values include: “Fixed Length” and “Variable Length.” No default value. |
Record Length | Number(5, 0) | The length of the exported record for Fixed Length record formats. |
Record Type | Picklist | The type of exported record. Values include: “Header,” “Data,” “File Header (NACHA),” “Batch Header (NACHA),” and “Detail (NACHA),” “Batch Control (NACHA),” “File Control.” No default value. |
Sequence Number | Number(2, 0) | The record sequence in the export file. |
Recurring Freight Plan
This object defines freight plans cloned by Recurring Load Schedules.
Field Name | Type | Description |
---|---|---|
Freight Plan | Master-Detail(Freight Plan) | The Master-Detail relationship to the parent Freight Plan record the Recurring Freight Plan belongs to. |
Last Process Date | Date | The date the record was most recently processed by the batch job. |
Last Process Status | Text(255) | The status of the most recent batch job run for this record. |
Name | Auto Number | The unique record identifier. RFP-{0}. |
Recurring Load Schedule | Master-Detail(Recurring Load Schedule) | The Master-Detail relationship to the parent Recurring Load Schedule record the Recurring Freight Plan belongs to. |
Recurring Load
This object defines loads to be cloned by Recurring Load Schedules.
Field Name | Type | Description |
---|---|---|
Last Process Date | Date | The date the record was most recently processed by the batch job. |
Last Process Status | Text(255) | The status of the most recent batch job run for this record. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Recurring Load belongs to. |
Name | Auto Number | The unique record identifier. Example: RL-{0}. |
Recurring Load Schedule | Master-Detail(Recurring Load Schedule) | The Master-Detail relationship to the parent Recurring Load Schedule record the Recurring Load belongs to. |
Recurring Load Schedule
This object defines schedules for the automatic creation of loads.
Field Name | Type | Description |
---|---|---|
Active | Checkbox | If “Checked,” the recurring load schedule is active. |
Assign Carrier to Load | Checkbox | If “Checked,” set load status of cloned loads to “Assigned” and assign a Carrier and Carrier Service. |
Description | Text Area(255) | The description/purpose of the recurring load schedule. |
End Date | Date | The recurring load schedule expiration date. |
Friday Count | Number(5, 0) | The number of loads/plans to be cloned for Friday first pickup. |
Last Process Date | Date | The date the recurring load schedule was most recently processed by the batch job. |
Last Process Status | Text(255) | The status of the most recent batch job run for this recurring load schedule. |
Load Creation Day | Picklist | The day of week to create the cloned loads/plans. Values include: “Monday,” “Tuesday,” “Wednesday,” “Thursday,” “Friday,” “Saturday,” and “Sunday.” No default value. |
Load Creation Frequency | Picklist | How often the loads are cloned for a recurring load schedule. Values include: “Every Week” and “Every Two Weeks.” No default value. |
Monday Count | Number(5, 0) | The number of loads/plans to be cloned for Monday first pickup. |
Name | Text(80) | The unique record identifier. |
Next Process Date | Date | The next date the batch job run for this recurring load schedule. |
Saturday Count | Number(5, 0) | The number of loads/plans to be cloned for Saturday first pickup. |
Start Date | Date | The date when the recurring load schedule is set to active. |
Sunday Count | Number(5, 0) | The number of loads/plans to be cloned for Sunday first pickup. |
Thursday Count | Number(5, 0) | The number of loads/plans to be cloned for Thursday first pickup. |
Tuesday Count | Number(5, 0) | The number of loads/plans to be cloned for Tuesday first pickup. |
Wednesday Count | Number(5, 0) | The number of loads/plans to be cloned for Wednesday first pickup. |
RFP
This object supports management of customer and Carrier RFPs.
Field Name | Type | Description |
---|---|---|
Alternate Contact | Lookup(Contact) | A lookup to the Contact record associated with an alternate customer/Carrier contact for RFP information. |
Award Date | Date | The date the RFP is won/awarded. |
Batch Job Running | Checkbox | An LTL Workbench support field that when “Checked” indicates that the batch job is currently running. |
Carrier Markup Group | Lookup(Carrier Markup Group) | A lookup to the Carrier Markup Group record associated with the RFP. An LTL Workbench support field. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service associated with this RFP. An LTL Workbench support field. |
Company | Lookup(Account) | A lookup to the Account record associated with the company sending/receiving the RFP. |
Description | Text Area(255) | The text details of the RFP. |
Direct/Interline | Picklist | An LTL Workbench support field describing the type of movement of the load. Values include: “Direct,” “Interline,” and “Unspecified.” No default value. |
Estimated Transit Time (Days) | Number(3, 0) | An LTL Workbench support field for the number of days expected to ship a load. |
Export File Name | Text(255) | An LTL Workbench support field that provides the ability to name the export file. If blank, the file will be named with the Customer and RFP name. |
Ignore Carrier Exclusions | Checkbox | An LTL Workbench support field that when “Checked,” allows Carrier exclusions to be ignored for the RFP. |
Issue Date | Date | The date that the RFP was issued. |
Lowest Carrier Quote Only | Checkbox | An LTL Workbench support field that when “Checked,” only allow selection of the lowest Carrier quotes. |
Margin | Percent(6, 2) | An LTL Workbench support field for the percentage of the markup for an RFP. |
Markup | Currency(16, 2) | An LTL Workbench support field for the monetary markup amount for an RFP. |
Markup Strategy | Picklist | An LTL Workbench support field defining the markup for an RFP. Values include: “Markup,” “Margin %,” and “Markup Group.” No default value. |
Primary Contact | Lookup(Contact) | A lookup to the Contact record associated with the primary customer/Carrier contact for RFP information. |
Quote Source | Picklist | An LTL Workbench support field providing the source of the Quote. Values include: “Both,” “API,” and “Stored Rates.” “Both” is the default value. |
Quote/Contract ID | Text(100) | An LTL Workbench support field containing the ID of the Quote/Contract. |
Rate Entry Status | Picklist | An LTL Workbench support field describing the current state of the RFP. Values include: “Both,” “Accepted,” and “Quoted.” “Both” is the default value. |
Response Due Date | Date/Time | The date and time the RFP response is due. |
Response Sent Date | Date/Time | The date and time the RFP response is sent or received. |
RFP Name | Text(80) | The unique record identifier. |
Status | Picklist | The current state of the RFP. Values include: “Pending,” “Received,” “Responded,” or “Closed.” “Pending” is the default value. |
Status Comments | Text Area(255) | Status comment details for the RFP. |
Type | Picklist | The type of RFP. Values include: “Customer” (inbound RFP) and “Carrier” (outbound RFP). “Customer” is the default value. |
RFP Exclusion
This object supports the LTL Workbench when excluding Carriers.
Field Name | Type | Description |
---|---|---|
Exclusion ID | Text(18) | The record ID of the object to exclude. |
RFP | Master-Detail(RFP) | The Master-Detail relationship to the parent RFP record the RFP Exclusion belongs to. |
RFP Exclusion | Auto Number | The unique record identifier. Example: RFPExcl-{000}. |
Type | Picklist | The type of RFP Exclusion. Values include: “Carrier Exclusion.” No default value. |
Sales Tax
This object defines Canadian and Mexican sales tax rates.
Field Name | Type | Description |
---|---|---|
Destination Country | Picklist | The destination ISO country code. Values include: “CA,” “MX,” and “US.” No default value. |
Destination State/Province | Picklist | The destination ISO state/province code. This field is dependent on the Destination Country field. No default value. |
Jurisdiction | Picklist | The taxing jurisdiction – Canada or Mexico. Values include: “Canada” and “Mexico.” No default value. |
Origin Country | Picklist | The origin ISO Country code. Values include: “CA,” “MX,” and “US.” No default value. |
Origin State/Province | Picklist | The origin ISO state/province code. This field is dependent on the Origin Country field. No default value. |
Tax Id Number | Text(50) | The Tax ID that corresponds to this Sales Tax record. |
Tax Name | Text(80) | The unique record identifier. |
Tax Rate | Percent(3,3) | The tax rate as a percentage of the total transportation charges. |
Tax Type | Picklist | The type of sales tax applied. Values include: “GST,” “HST,” “QST,” “VAT,” or “RET.” This field is dependent on the Jurisdiction field. No default value. |
Sales Tax Exclusion
This object defines customer-specific exclusions to certain taxes.
Field Name | Type | Description |
---|---|---|
Account | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Sales Tax Exclusion belongs to. |
Name | Auto Number | The unique record identifier. Example: Exclusion-{0}. |
Sales Tax | Master-Detail(Sales Tax) | The Master-Detail relationship to the parent Sales Tax record the Sales Tax Exclusion belongs to. |
Tax Treatment | Picklist | The selected action to perform for tax. Values include: “Do Not Calculate or Display” and “Display as Zero Amount.” No default value. |
Service Item Master
This Fleet Management object captures reusable service order items.
Field Name | Type | Description |
---|---|---|
Labor Cost | Formula (Currency) | The monetary labor cost for the service item. |
Labor Hours | Number(4, 2) | The number of labor hours required for the service item. |
Labor Rate per Hour | Currency(16, 2) | The monetary rate for labor for the service item. |
Parts Cost | Currency(16, 2) | The monetary cost for parts for the service item. |
Service Item Name | Text(80) | The unique record identifier. |
Total Cost | Formula (Currency) | The total monetary cost of parts and labor for the service item. |
Service Level
This object defines basic service-levels for a Carrier.
Field Name | Type | Description |
---|---|---|
Name | Text(80) | The unique record identifier. |
Service Order
This Fleet Management object captures service orders for fleet assets.
Field Name | Type | Description |
---|---|---|
Category | Picklist | The type of service order. Values include: “Repair” and “Maintenance.” No default value. |
Completion Date | Date | The completion date of the service order. |
Description | Text Area(255) | Description of the service order. |
Fleet Asset | Master-Detail(Fleet Asset) | The Master-Detail relationship to the parent Fleet Asset record the Service Order belongs to. |
Incident | Lookup(Incident) | A lookup to the Incident record associated with the Service Order. |
Inspection Report | Lookup(Inspection Report) | A lookup to the Inspection Report record associated with this Service Order. |
Items Completed | Roll-Up Summary (COUNT Service Order Item) | A rollup count of the number of service order items completed. |
Items On Hold | Roll-Up Summary (COUNT Service Order Item) | A rollup count of the number of service order items on hold. |
Items Pending | Roll-Up Summary (COUNT Service Order Item) | A rollup count of the number of service order items pending. |
Items Started | Roll-Up Summary (COUNT Service Order Item) | A rollup count of the number of service order items started. |
Service Location | Lookup(Account) | A lookup to the Account record associated with the location of servicing. |
Service Manager | Lookup(User) | A lookup to the User record associated that belongs to the service manager. |
Service Order Items | Roll-Up Summary (COUNT Service Order Item) | A rollup count of the total number of service order items. |
Service Order Number | Auto Number | The unique record identifier. Example: Service Order-{0}. |
Service Order Status | Picklist | The current state of the service order. Values include: “Pending,” “Started,” and “Completed.” “Pending” is the default value. |
Service Order Template | Lookup(Service Order Template) | A lookup to the Service Order Template record associated with creating the service order. |
Start Date | Date | The service order start date. |
Total Cost | Roll-Up Summary (SUM Service Order Item) | A rollup of the total service order costs. |
Total Labor Cost | Roll-Up Summary (SUM Service Order Item) | A rollup of the total service order labor costs. |
Total Labor Hours | Roll-Up Summary (SUM Service Order Item) | A rollup of the total service order labor hours. |
Total Parts Cost | Roll-Up Summary (SUM Service Order Item) | A rollup of the total service order parts costs. |
Service Order Item
This Fleet Management object captures service order line items for assets.
Field Name | Type | Description |
---|---|---|
Comments | Text Area(255) | Comments for the service order item. |
Completion Date | Date | The completion date for the service order item. |
Labor Cost | Formula (Currency) | The monetary labor cost for the service order item. |
Labor Hours | Number(4, 2) | The number of labor hours for the service order item. |
Labor Rate per Hour | Currency(16, 2) | The monetary rate for labor for the service order item. |
Order | Number(4, 0) | The position number in the list of service order items under the parent record. |
Parts Cost | Currency(16, 2) | The monetary parts cost for the service order item. |
Service Item Master | Lookup(Service Item Master) | A lookup to the Service Item Master record the service order item was cloned from. |
Service Order | Master-Detail(Service Order) | The Master-Detail relationship to the parent Service Order record the Service Order Item belongs to. |
Service Order Item | Text(80) | The unique record identifier. |
Service Technician | Lookup(User) | A lookup to the User record associated with the service technician. |
Start Date | Date | The service order item start date. |
Status | Picklist | The current state of the service order item. Values include: “Pending,” “On Hold,” “Started,” and “Completed.” “Pending” is the default value. |
Total Cost | Formula (Currency) | The total monetary cost of labor and parts for the service order item. |
Service Order Template
This Fleet Management object captures reusable service order templates.
Field Name | Type | Description |
---|---|---|
Category | Picklist | The type of service order template. Values include: “Repair” and “Maintenance.” No default value. |
Description | Text Area(255) | Description of the service order template. |
Template Name | Text(80) | The unique record identifier. |
Service Order Template Item
This Fleet Management object captures reusable service order template line items.
Field Name | Type | Description |
---|---|---|
Order | Number(4, 0) | The position of the service item in the parent service order template list of children. |
Service Item Master | Master-Detail(Service Item Master) | The Master-Detail relationship to the parent Service Item Master record the Service Order Template Item belongs to and was cloned from. |
Service Order Template | Master-Detail(Service Order Template) | The Master-Detail relationship to the parent Service Order Template record the Service Order Template Item belongs to. |
Template Item ID | Auto Number | The unique record identifier. Example: Template Item-{0}. |
Service Route
This object defines service routes for Ocean FCL carriers.
Field Name | Type | Description |
---|---|---|
Carrier Service | Master-Detail(Carrier Service) | The Master-Detail relationship to the parent Carrier Service record the Service Route belongs to. |
Name | Text(80) | The unique record identifier. |
Stop
This object defines every origin/destination, pickup, and drop-off stop for loads. Every load has two or more stops associated with it.
Field Name | Type | Description |
---|---|---|
Address | Formula (Text) | The complete address of the stop (concatenation formula field). |
Appointment Required | Checkbox | If, “Checked” the Carrier must make an appointment at this stop location. |
Appointment Time | Text(11) | The Carrier’s appointment time for the pickup/drop-off at this stop. Validation Rule: Field must be 24-hour time (HH:MM) or time period (HH:MM-HH:MM). |
Arrival Date | Date | The date the Carrier arrives at the stop. |
Arrival Status | Formula (Text) | Calculated based on the Arrival Date and the Expected Date and returns, “Early,” “On Time,” or “Late.” |
Arrival Time | Text(5) | The 24-hour time the Carrier arrives at the stop. Validation Rule: Field must be 24-hour time (HH:MM). |
Carrier ETA Date | Date | The Carrier-predicted arrival date at the stop. |
Carrier ETA Time | Text(5) | The Carrier-predicted 24-hour arrival time at the stop. Validation Rule: Field must be 24-hour time (HH:MM). |
Carrier Status | Picklist | High-level description of conditions at the stop. Values include: “No Issues,” “Delayed by Weather,” “Delayed by Traffic,” “Delayed by Equipment Breakdown,” “Checked In,” “Loading,” “Unloading,” “In Detention,” “Loaded Clean,” “Loaded with Issues,” “Unloaded Clean,” “Unloaded with Issues,” and “Other (see comments).” No default value. |
Carrier Status as of | Date/Time | The date and time the Carrier provided a status update. |
Carrier Status Comments | Text(255) | Carrier status comments regarding issues at the stop. |
Carrier Status Reason | Picklist | EDI 214 status reason codes. Note: Do NOT change this list of reasons as they are based on the EDI 214 specification. |
City | Text(40) | The stop city (if no Location populated). |
City Index | Text(100) (External ID) | The indexed City-State Lane for the LaneIQ LWC. |
Country | Picklist | The stop country code (if no Location populated). |
Country Index | Text(40) (External ID) | The indexed Country Lane for the LaneIQ LWC. |
Cumulative Miles | Number(10, 3) | The distance in miles to arrive at this stop via the route. |
Departure Date | Date | The date the Carrier departs the stop. |
Departure Time | Text(5) | The 24-hour time the Carrier departs the stop. Validation Rule: Field must be 24-hour time (HH:MM). |
EDI Provider | Formula (Text) | Name of the integration providing the stop information. “Kleinschmidt” or “Cleo” are the two possible values. |
Expected Date | Date | The date the Carrier is expected to arrive at the stop. |
Expected Day | Formula (Text) | The Expected Date day of the week name. |
Geolocation | Geolocation | The latitude and longitude coordinates for a stop. Typically these stops are not associated with an account. |
Instructions | Long Text Area(2000) | Free-form Carrier instructions. |
Is Dropoff | Checkbox | If “Checked,” this is a stop where a load is unloaded. |
Is Geolocation | Checkbox | If “Checked,” the latitude and longitude stop location information is provided. |
Is Pickup | Checkbox | If “Checked,” this is a stop that a load is loaded. |
Kilometers Away | Number(10, 3) | The current distance between the driver’s location and the stop location in kilometers. |
Last Route Update | Date/Time | A value that is set whenever the location or date/time of a stop appointment changes. |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Stop belongs to. |
Loading/Unloading Complete Date | Date | The date when the loading/unloading is completed at the stop. Usually occurs after the arrival and before the departure. |
Loading/Unloading Complete Time | Text(5) | The time when the loading/unloading is completed at the stop. Usually occurs after the arrival and before the departure. Validation Rule: Field must be 24-hour time (HH:MM). |
Location | Lookup(Account) | A lookup to the Account record associated with the stop’s location. |
Location Name | Formula (Text) | The account name of the location. |
Miles Away | Number(10, 3) | The current distance between the driver’s location and the stop location in miles. |
Number | Number(3, 0) | The number of the stop in the route. |
OTD Counter | Formula (Number) | Counter to track the arrival times at stops. “1” if the Carrier is early or on time. “0” otherwise. |
P/D | Formula (Text) | Formula field indicating whether a stop is for a “Pickup” or “Delivery.” |
P/D Status | Text(255) | This field stores the result of the Pickup/Delivery Status calculation using the Grace fields on the Location TP. This field is used by the Arrival Status field. |
P/DAS | Formula (Text) | Internal formula field supporting on time calculations. |
Pickup/Delivery Number | Text(200) | The customer pickup/delivery number. |
Pickup/Delivery Status | Text Area(255) | The Carrier status summary information for a stop. |
Postal Code | Text(20) | The stop postal code (if no Location populated). |
Postal Code Index | Text(60) (External ID) | The indexed Postal Code Lane for the LaneIQ LWC. |
References | Text(255) | Stop-level reference numbers and IDs. |
Shipping/Receiving Contact | Lookup(Contact) | A lookup to the Contact record associated with the shipping/receiving contact for the stop location. |
Shipping/Receiving Hours | Text(11) | The stop location hours of operation. Validation Rule: Field must be 24-hour time (HH:MM) or time period (HH:MM-HH:MM). |
State Index | Text(40) (External ID) | The indexed State Lane for the LaneIQ LWC. |
State/Province | Picklist | The stop state/province (if no Location populated). |
Stop | Text(80) | The auto-generated stop name for a load. |
Stop Status | Picklist | The status of a load in relation to a stop. Values include: “En Route,” “Arrived,” and “Departed.” This field is dependent on the Carrier Status field. No default value. |
Terminal Email | Returned by SMC3 for Carrier Quotes and set here on assignment. | |
Terminal Location | Text Area(255) | Returned by SMC3 for Carrier Quotes and set here on assignment. |
Terminal Phone | Phone | Returned by SMC3 for Carrier Quotes and set here on assignment. |
Timezone | Picklist | The time zone for a stop when the Location is null. No default value. |
Tracking Provider (Customer) | Formula (Text) | The provider currently tracking the load for a customer. |
TMS Document
This reference object contains the names of all documents produced by the TMS in the life of a load.
Field Name | Type | Description |
---|---|---|
Name | Text(80) | The unique record identifier. |
TMS Document Field
This object contains additional fields added by users to TMS documents.
Field Name | Type | Description |
---|---|---|
Document Options | Master-Detail(Document Options) | The Master-Detail relationship to the parent Document Options record the TMS Document Field belongs to. |
Field Name | Text(50) | The API field name to add to the document. |
Name | Auto Number | The unique record identifier. Example: Field-{0}. |
Order | Number(4, 0) | The order of the added field on the document. |
Table | Text(50) | The API object name the field comes from. The current choices are “Load,” “Stop,” and “Line Item.” |
TMS Document | Master-Detail(TMS Document) | The Master-Detail relationship to the parent TMS Document record the TMS Document Field belongs to. |
TMS Document Options
This object contains configurations specific to a document options record and document type combination (such as the Global Document Options record and the BOL .pdf document).
Field Name | Type | Description |
---|---|---|
Custom Header Page Name | Text(50) | The API Name of the Visualforce page that overrides the current document header page. Currently only used for CustomerInvoiceBatch. |
Custom Page Name | Text(50) | The API Name of the Visualforce page that overrides the current default document. |
Document Options | Master-Detail(Document Options) | The Master-Detail relationship to the parent Document Options record the TMS Document Options belongs to. |
Logo Id | Text(18) | The document-specific ID for a logo override file attachment. |
Name | Auto Number | The unique record identifier. Example: Option-{0}. |
Suppress Expected Delivery Date | Checkbox | For LTL loads, if “Checked,” the expected delivery date from the (.pdf) document will be suppressed as well as the delivery receiving hours. |
Suppress Logo | Checkbox | If “Checked,” the logo from the (.pdf) document will be suppressed. |
TMS Document | Master-Detail(TMS Document) | The Master-Detail relationship to the parent TMS Document record the TMS Document Options belongs to. |
TMS Document Override
This object supports the override of the text fields/areas on the Ocean BOL.
Field Name | Type | Description |
---|---|---|
Name | Text(80) | The unique record identifier. Example: Override-{0}. |
Override Text | Long Text Area(1000) | Text replacement in the document. |
Parent Id | Text(18) (External ID) | The parent record (often a load) that this document refers to. |
Target Field | Text(50) | The field name that is replaced in the document. |
TMS Document | Master-Detail(TMS Document) | The Master-Detail relationship to the parent TMS Document record the TMS Document Override belongs to. |
Transportation Profile
This object provides account-level, transportation-specific fields. There are six record types for this object:
Carrier (Air) | Carrier (Ocean) | Shipper/Consignee |
Carrier (Ground) | Carrier (Rail) | Broker/3PL |
Fields designated in green are usually (but not always) used by Carrier record types.
Field Name | Type | Description |
---|---|---|
A/R Current | Currency(16, 2) | The monetary amount of the current accounts receivable balance. |
A/R Past Due | Currency(16, 2) | The monetary amount of the past due accounts receivable balance. |
A/R Unbilled | Currency(16, 2) | The monetary amount of any pending customer invoices and accepted customer quotes without corresponding invoices. |
Agreement Date | Date | The date when the Carrier agreed to the terms and conditions and signed the agreement. |
Agreement Signed By | Lookup(Contact) | A lookup to the Contact record that signed the agreement. |
Agreement Status | Picklist | The current state of the agreement with a Carrier. Values include: “Pending,” “Requested,” “Received,” and “Verified.” No default value. |
Allow Booking from Load Postings | Picklist (Multi-Select) | This field is used to add a Carrier to a load board via the selected API. Values include: “Truckstop 2” and “Trucker Tools Load Board.” No default value. |
Appointment Time Grace Period (After) | Number(3, 0) | The number of minutes a Carrier can arrive after an appointment time and still be considered On Time. |
Appointment Time Grace Period (Before) | Number(3, 0) | The number of minutes a Carrier can arrive before an appointment time and still be considered On Time. |
Authority Granted Date | Date | The date the Carrier authority was granted. |
Authority Risk | Picklist | The SaferWatch/MyCarrierPackets authority risk measure. Values include: “Pending,” “Acceptable,” “Moderate,” “Unacceptable,” “Unacceptable Review,” and “Unacceptable Fail.” “Pending” is the default value. |
Authority Risk Points | Number(6, 0) | The MyCarrierPackets authority risk score point number. |
Auto-Apply Accessorial Rating Source | Picklist | Selection of quotes to apply the accessorial. Values include: "Customer Rates Only," and "Customer + Global Rates." No default value. |
Auto-Send Invoices | Checkbox | If “Checked,” approved customer invoices are automatically sent by the CustomerInvoiceGenerationJob batch job on the Invoice date. |
Barcode Height | Number(7, 3) | The height of the barcode measured in pixels to the left of the decimal and thousands of an inch to the right of the decimal. |
Barcode Type | Picklist | The barcode type selection. Values include: “Code 39” and “Code 128.” No default value. |
Barcode Units | Picklist | The unit type selection for barcodes. Values include: “Inches” and “Pixels.” No default value. |
Barcode Width | Number(7, 3) | The width of the barcode measured in pixels to the left of the decimal and thousands of an inch to the right of the decimal. |
Batch Invoicing Email Process | Picklist | This field determines how invoices are batched and sent via email. Values include: “One Email, Combined Invoice Attachment,” “One Email, Individual Invoice Attachments,” and “Multiple Emails, Individual Invoice Attachments.” This field is dependent on the Batch Invoicing POD Treatment field. “One Email, Combined Invoice Attachment” is the default value. |
Batch Invoicing POD Treatment | Picklist | How to handle POD attachments to a load when individually and batch-generating customer invoices. Values include: “Include as Attachment” and “Include in Invoice Attachment.” No default value. |
Billing Email Attachment Format | Picklist | The field for selecting the attachment file type for customer billing via email. Values include: “PDF” and “PDF with .csv.” “PDF” is the default value. Validation Rule: This field requires a Customer Invoice Export File to use. |
Billing Method | Picklist | The field for selecting a billing method for a customer. Values include: “Email,” “EDI,” and “Print.” “Email” is the default value. |
Blue Yonder ID | Text(255) | The ID number for Blue Yonder customers, shippers, and consignees. |
Breakthrough Fuel Shipper Id | Text(50) | The Breakthrough Fuel customer identifier field. |
Broker Authority Pending | Picklist | Selection for whether a broker authority is pending. Values include: “Yes” or “No.” No default value. |
Broker Authority Revocation | Picklist | Selection if a broker authority has been revoked. Values include: “Yes” or “No.” No default value. |
Broker Authority Status | Picklist | The state of the broker authority. Values include: “Active,” “Inactive,” and “None.” No default value. |
CAAT | Text(40) | Mexico Carrier identifier. |
Canada Province Coverage | Picklist (Multi-Select) | Canadian provinces served by the Carrier. No default value. |
CARB-TRU Certificate Expiration Date | Date | The date when the CARB-TRU Certification expires. Field received from RMIS. |
CARB-TRU Compliance Type | Text(100) | The specific CARB-TRU Compliance Type and is received from RMIS. |
CARB-TRU Compliant Vehicles Reported | Number(7, 0) | The number of CARB-TRU Compliant Vehicles and is received from RMIS. |
CARB-TRU Non-Compliant Reason | Long Text Area(8000) | The description field of the CARB-TRU Non-Compliant Reason received from RMIS. |
Cargo Carried | Picklist (Multi-Select) | The cargo type carried by the Carrier. No default value. |
Cargo Insurance Option | Picklist | Selection field for cargo insurance. Values include: “Hide,” “Opt In,” and “Opt Out.” No default value. |
Carrier API Login Group | Text(40) | The Login Group Key for customer-specific Carrier pricing via Banyan or Project44. |
Carrier Comments | Text Area(255) | Information received from the Carrier from their application. This information includes comments on their FMCSA data. |
Carrier Engagement Automation | Picklist (Multi-Select) | Functions that can automatically occur for the Carrier. Values include: “Auto-Tender” and “Auto-Post.” No default value. |
Carrier Markup Group | Lookup(Carrier Markup Group) | The set of Carrier Markup records to use for this customer. |
Carrier Operation | Picklist (Multi-Select) | The type of Carrier operations. Values include: “Interstate,” “Intrastate,” “Intrastate HazMat,” and “None.” No default value. |
Carrier Pay To Name | Text(255) | The name of the Factor Company in RMIS. |
Carrier Payment Terms | Lookup(Payment Terms) | A lookup to the Payment Terms record associated with the Carrier. |
Carrier Remit To | Lookup(Account) | A lookup to the Account record associated with remitting to the Carrier itself or to a Factor Company. |
Carrier Remit To Admin Job Id | Text(18) | This internal field is an ID of the batch job updating the Carrier Remit To field.
|
Carrier Remit To As Of | Date/Time | The date and time when the Carrier Remit To changed. |
Carrier Review Comments | Long Text Area(2000) | Analyst comments regarding the Carrier during the review process. |
Carrier Review Status | Picklist | The current state of a Carrier regarding carrying loads. Values include: “Incomplete Application,” “Pending,” “Approved,” “Rejected,” and “Updated (FMCSA).” “Incomplete Application” is the default value. |
Commodity Catalogue | Lookup(Commodity Cagalogue) | A lookup to the Commodity Catalogue record for line-item entry. |
Common Authority Pending | Picklist | The field indicates whether a common authority is pending. Values include: “Yes” and “No.” No default value. |
Common Authority Revocation | Picklist | The field indicates whether a common authority has been revoked. Values include: “Yes” and “No.” No default value. |
Common Authority Status | Picklist | The field indicates the state of the common authority. Values include: “Active,” “Inactive,” and “None.” No default value. |
Company Logo | Rich Text Area(31000) | The company logo used in the CustomerShipmentTracking LWC. |
Company Risk | Picklist | The state of the overall company credit risk. Values include: “Pending,” “Acceptable,” “Moderate,” and “Unacceptable.” “Pending” is the default value. |
Company Type | Picklist | The company legal organization type. Values include: “Corporation,” “C Corporation,” “S Corporation,” “Limited Liability Company,” “Partnership,” “Individual/Sole Proprietor/Single-Member LLC,” and “Other.” No default value. |
Consolidated Invoicing | Checkbox | If “Checked,” the Master Invoice Number is displayed on invoice documents. |
Contract Authority Pending | Picklist | The field indicates whether a contract authority is pending. Values include: “Yes” and “No.” No default value. |
Contract Authority Revocation | Picklist | The field indicates whether a contract authority has been revoked. Values include: “Yes” and “No.” No default value. |
Contract Authority Status | Picklist | The field indicates the state of the contract authority. Values include: “Active,” “Inactive,” and “None.” No default value. |
Credit Limit | Lookup(Credit Limit) | A lookup to the Credit Limit record associated with the shared credit limit record. |
Credit Limit Amount | Currency(16, 2) | The maximum monetary amount of credit extended to this customer. |
Credit Limit Available | Formula (Currency) | The calculated monetary amount of remaining credit by taking: [Credit Limit + Unapplied Cash/Credit Memos] - [the three A/R balances]. |
Credit Limit Calculation Error | Text(255) | An automatically populated error message, should one occur, when the AR Calculation is performed. |
Credit Limit Utilized | Formula (Percent) | The percent of the credit limit that is used. |
Credit Rating | Picklist | The credit score for the account(s) related to this record. Values include: “A,” “B,” “C,” and “F.” No default value. |
Credit Review Comments | Text Area(255) | Comments related to the credit review. |
Credit Review Date | Date | The date of the credit review. |
Credit Review Status | Picklist | The state of the credit review of a customer. Values include: “Pending,” “Approved,” “Credit Hold,” and “Denied.” “Pending” is the default value. |
Customer Invoice Day | Picklist | Values include: “--None--,” “Monday,” “Tuesday,” “Wednesday,” “Thursday,” “Friday,” “Saturday,” and “Sunday.” TMS Accounting only. When the field is blank, invoices are sent daily. No default value. |
Customer Invoice Export File | Lookup(File Export Definition) | A lookup to the File Export Definition .csv) record associated with the customer. TMS Accounting only. Validation Rule: The “Customer Invoice Export File” is required with the “Billing Email Attachment Format” is “PDF with .csv.” |
D&B DUNS Number | Text(9) | The D&B DUNS Number business identifier received from MyCarrierPackets. |
Default Customer Bill To | Lookup(Account) | A lookup to the Account record associated with the default customer bill to account. |
Default Delivery Instructions | Long Text Area(2000) | The default delivery instructions for load stops whose location (account record) refers to this transportation profile record. |
Default Delivery Range | Number(4, 0) | The distance a Carrier will travel to deliver a load. |
Default Pickup Instructions | Long Text Area(2000) | The default pickup instructions for load stops whose location (account record) refers to this transportation profile record. |
Default Pickup Range | Number(4, 0) | The distance a Carrier will travel to pick up a load. |
Delivery Appointment Required | Checkbox | If “Checked,” a load stop whose location (account record) refers to this transportation profile record requires an appointment for delivery. |
Distance Units | Picklist | Units of distance for pickup and delivery ranges for Truck Postings. Values include: “Miles” and “Kilometers.” “Miles” is the default value. |
DOT State Authority | Picklist | The state authority for the DOT Number. No default value. |
Driver Info Available | Checkbox | “Checked” indicates that a driver can communicate the status of a load. |
EPayment Authorized | Picklist | This field enables/disables the ability to issue EPayments. Values include: “Comdata Comchek” and “EFS Money Code.” No default value. |
Exclude Carrier Pricing | Checkbox | “Checked” will exclude Carrier Quote totals from the Sales History and RateIQ tool results. |
Federal Tax Id | Text (Encrypted)(11) | The Federal Tax ID or SSN. |
Fleet Size | Number(18, 0) | The size of the fleet available to handle loads. |
FMCSA Insurance Cancellation Date | Date | The FMCSA Insurance Cancellation date retrieved from SaferWatch. |
FMCSA Insurance Cancellation Type | Text(20) | The FMCSA Insurance Cancellation insurance type retrieved from SaferWatch. |
Image Resolution | Number(4, 0) | The DPI of the image. |
Insurance Risk | Picklist | The SaferWatch/MyCarrierPackets insurance risk measure. Values include: “Pending,” “Acceptable,” “Moderate,” “Unacceptable,” “Unacceptable Review,” and “Unacceptable Fail.” “Pending” is the default value. |
Insurance Risk Points | Number(6, 0) | The MyCarrierPackets insurance risk score point number. |
Internal Cargo Insurance Mode | Multi-Select Picklist | The Mode type selection(s) for cargo insurance automation. Values include, "Truckload," "LTL," "Intermodal," etc. Default value is null. |
Internal Cargo Insurance Option | Picklist | Automation selection for cargo insurance. Values include: "Opt In" and "Opt Out." Default value is null. |
Internal Notes | Long Text Area(2000) | Notes available for internal viewing only about the account/location. |
Invoice Terms | Number(4, 0) | The number of days between the Customer Invoice Date and the Customer Invoice Due Date. |
Language | Picklist | The language used on generated document. Values include: “English,” “French,” “German,” “Italian,” and “Spanish.” “English” is the default selection. |
Last Carrier Review Date | Date/Time | The most recent date and time that a Carrier’s Review Status was checked. Set every time the SaferWatch/RMIS data is pulled and updated on the TP via the batch process or manually by the user. |
Last Carrier Review Status | Text(40) | This Read-Only field displays the most recent Carrier Review Status. |
Location Hours Grace Period (After) | Number(3, 0) | The number of hours a Carrier can arrive after the shipping/receiving hours and still be considered On Time. Note: if an appointment time is scheduled, the Appointment Time Grace Period (After) field is used to calculate On Time. |
Location Hours Grace Period (Before) | Number(3, 0) | The number of hours a Carrier can arrive before the shipping/receiving hours and still be considered On Time. Note: if an appointment time is scheduled, the Appointment Time Grace Period (Before) field is used to calculate On Time. |
Location Update Send Frequency | Picklist | How often an EDI 214 X6 location updates to the customer. Values include: “15 minutes,” “30 minutes,” “1 hour,” “2 hours,” “4 hours,” “12 hours,” and “24 hours.” No default value. |
LTL Quote Refresh | Number(18, 0) | The Number of minutes before LTL quotes expire in the Customer Portal. |
Manually Regenerate Barcode | Checkbox | If “Checked,” barcodes must be manually regenerated for the Carrier. |
Mask Load Board Booking Requests | Checkbox | If “Checked,” the stop location names are hidden on the load boards (Truckstop only). |
MC/MX/FF Number | Text(20) | The Carrier identifier. |
Mexico State Authority | Picklist | The Mexican state authority for the Carrier. |
Mexico State Coverage | Picklist (Multi-Select) | The Mexican states served by the Carrier. |
Mexico Tax ID | Text (Enctrypted)(20) | Mexican federal tax Id. |
Mileage API | Picklist | Selection for where to obtain routing data. Values include: “PC Miler” and “Rand McNally.” No default value. |
Mileage API Routing | Picklist | Selection for the type of route. Values include: “Practical” and “Shortest.” No default value. |
Mileage API Version | Picklist | Customer-specific version of the API mileage data to use. This field is dependent on the Mileage API field. |
Monitor Carrier | Checkbox | If “Checked,” the Carrier is monitored daily for changes in FMCSA data via SaferWatch. |
Name | Text(80) | The unique record identifier and is usually identical to the associated account record name. |
NSC Number | Text(40) (External ID) | The Canadian National Safety Code number. |
NSC Safety Certificate Date | Date | The effective date of a Canadian NSC safety certification. |
Number of Drivers | Number(18, 0) | The number of drivers available to handle loads. |
Operation Risk | Picklist | The SaferWatch/MyCarrierPackets operation risk measure. Values include: “Pending,” “Acceptable,” “Moderate,” “Unacceptable,” “Unacceptable Review,” and “Unacceptable Fail.” “Pending” is the default value. |
Operation Risk Points | Number(6, 0) | The MyCarrierPackets operation risk score point number. |
Other Carrier Capabilities | Picklist (Multi-Select) | Capabilities of the Carrier such as, “Bonded (US),” “CARB-TRU Compliant (California),” “C-TPAT Certified (US),” “HazMat Certified (US),” and “TSA Certification.” No default value. |
Out of Service | Picklist | Selection for whether a Carrier is in service. Values include: “Yes” and “No.” No default value. |
Out of Service Date | Date | The date the Carrier was designated as out of service. |
Overall Risk | Picklist | The SaferWatch/MyCarrierPackets overall risk measure. Values include: “Pending,” “Acceptable,” “Moderate,” “Unacceptable,” “Unacceptable Review,” and “Unacceptable Fail.” “Pending” is the default value. |
Overall Risk Points | Number(6, 0) | The MyCarrierPackets overall risk score point number. |
Payment Processor | Picklist | The settlement choice for processing payments. Values include: “Accounting” and “TriumphPay.” “Accounting” is the default value. |
Payment Terms | Picklist | The default payment terms for a customer. Values include: “Prepaid,” “Collect,” and “Third Party.” No default value. |
Pickup Appointment Required | Checkbox | “Checked” is the default value for load stops whose location (account record) refers to this transportation profile record. |
POD Required | Checkbox | If “Checked,” the POD is required to invoice this customer. |
Portal Quote HU Count Threshold | Number(18, 0) | The HU count threshold for loads created in the customer Portal. |
Portal Quote Weight Threshold | Number(18, 0) | The weight threshold for loads created in the customer Portal. |
Provincial Authority | Picklist | The Canadian province that authorized the Carrier. No default value. |
Provincial Permit Number | Text(40) (External ID) | The Canadian provincial permit number. |
Rating Source | Picklist | When auto-creating Quotes and rating choose from the following sources. Values include: “Customer Rates Only” or “Customer + Global Rates.” No default value. |
Rebate Program | Lookup(Rebate Program) | A lookup to the Rebate Program record associated with generating rebates on the customer’s load. |
Receiving Hours | Text(11) | The default value for load stops whose location (account record) refers to this transportation profile record. Validation Rule: Field must be 24-hour time (HH:MM) or time period (HH:MM-HH:MM). |
Remit To Option | Picklist | Selection to choose between remitting payment of an invoice to the Carrier or to a Factoring company. Values include: “Direct” and “Factor.” No default value. |
Remove Special Characters | Checkbox | If “Checked,” remove special characters from the PRO # in the barcode. |
Reseller Markup Group | Lookup(Carrier Markup Group) | A lookup to the Carrier Markup Group record associated with determining the reseller markup on the portal. |
RMIS Carrier Payment Option | Text(255) | If collected in the RMIS onboarding process, the payment terms selected by the Carrier will appear here (informational only). |
RMIS Certified | Picklist | The RMIS certification status of a Carrier. Values Include: “Yes” and “No.” No default value. |
RMIS ID | Text(40) (External ID) | The RMIS unique Carrier identifier. |
RMIS Non-Certified Reason | Text Area(255) | A description of why the Carrier failed the RMIS certification rules. |
Safety Rating | Picklist | The FMCSA safety rating. Values include: “Not Rated,” “Satisfactory,” “Unsatisfactory,” and “Conditional.” No default value. |
Safety Rating Date | Date | The date of the FMCSA safety rating. |
Safety Risk | Picklist | The SaferWatch/MyCarrierPackets safety risk measure. Values include: “Pending,” “Acceptable,” “Moderate,” “Unacceptable,” “Unacceptable Review,” and “Unacceptable Fail.” “Pending” is the default value. |
Safety Risk Points | Number(6, 0) | The MyCarrierPackets safety risk score. |
SCAC | Text(4) | The Standard Carrier Alpha Code Identifier. |
Shipping Hours | Text(11) | The default value for load stops whose location (account record) refers to this transportation profile record. Validation Rule: Field must be 24-hour time (HH:MM) or time period (HH:MM-HH:MM). |
Show Text | Checkbox | If “Checked,” the barcode will show the readable PRO #. |
State DOT Number | Text(20) | The state Department of Transportation number. |
Tax Exempt | Checkbox | If “Checked,” sales taxes should NOT be calculated for this customer. |
Temporary Approval Expiration | Date | Compliance rules that auto-reject the Carrier will not execute until this date. |
Tender Documents | Picklist (Multi-Select) | Documents emailed to the Carrier during load tendering. Values include: “Bill of Lading” and “Carrier Rate and Load Confirmation.” No default value. |
Text Align | Picklist | The alignment for the text associated with the barcode. Values include: “Left,” “Center,” and “Right.” No default value. |
Text Color | Text(6) | The color as represented in RBG Hex code for the text associated with the bar code. |
Text Distance | Number(7, 3) | The space between the barcode and the associated text based on the Barcode Units unit of measure. Left of the decimal is measured in pixels and numbers to the right of the decimal are thousandths of an inch. |
Text Font | Text(40) | The font for the text associated with the bar code. |
Text Position | Picklist | The position of text associated with the bar code. Values include: “Top” and “Bottom.” No default value. |
Total Power Units | Number(18, 0) | Data provided by the FMCSA for the number of total power units. |
Total US Vehicle Inspections | Number(18, 0) | Data provided by the FMCSA for the number of vehicle inspections. |
Tracking Customer Id | Text(20) | MacroPoint customer number for shared load status tracking with that customer. |
Tracking Notes | Text Area(255) | Notes sent when tracking a load. |
Tracking Provider | Picklist | The default tracking provider in the Load Tracking Admin modal. Values include: "FourKites," "MacroPoint," "Project44," and "Trucker Tools." |
Tracking Update Email List | Text Area(255) | Comma separated list of email addresses to receive tracking notifications. MacroPoint only. |
Unapplied Cash/Credit Memos | Currency(16, 2) | Field that contains any cash or credit memo balances for customer not yet allocated to an invoice. |
Upload Complete | Picklist (Multi-Select) | The list of load boards the Carrier has been added to via API. Values include: “Truckstop 2” and “Trucker Tools Load Board.” No default value. |
US DOT Number | Text(10) | The US DOT number of the Carrier. |
US State Coverage | Picklist (Multi-Select) | The US states served by the Carrier. |
Vendor Invoice Processor | Picklist | Selection for which service processes Vendor Invoices. “HubTran” can be selected, or none. |
W9 Address | Text Area(255) | Street address returned by RMIS or MCP on the W9 form. |
W9 City | Text(40) | City returned by RMIS on the W9 form. |
W9 Postal Code | Text(20) | Postal Code returned by RMIS on the W9 form. |
W9 State | Picklist | State returned by RMIS on the W9 form. No default value. |
W9 Validated | Checkbox | If “Checked,” RMIS has validated the W9 information. |
Watchdog Reports | Picklist | SaferWatch-provided Carrier field. Values include: “Yes” and “No.” No default value. |
Weight Units | Picklist | Weight units of the Portal Quote Weight Threshold field. Values include: “lbs” and “kg.” No default value. |
White Space Border | Text(20) | The white space surrounding the bar code. |
Transportation Profile Accessorial (OBSOLETE)
This object contains pre-negotiated customer accessorial charges.
Field Name | Type | Description |
---|---|---|
Accessorial | Master-Detail(Accessorial) | References the generic accessorial record. |
Charge | Currency(16, 2) | The negotiated charge for this accessorial. |
Charge Type | Picklist | Type of charge, such as Fixed Cost or Per Mile. |
Name | Text(80) | Accessorial name/description. |
Stop | Picklist | The stop number to apply a stop charge to. |
Stop Count Threshold | Picklist | The number of load stops that triggers application of stop charges. |
Transportation Profile | Master-Detail(Transportation Profile) | The parent transportation profile (and accounts). |
Truck Posting
This object contains load board and internal postings for available trucks.
Field Name | Type | Description |
---|---|---|
Age (Hours) | Formula (Number) | The elapsed time of the Posting in hours. |
Age (Minutes) | Formula (Number) | The elapsed time of the Posting in minutes. |
Carrier Country | Picklist | The country a Carrier is located in. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Carrier Name | Text(60) | The name of the Carrier that operates the truck. |
Carrier Service | Lookup(Carrier Service) | A lookup to the Carrier Service record associated with the truck posting. |
Carrier State | Picklist | The state a Carrier is located in. Many values are available. No default value. This field is dependent on the Carrier Country field. |
Comments | Text Area(255) | Comments related to the posting from the Carrier. |
Contact Email | The email address of the Carrier contact. | |
Contact Extension | Text(10) | The phone extension of the Carrier contact. |
Contact Name | Text(40) | The name of the Carrier contact. |
Contact Phone | Phone | The phone number of the Carrier contact. |
Date Available | Date | The date a truck is available. |
Date Entered | Date/Time | The date and time a posting was entered. |
Day Available | Picklist | The day of the week a truck is available for repeating postings. Values include: “Sunday,” “Monday,” “Tuesday,” “Wednesday,” “Thursday,” “Friday,” and “Saturday.” No default value. |
Delivery Range (Miles) | Number(10, 0) | The distance from the delivery location that a Carrier is looking for loads. |
Desired Rate per Mile | Currency(6, 2) | The minimum rate the Carrier is looking for. |
Destination | Formula (Text) | The city/state/country of a truck destination. |
Destination City | Text(40) | The truck destination city. |
Destination Country | Picklist | The truck destination country. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Destination Geolocation | Geolocation | The truck destination latitude and longitude. |
Destination State | Picklist | The truck destination state. Many values present. No default value. This field is dependent on the Destination Country field. |
DOT Number | Text(10) | The Carrier Department of Transportation Number |
Equipment Description | Text(100) | A description of the truck equipment available. |
Equipment Options | Text(200) | A description of the truck equipment options. |
Equipment Type | Lookup(Equipment Type) | A lookup to the Equipment Type record associated with the Truck Posting. |
Full/Partial | Picklist | Selection for either a “Full” and “Partial” load capability. “Full” is the default value. |
Initial Quantity | Number(6, 0) | The initial quantity of trucks related to this posting. |
MC Number | Text(20) | The Carrier MC Number. |
Minimum Miles | Number(10, 0) | The minimum trip length the Carrier will accept. |
Origin | Formula (Text) | The city/state/country of the truck origin. |
Origin City | Text(40) | The origin city of a truck. |
Origin Country | Picklist | The origin country of a truck. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Origin Geolocation | Geolocation | The latitude and longitude of a truck origin. |
Origin State | Picklist | The origin state of a truck. Many values present. This field is dependent on the Origin Country field. No default value. |
Pickup Range (Miles) | Number(10, 0) | The distance from the pickup location the Carrier is looking for loads. |
Posting | Auto Number | The unique record identifier. Example: P-{0}. |
Quantity | Number(6, 0) | The current number of trucks related to this posting. |
Source | Picklist | The source for a Truck Posting. Values include: “Internal,” “DAT,” “Truckstop,” “TransCore,” and “Trucker Tools Load Board.” “Internal” Is the default value. |
Transaction Id | Text(20) (External ID) | A “Session”-specific identifier for a batch of load board postings. |
User (SFDC Object)
The User object is a foundational object of Salesforce. The TMS contributes several fields to this object.
Field Name | Type | Description |
---|---|---|
Customer Portal Quote Visibility | Picklist | Determines which Carrier quotes are visible to the user on the customer portal Quote Wizard. Values include, “Lowest Quote Only,” “Fastest Transit Only,” and “All Quotes.” No default value. |
Customer Portal Tender Options | Picklist | Determines which Carrier quotes a user can select on the customer portal Quote Wizard. Values include: “Any Quote,” “Any Quote with Reason,” and “Lowest Quote Only.” No default value. |
Load Locking Administrator | Checkbox | If “Checked,” the user is a load locking administrator. |
Load Locking Max Count | Number(3, 0) | The number of load locks that a user can hold simultaneously. |
MCP Intellivite Link | URL(255) | A personal URL at MyCarrierPackets to onboard Carriers. |
Rerate/Rebill Permissions | Picklist (Multi-Select) | Enables a user to interact with the rerate/rebill buttons on the Customer Quote Builder. Values include: “Rerate,” “Update Invoice,” and “Lock.” No default value. |
Review Before Tender | Checkbox | If “Checked,” a Customer Portals user’s loads require internal review. |
Selection Reason Required Modes | Picklist | Modes when selected require a Carrier Quote selection reason for all non-lowest cost quotes. Values include: “Truckload,” “LTL,” “Intermodal,” “Drayage,” “Ocean FCL,” “Ocean LCL,” “Air Freight,” “Flatbed,” “Bulk,” and “Parcel.” No default value. |
Vehicle Involved
This Fleet Management object captures vehicles involved in Incident records.
Field Name | Type | Description |
---|---|---|
Comments | Text Area(255) | Comments regarding the vehicle involved. |
Fleet Asset | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with this Vehicle Involved. |
Incident | Master-Detail(Incident) | The Master-Detail relationship to the parent Incident record the Vehicle Involved belongs to. |
Vehicle Involved ID | Auto Number | The unique record identifier. Example: Vehicle Involved-{0}. |
Vendor Invoice
The Vendor Invoice object contains Carrier and Vendor Invoices against delivered loads.
Note that the API name of this object is: “CarrierInvoice__c.”
Field Name | Type | Description |
---|---|---|
Accessorial Charges | Currency(16, 2) | The monetary Total Accessorial Charges for this Vendor Invoice. |
Accounting Processed Date | Date/Time | The date and time the invoice was processed; for example, when it was exported to QuickBooks. |
Accounting Status | Picklist | Flag for the Pub/Sub Accounting integration. Values include: "Ready for Accounting," "Sent to Accounting," "Publish Error." |
Adjustments | Currency(16, 2) | The additional monetary charges for a re-weigh, re-classification, etc. |
Balance Due | Formula (Currency) | The monetary result of the Carrier Total field minus the Paid Amount field and the Payment Discount field. |
Carrier | Formula (Text) | The name of the Carrier covering the load. This field is Read-Only. |
Carrier Quote | Lookup(Carrier Quote) | A lookup to the Carrier Quote record associated with this auto-generated Vendor Invoice. |
Carrier Service ID | Formula (Text) | The ID of the Carrier Service record covering the load. |
Comments | Text Area(255) | Comments usually provided by the carrier regarding the Vendor Invoice. |
Destination City | Text(40) | The destination stop city for the load invoiced. |
Destination Country | Picklist | The destination stop country for the load invoiced. The Destination State field is dependent on this field. “US” is the default value. |
Destination Name | Text(80) | The destination stop name for the load invoiced. |
Destination Postal Code | Text(20) | The destination stop postal code for the load invoiced. |
Destination State | Picklist | The destination stop state for the load invoiced. This field is dependent upon the Destination Country field selection. No default value. |
Destination Street | Text Area(255) | The destination stop street for the load invoiced. |
Discount | Currency(16, 2) | The monetary difference between the Freight Charges and Net Freight Charges fields, if provided, representing the customer’s discount. |
EPayment | Lookup(EPayment) | A lookup to the EPayment record that generated the Vendor Invoice. |
Freight Charges | Currency(16, 2) | The gross monetary Freight Charges rate, before any customer discount. |
Fuel Surcharge | Currency(16, 2) | The monetary Fuel Surcharge line-item for this Vendor Invoice. |
Invoice Date | Date | The date the Invoice was generated by the Carrier or the User. |
Invoice Due Date | Date | The date the payment for a Vendor Invoice is due. |
Invoice Number | Text(80) | The Invoice Number for a load (as possibly provided by Carrier). |
Invoice Status | Picklist | The current state of the Vendor Invoice. Values include: “Pending,” “Audit Hold,” “Approved,” “Paid,” and “Short Paid.” “Pending” is the default value. |
Invoice Total | Formula (Currency) | The total monetary Vendor Invoice amount. This field is calculated by Adding the Net Freight Charges plus the Fuel Surcharge plus the Accessorial Charges plus the Adjustments fields. Note that the API name of this field is “CarrierTotal__c.” |
Load | Master-Detail(Load) | The Master-Detail relationship to the parent Load record the Vendor Invoice belongs to. |
Master Invoice Number | Text(50) (External ID) | When a set of Invoices are collected into a single email or printed as one PDF document, all contained Vendor Invoices will have the same Master Invoice Number. |
Net Freight Charges | Formula (Currency) | The monetary charges calculated by taking the Freight Charges amount field and subtracting the Discount field amount. |
Order Number | Formula (Text) | The customer Order Number of the related load. |
Origin City | Text(40) | The origin stop city for the load invoiced. |
Origin Country | Picklist | The origin stop country for the load invoiced. The Origin State field is dependent on this field. “US” is the default value. |
Origin Name | Text(80) | The origin stop name for the load invoiced. |
Origin Postal Code | Text(20) | The origin postal code country for the load invoiced. |
Origin State | Picklist | The origin stop state for the load invoiced. This field is dependent upon the Origin Country field selection. No default value. |
Origin Street | Text Area(255) | The origin stop street for the load invoiced. |
Paid Amount | Currency(16, 2) | The total monetary amount paid to date toward this Vendor Invoice. |
Payee Reference | Text(100) | This is typically the Carrier’s Invoice Number, if available. |
Payment Discount | Currency(16, 2) | Any monetary discount that can be applied to this Vendor Invoice, such as advance payment. |
Payment Discount Taken | Currency(16, 2) | Any monetary discount applied to the Vendor Invoice, rolled up from the child payment records. |
POD Received | Formula (Checkbox) | If “Checked,” the load-level field of the same name is true. |
Remit To | Lookup(Account) | A lookup to the Account record associated with the name of the Carrier or Factoring Company. |
Vendor | Lookup(Account) | A lookup to the Account record associated with the Carrier or Vendor who is the payee for this Vendor Invoice. |
Vendor Invoice Accessorial
This object contains Accessorial charge line-items, if any, for a Carrier or Vendor Invoice record.
Note that the API name of this object is “CarrierInvoiceAccessorial__c.”
Field Name | Type | Description |
---|---|---|
Accessorial | Lookup(Accessorial) | A lookup to the Accessorial record associated with the Vendor Invoice Accessorial. |
Carrier Accessorial | Lookup(Carrier Accessorial) | A lookup to the Carrier Accessorial record associated with the Vendor Invoice Accessorial. |
Carrier Invoice | Master-Detail(Vendor Invoice) | The Master-Detail relationship to the parent Vendor Invoice record the Vendor Invoice Accessorial belongs to. |
Charge | Currency(16, 2) | The monetary charge from the Carrier for this accessorial. |
Code | Text(20) | The Carrier’s standard accessorial invoicing code. |
Name | Text(80) | The Carrier-specific name/description of an accessorial. |
Notes | Text(200) | Optional details related to the accessorial charge. |
Quantity | Number(16, 2) | The number of Units for the accessorial. |
Stop | Lookup(Stop) | A lookup to the Stop record associated with the Vendor Invoice Accessorial. |
Unit | Picklist | Type of accessorial cost category. There are many options including, “Fixed Cost,” “Percent of Amount,” “Per Cubic Foot,” etc. No default value. |
Unit Price | Number(16, 2) | The per-unit cost of the accessorial. |
Vendor Invoice Adjustment
This object contains charges for re-weighs, re-classifications, and other unexpected load configuration issues.
Note that the API name of this object is “CarrierInvoiceAdjustment__c.”
Field Name | Type | Description |
---|---|---|
Adjustment Amount | Currency(16, 2) | The monetary amount of the Vendor Invoice Adjustment. |
Category | Picklist | The type or category of Vendor Adjustment. Values include: “Re-Class,” “Re-Weight,” and “Other.” No default value. |
Description | Text(80) | The description of the Vendor Invoice Adjustment. |
Vendor Invoice | Master-Detail(Vendor Invoice) | The Master-Detail relationship to the parent Vendor Invoice record the Vendor Invoice Adjustment belongs to. |
Vendor Invoice Freight Charge Item
This object contains line itemized freight charges specific to vendor invoices.
Field Name | Type | Description |
---|---|---|
Freight Charge | Currency(16, 2) | The freight charge amount associated with this freight charge item. |
Freight Charge Item Number | Auto Number | The unique record identifier. Example: Freight Charge Item-{0}. |
Item Description | Text(255) | The item description this freight charge item refers to. |
NMFC Class (Rated As) | Picklist | The NMFC Class associated with this freight charge item. Many possible values with no default value. |
Quantity | Number(16, 2) | The number of freight charge items. |
Rate | Currency(10, 2) | The rate associated with this freight charge item. |
Unit | Picklist | The unit of measure for this freight charge item. No default value. |
Vendor Invoice | Master-Detail(Vendor Invoice) | The Master-Detail relationship to the parent Vendor Invoice record the Vendor Invoice Freight Charge Item belongs to. |
Weight | Number(18, 0) | The weight of the the freight charge item. |
Weight Units | Picklist | The unit of measure for the weight of the freight charge item. Values include "lbs" and "kg." No default value. |
Vendor Payment
The Vendor Payment object tracks any payments to Carriers or Vendors against Carrier Invoices, including advance payments like Comcheks.
Note that the API name of this object is “CarrierPayment__c.”
Field Name | Type | Description |
---|---|---|
Accounting Processed Date | Date/Time | The date and time the payment was processed; for example, when it was exported to QuickBooks. |
Check/Reference Number | Text(50) (External ID) | The check or transaction number of the Vendor Payment. |
Comments | Text Area(255) | Any comments related to the Vendor Payment. |
Description | Text(80) | The name/description of the Vendor Payment. |
Discount | Currency(16, 2) | The monetary amount applied toward the total due amount. |
EPayment | Lookup(EPayment) | A lookup to the EPayment record associated with and generated the Vendor Payment. |
Load | Lookup(Load) | A lookup to the Load record associated with the Vendor Payment. |
Payment Amount | Currency(16, 2) | The monetary amount of the payment toward the total due. |
Payment Fee | Currency(16, 2) | Any payment fee assessed against the Carrier; for example, an early payment fee. |
Payment Type | Picklist | The type of payment. Values include: “Company Check,” “Comdata Comchek,” “EFS MoneyCode,” “ACH,” “Wire,” and “Other.” No default value. |
Processor Fee | Currency(16, 2) | Any fee assessed by the payment processor; for example, a Comchek processor fee. |
Recipient | Lookup(Contact) | A lookup to the Contact record associated with receiving payment for the Vendor Invoice. |
Status | Picklist | The current state of the Vendor Invoice payment. Values include: “Pending,” “Issued,” “Blocked,” “Cancelled,” and “Cashed.” “Pending” is the default value. |
Transaction Id | Text(50) | The Comchek transaction identifier. |
Vendor | Master-Detail(Account) | The Master-Detail relationship to the parent Account record the Vendor Payment belongs to. Note that the API name is “Carrier__c.” |
Vendor Invoice | Lookup(Vendor Invoice) | A lookup to the Vendor Invoice record the Vendor Payment is applied to. Note that the API name is “CarrierInvoice__c.” |
Violation
This Fleet Management object stores driver/asset violations.
Field Name | Type | Description |
---|---|---|
Category | Picklist | Violation category description. Values include: “Driver,” “Vehicle,” “Hazmat,” and “Other.” No default value. |
City | Text(50) | The city where the Violation occurred. |
Code | Text(80) | The Legal code related to the Violation. |
Country | Picklist | The country where the Violation occurred. Values include: “US,” “CA,” and “MX.” “US” is the default value. |
Description | Picklist | A description of the violation. There are many selections available including: “Speeding,” “Failing to use seat belt,” and “No ELD instruction sheet.” No default value. |
Fine Amount | Currency(16, 2) | The monetary amount of the violation fine. |
Incident | Lookup(Incident) | A lookup to the Incident record associated with the Violation. |
Inspection Report | Lookup(Inspection Report) | A lookup to the Inspection Report record associated with the Violation. |
Officer Agency | Lookup(Account) | A lookup to the Account record associated with the Officer Agency. |
Officer First Name | Text(50) | The first name of the Officer involved with the Violation. |
Officer ID | Text(50) | The ID or Badge Number of the Officer involved with the Violation. |
Officer Last Name | Text(50) | The last name of the Officer involved with the Violation. |
Other Description | Text Area(255) | Additional comments and details regarding the Violation. |
Recipient | Lookup(Driver) | A lookup to the Driver record associated with the Violation. |
State/Province | Picklist | The State/Province where the violation occurred. States and Provinces from the US, Mexico, and Canada are available. This field is dependent upon the Country field selection. No default value. |
Tractor/Truck | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with the Violation. |
Trailer | Lookup(Fleet Asset) | A lookup to the Fleet Asset record associated with the Violation. |
Type | Picklist | The authority type for the Violation. Values include: “Federal,” “State,” and “Local.” No default value. |
Violation Date/Time | Date/Time | The date and time of the violation. |
Violation ID | Auto Number | The unique record identifier. Example: Violation-{0}. |
Voyage
The Voyage object stores voyage/vessel details for an Ocean FCL load.
Field Name | Type | Description |
---|---|---|
Arrival Date | Date | The estimated or actual arrival date at the Port of Discharge. |
Carrier Service | Master-Detail(Carrier Service) | The Master-Detail relationship to the parent Carrier Service record the Voyage belongs to. |
Departure Date | Date | The estimated or actual departure date at the Port of Loading. |
Destination Name | Text(100) | The destination city/state/country name. |
Destination Type | Picklist | Description of the final stop for a load. Values include: “Port of Discharge” and “Place of Delivery.” “Port of Discharge” is the default value. |
Destination UN Location Code | Text(6) | The UN Location code for the destination, such as “BEANR” for Antwerp. |
Door to Door | Formula (Checkbox) | If “Checked,” the FCL load is door to door. |
Door to Port | Formula (Checkbox) | If “Checked,” the FCL load is door to port. |
Lloyds Code | Text(50) | The Lloyd’s code of a vessel. |
Load | Lookup(Load) | A lookup to the load record associated with the ocean voyage. |
Name | Auto Number | The unique record identifier. Example: Voyage-{0}. |
Origin Name | Text(100) | The origin city/state/country name. |
Origin Type | Picklist | A description of the acceptance of a load. Values include: “Port of Load” and “Place of Receipt.” “Port of Load” is the default value. |
Origin UN Location Code | Text(6) | The UN Location code for the origin, such as “CAMTR” for Montreal. |
Port to Door | Formula (Checkbox) | If “Checked,” the FCL load is port to door. |
Port to Port | Formula (Checkbox) | If “Checked,” the FCL load is port to port. |
Service Name | Text(100) | Service Name (such as Pacific Loop 1) for a vessel itinerary. |
Transit Time (Days) | Number(3, 0) | The transit time for a voyage measured in days. |
Vessel | Text(100) | The name of the vessel. |
Voyage Number | Text(20) | The number identification for a voyage. |
Zone
This object contains zone header definitions. A zone is a bag of locations treated as one for rating/quoting purposes.
Field Name | Type | Description |
---|---|---|
Type | Picklist | A description for the type of zone for a collection of locations. Values include: “Country,” “State,” “City/State,” “Zip3,” “Zip5,” “Postal Code,” “Location,” and “Mixed.” No default value. |
Zone Name | Text(80) | The name for a collection of locations. For example, “Western Region.” |
Zone Entry
This object contains the constituents of a zone. Fields populated vary by type of zone.
Field Name | Type | Description |
---|---|---|
Category | Picklist | A method to select zone entries. Values include: “Included” and “Excluded.” “Included” is the default value. |
City | Text(40) | The city name for a zone entry. |
Country | Picklist | The country ISO code for a zone entry. Values include: “US,” “CA,” and “MX.” No default value. |
Entry Type | Picklist | The classification of zone entry. Values include: “Country,” “State,” “City/State,” “Zip3,” “Zip5,” “Postal Code,” and “Location.” No default value. |
Location | Lookup(Account) | A lookup to the Account record associated with the Zone Entry (a location). |
Location Name | Formula (Text) | The location account name for a zone entry. |
Postal Code | Text(20) | The complete postal code for a zone entry. |
State/Province | Picklist | The state/province code for a zone entry. Many choices are available. No default value. |
Zip3 | Text(3) | The first three characters of a zone entry postal code. |
Zip5 | Text(5) | The first five characters of a zone entry postal code. |
Zone | Master-Detail(Zone) | The Master-Detail relationship to the parent Zone record the Zone Entry belongs to. |
Zone Entry | Auto Number | The unique record identifier. Example: Zone Entry {0}. |
Zone Location | String(255) | The summary of a zone entry definition. |
Accounting Seed Integration Field Definitions
This object contains fields added to the existing TMS and Accounting Seed objects.
Object Name | Field Name | Type | Description |
---|---|---|---|
Accessorial | Accounting Product | Lookup(Product) | A lookup to the Product associated with the Accessorial. |
AP Disbursement | Load | Formula (Text) | The Load related to the Payable the disbursement was applied to. |
Billing | Billing Contact Email | Formula (Text) | The customer billing contact email. |
Billing | Billing Method | Picklist | The preferred billing method of the customer. Values include: “Email,” “Print,” and “EDI.” “Email” is the default value. |
Billing | Customer Quote | Lookup(Customer Quote) | A lookup to the Customer Quote record associated with the billing. |
Billing | Customer Quote Total | Formula (Currency) | The customer quote total monetary amount related to this billing. |
Billing | Customer Quote Variance | Formula (Currency) | The monetary amount of variance resulting from the Billing Total – Quote Total. |
Billing | Date Sent | Date/Time | The date and time the billing was sent to the customer. |
Billing | Days Past Due | Formula (Number) | The number of days the billing is past due. |
Billing | Dispute Closed Date | Date/Time | The date and time the billing dispute was closed. |
Billing | Dispute Contact | Lookup(Contact) | A lookup to the Contact record associated with the billing dispute. |
Billing | Dispute Detail | Text Area(255) | A description of the reason for the billing dispute. |
Billing | Dispute Opened Date | Date/Time | The date and time the billing dispute was opened. |
Billing | Dispute Owner | Lookup(User) | A lookup to the User record associated with resolving the billing dispute. |
Billing | Dispute Reason | Picklist (Multi-Select) | The reason for the billing dispute. Values include: “Damages,” “Late Pickup,” “Late Delivery,” and “Pricing Issue.” No default value. |
Billing | Dispute Resolution | Text Area(255) | The resolution details for the billing dispute. |
Billing | Dispute Status | Picklist | The current state of the billing dispute. Values include: “Open” and “Closed.” No default value. |
Billing | Load | Lookup(Load) | A lookup to the Load record associated with the billing. |
Billing | POD Received | Formula (Checkbox) | If “Checked,” the POD for the load was received. |
Billing Cash Receipt | Load | Formula (Text) | The Load related to the Billing the cash was applied to. |
Billing Line | Stop | Lookup(Stop) | A lookup to the Stop record for stop-level accessorial charges. |
Billing Line | Unit | Picklist | The costing unit of measure. Some values include: “Fixed Cost,” “Per Pound,” “Per Day,” etc. No default value. |
Cash Disbursement | ACH Payment Info | Text Area(255) | The ACH Payment information for the cash disbursement. |
Cash Disbursement | Alternate Payee | Lookup(Account) | A lookup to the Account record associated with the Alternate Payee of the cash disbursement. |
Cash Disbursement | Included in NACHA File | Checkbox | If “Checked,” the cash disbursement was included in the NACHA file. |
Cash Disbursement Batch | Batch Type | Picklist | The ePayment type when batch cash disbursing. Values include: “Check” and “ACH (NACHA File).” No default value. |
Cash Disbursement Batch | NACHA File Creation Timestamp | Date/Time | The date a time the NACHA file was generated. |
Cash Disbursement Batch | NACHA File Status | Picklist | The status of a NACHA file. Values include: “Uploaded.” No default value. |
Cash Disbursement Batch | NACHA Reference Code | Text(8) | The reference code in the File Header record when generating a NACHA file. |
Contact | ACH Email Recipient | Picklist | Email recipient selection when generating a NACHA file. Values include: “To:,” “CC:,” and “Bcc:.” No default value. |
Customer Invoice | Accounting Id | Text(18) | Obsolete |
ePayment | Amount | Currency(16, 2) | The monetary amount of the ePayment (Comchek). |
ePayment | Credit Memo Amount | Picklist | The ePayment in relation to a Vendor Credit memo. Values include: “Amount and Payment Fee,” “Amount Only,” “Payment Fee Only,” and “None.” “Amount and Payment Fee” is the default value. |
ePayment | Description | Text(100) | A description of the purpose of the ePayment. |
ePayment | ePayment Fee Product | Lookup(Product) | A lookup to the product record associated with the ePayment fee. |
ePayment | ePayment Processing Charge Product | Lookup(Product) | A lookup to the Product record associated with the ePayment processing charge amount. |
ePayment | ePayment Product | Lookup(Product) | A lookup to the Product record associated with the ePayment. |
ePayment | ePayment Provider Payable | Lookup(Payable) | A lookup to the Payable record associated with the ePayment provider, such as Comdata. |
ePayment | Load | Lookup(Load) | A lookup to the Load record associated with the ePayment. |
ePayment | Name | Auto Number | The unique record identifier. Example: ePay-{0}. |
ePayment | Payment Fee | Currency(16, 2) | The monetary Payment Fee for the ePayment charged to the recipient. |
ePayment | Payment Status | Picklist | The current state of the ePayment. Values include: “Pending,” “Issued,” “Frozen,” and “Cancelled.” No default value. |
ePayment | Processing Charge | Currency(16, 2) | The monetary charge paid to the payment processor - Comdata/EFS. |
ePayment | Recipient | Lookup(Contact) | A lookup to the Contact record associated with receiving the ePayment. |
ePayment | Reference Number | Text(100) | The ePayment reference number returned from the issuer. |
ePayment | Transaction Id | Text(50) | The transaction identifier returned from the ePayment issuer. |
ePayment | Type | Picklist | The ePayment type. Values include: “Comdata Comchek” and “EFS MoneyCode.” “Comchek” is the default value. |
ePayment | Vendor | Lookup(Account) | A lookup to the Account record associated with the recipient of the ePayment. |
ePayment | Vendor Credit Memo | Lookup(Payable) | A lookup to the Payable record associated with the Credit Memo created by the ePayment. |
Field Definition | Data Type | Picklist | Selection for the data type when generating a NACHA file. Values include: “Currency,” “Number,” “Alpha,” “Alphanumeric,” “Date,” “Datetime,” and “Time.” No default value. |
Field Definition | Data Type Format | Text(20) | The data format type for generating a NACHA file. |
Field Definition | Default Value | Text(255) | The default value for a field when generating a NACHA file. |
Field Definition | End Position | Number(4, 0) | The ending field number for generating a NACHA file. |
Field Definition | Field Definition Name | Auto Number | The unique record identifier. Example: FDN-{0000}. |
Field Definition | Field Name | Picklist | Selection of the record type when generating a NACHA file. This field is dependent on the File Type field. No default value. |
Field Definition | Field Size | Number(3, 0) | The size of a field when generating a NACHA file. |
Field Definition | Field Value Requirement | Picklist | Setting for fields when generating a NACHA file. Values include: “Optional,” “Mandatory,” and “Required.” This field is dependent on the File Type field. No default value. |
Field Definition | File Type | Picklist | The type of file when generating a NACHA file. Values include: “NACHA,” with no default value. |
Field Definition | Padding Character | Picklist | The padding character selection for NACHA file generation. Values include: “Blank,” “0,” “1,” “2,” “3,” “4,” “5,” “6,” “7,” “8,” and “9.” No default value. |
Field Definition | Padding Justification | Picklist | Alignment selection when generating NACHA files. Values include: “Left” and “Right.” No default value. |
Field Definition | Record Definition | Master-Detail(Record Definition) | The Master-Detail relationship to the parent Record Definition record the Field Definition belongs to for generating NACHA files. |
Field Definition | Reference Field | Text(40) | The reference field for NACHA file generation. |
Field Definition | Sequence Number | Number(4, 0) | The field number sequence for generating a NACHA file. |
Field Definition | Start Position | Number(4, 0) | The beginning field number for generating a NACHA file. |
File Definition | Create Balancing Transaction | Picklist | Selection for the inclusion of a balancing Detail record for NACHA file generation. Values include: “Yes” and “No.” This field is dependent on the File Type field. No default value. |
File Definition | Description | Text Area(255) | The description of a file definition for NACHA file generation. |
File Definition | File Definition Name | Text(80) | The file definition for NACHA file generation. |
File Definition | File Generator Class | Text(40) | A custom class used for NACHA file generation. |
File Definition | File Type | Picklist | The selected file type for NACHA file generation. Values include: “NACHA,” with no default value. |
Payable | Actual Draft Date | Date/Time | The actual date and time the payment processor takes money from payor account. |
Payable | Alternate Payee | Lookup(Account) | A lookup to the Account record associated with the Alternate Payee for NACHA File generation. |
Payable | Carrier Quote | Lookup(Carrier Quote) | A lookup to the Carrier Quote record associated with the Payable. |
Payable | Carrier Quote Total | Formula (Currency) | The monetary Carrier Quote Total amount related to this Payable. |
Payable | Carrier Quote Variance | Formula (Currency) | The monetary amount of the Payable Total – Quote Total. |
Payable | Days Past Due | Formula (Number) | The number of days the Payable is past due. Negative numbers indicate the days until the due date. |
Payable | Dispute Closed Date | Date/Time | The date and time the dispute was closed. |
Payable | Dispute Contact | Lookup(Contact) | A lookup to the Contact record associated with the Payable dispute. |
Payable | Dispute Detail | Text Area(255) | A description of the Payable dispute. |
Payable | Dispute Opened Date | Date/Time | The date and time the Payable dispute was opened. |
Payable | Dispute Owner | Lookup(User) | A lookup to the User record associated with resolving the dispute. |
Payable | Dispute Reason | Picklist (Multi-Select) | The category of dispute. Values include: “Damages,” “Late Pickup,” “Late Delivery,” and “Pricing Issue.” No default value. |
Payable | Dispute Resolution | Text Area(255) | The resolution details of the dispute. |
Payable | Dispute Status | Picklist | The current state of the payment dispute. Values include: “Open” and “Closed.” No default value. |
Payable | Load | Lookup(Load) | A lookup to the Load record the Payable is related to. |
Payable | Locked By | Lookup(User) | A lookup to the User record disbursing the payables when the Post and Pay job is running. |
Payable | Payment Method | Picklist | The method of payment. Values include: “Check” and “ACH (NACHA File). No default value. |
Payable | Payment Processor | Picklist | Selection of the payment processor. Values include: “Accounting” and “TriumphPay.” “Accounting” is the default value. |
Payable | Payment Processor Details | Text Area(255) | Status details related to payment processor activities. |
Payable | Payment Processor Fee | Currency(16, 2) | The monetary amount charged to the payor by the payment processor. |
Payable | Payment Processor Rebate | Currency(16, 2) | The monetary amount of rebate from the payment processor to the payor. |
Payable | Payment Processor Status | Text(250) | The status of the payment from the payment processor. |
Payable | Payment Processor Status Date | Date/Time | The date and time of the last update to the payment processor status. |
Payable | Payment Processor Submitted Date | Date/Time | The date and time the payable was submitted. |
Payable | POD Received | Formula (Checkbox) | If “Checked,” the POD for the load has been received. |
Payable | Quick Pay Amount | Currency(16, 2) | The monetary amount deducted from the payable total for early payment. |
Payable | Remittance Comments | Text Area(255) | Comments regarding payment remittance for NACHA file generation. |
Payable | Scheduled Draft Date | Date/Time | The scheduled date and time the payment processor will take money from the payor account. |
Payable | Vendor Paid Date | Date/Time | The actual date and time the vendor was paid by the payment processor. |
Payable Line | Unit | Picklist | The costing unit of measure. Some values include: “Fixed Cost,” “Per Mile,” “Per Day,” etc. No default value. |
Product | Product Family | Picklist | Selection for Product Family. “Transportation” added. |
Record Definition | Field Separator | Text(5) | The field separator for NACHA file generation. |
Record Definition | File Definition | Master-Detail(File Definition) | The Master-Detail relationship to the parent File Definition record the Record Definition belongs to for generating NACHA files. |
Record Definition | Record Definition Name | Auto Number | The unique record identifier. Example: RDN-{000}. |
Record Definition | Record Format | Picklist | The record format for NACHA file generation. Values include: “Fixed Length” and “Variable Length.” No default value. |
Record Definition | Record Length | Number(5, 0) | The length of the record length for NACHA file generation. |
Record Definition | Record Type | Picklist | The type of record for NACHA file generation. Values include: “File Header,” “Batch Header,” “Detail,” “Batch Control,” and “File Control.” No default value. |
Record Definition | Sequence Number | Number(2, 0) | The sequence number for NACHA file generation. |
Sales Tax | Accounting Product | Lookup(Product) | A lookup to the Accounting Product associated with Sales Tax. |