TDI field mapping tables - Contract

Before starting an upload, make sure you have read the information available in the Introduction to TDI and Importing data with TDI articles and followed the guidance provided.

Mandatory file:

Optional file(s):

Prerequisites:

We recommend uploading any locations, contacts, and customer or carrier accounts before uploading contracts.

The contract.csv file defines information about the contract, while the rate_table.csv defines rate tables applied to contracts. Contracts can be created without a rate table, so the rate_table.csv file is optional. However, the contract.csv and rate_table.csv files must be created and uploaded at the same time to create a rate table and assign it to a contract via TDI. If the contract uses flat rates, rate tables are not required. 

Columns that are Required (R), Optional (O) or Non-applicable (N/A) when the item_type is set to contract, lane, service, or fuel are indicated in the right column of the tables below.

Upload limitations for contracts

To avoid potential failures when uploading the contract.csv upload sheet, you should not upload a file with more than 20 rows where the item_type is set to contract. Standard TDI limits of 10,000 rows apply to other item_types (lane, service).

Conditional requirements for contract items

The columns found in the Contract entity’s upload files are highly dependent on the item_type of the contract item (whether it is a Contract, a Lane rate, a Service rate, or a Fuel rate) and what shipment mode is applied to the contract item. To help make these relationships clearer, we’ve added extra columns to the TDI field mapping tables found in this article that are not present in the articles for other TDI entities.

Item type requirements

The Item type requirements column in both the contract.csv and rate_table.csv details whether the TDI field is Required (R), Optional (O) or Non-applicable (N/A) when the item_type field is set to contract, lane, service, or fuel. Some may also be marked with an asterisk (*), meaning that the field is required or optional only if certain conditions are met. 

  • If the field is required for that item type, it must be filled in. 
  • If the field is optional for that item type, it can be filled in or left blank.
  • If the field is marked “N/A” for that item type, it should be left blank.

Applicable modes

In the contract.csv file specifically, these conditions are typically related to, but not limited to, the shipment mode entered into the contract item’s mode field. To make these relationships more clear, the contract.csv mapping table below includes an Applicable modes column, which details the modes (truckload [TL], intermodal, less-than-truckload [LTL], ocean, or drayage) are applicable to each contract item type using the following notation:

  • One or more specific modes: If one or more of these modes are listed specifically in the Applicable modes column, then the mode field must be set to one of those modes when the contract_item field is the indicated type for that field to be applicable. 
  • Any: If the item_type is set to the indicated type and Applicable modes column says “Any,” then you can input any one of the five applicable modes.
  • N/A: If the item_type is set to the indicated type and Applicable modes column says “N/A,” then the field should be left blank in your TDI upload sheet.

For example, the distance_provider field is marked as “O” (optional) when the item_type field is set to lane or service, and non-applicable when the item_type field is set to contract or fuel. Additionally, the Applicable modes column shows “TL, Intermodal, Ocean, or Drayage” for Lane and “Any” when the item_type is service. This means that: 

  • If the item_type field is set to contract or fuel, then the distance_provider field should be left blank.
  • If the item_type field is set to lane, then the distance_provider field can be left blank or filled in, unless the mode field is set to LTL, in which case it should be left blank.
  • If the item_type field is set to service, then the distance_provider field can be left blank or filled in, regardless of what you enter in the mode field.

Filename: contract.csv

Field Description Values/codes Conditions

Format/

restrictions

Conditional Requirements related to item types and modes.
Required (R), Optional (O), or Non-applicable (N/A) for: Applicable Modes:
item_type* Indicates the type of item in the contract.

contract

lane

service

fuel

Required for all item types. Enter the name of the contract item type as listed in the Values/Codes column. Use all lower-case letters. Contract R N/A
Lane R Any
Service R Any
Fuel R N/A
id* Unique system ID that maps the contract entity to Turvo. - Required for all item types. IDs cannot have spaces. Contract R N/A
Lane R Any
Service R Any
Fuel R N/A
custom_id* Additional Item identifier. - Required for all item types. IDs cannot have spaces. Contract R N/A
Lane R Any
Service R Any
Fuel R N/A
status_code* Status of the contract or contract item. 

Active

Inactive

Required for all item types. Enter "Active" or "Inactive" Contract R N/A
Lane R Any
Service R Any
Fuel R N/A
start_date* Beginning date of the contract or contract item. - Required for all item types.

Format: YYYY-MM-

DD

Contract R N/A
Lane R Any
Service R Any
Fuel R N/A
end_date* Ending date of the contract or contract item. - Required for all item types.

Format: YYYY-MM-

DD

Contract R N/A
Lane R Any
Service R Any
Fuel R N/A
currency* The currency used to define contract or contract item value.

Currency codes table

Required for all item types.

Find and enter the appropriate three letter ISO 4217 Currency Code using the table listed in the Values/Codes column. Contract R N/A
Lane R Any
Service R Any
Fuel R N/A
parent_id This ID corresponds to the contract’s custom ID that the lane, service, or fuel should be associated with. - - No character restrictions. Contract NA N/A
Lane R Any
Service R Any
Fuel R N/A
contract_name Name given to the contract during creation. - - No character restrictions. Contract N/A N/A
Lane N/A N/A
Service N/A N/A
Fuel N/A N/A
contract_account_id The account ID for the contract.

If the tenant has ID generalization enabled, this is the six character contract ID number appended to the contract account’s name in Turvo. 

Otherwise this is found in the URL when viewing the contract’s page in Turvo.

*A contract_account_id, contract_account, or carrier_scac is required if item_type is contract.

At least one must be filled in to upload the contract via TDI.

No character restrictions. Contract R* N/A
Lane N/A N/A
Service N/A N/A
Fuel N/A N/A

Contract_

account

The customer account name associated with contract. -

*A contract_account_id, contract_account, or carrier_scac is required if item_type is contract.

At least one must be filled in to upload the contract via TDI.

No character restrictions. Contract R* N/A
Lane N/A N/A
Service N/A N/A
Fuel N/A N/A
carrier_scac The SCAC ID for the primary carrier on the contract. -

*A contract_account_id, contract_account, or carrier_scac is required if item_type is contract.

At least one must be filled in to upload the contract via TDI.

Only one SCAC ID can be entered per row.

SCAC ID must be an exact match.

Contract R* N/A
Lane N/A N/A
Service N/A N/A
Fuel N/A N/A
faks Indicates the Freight All Kind (FAK) freight class for LTL SMC3



50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175, 200, 250, 300, 400, 500


 

 

 

*Only applicable to LTL SMC3 contracts


 

 

 

Enter one of the 18 FAK freight classes; ranges cannot overlap


Examples: (50-65:60),(70-92.5:70),(100-500:500)


 

 

 

Contract N/A N/A
Lane O* N/A
Service O* N/A
Fuel N/A N/A
contract_lane_type Indicates the source of LTL lane rate pricing, either via Turvo’s SMC3 integration or via a contract rate table.

SMC3

Contract

*Only applicable when item_type is lane, mode is LTL, and pricing_type is Payable.

If left blank, SMC3 is applied as the value automatically.

If set to Contract, a flat rate or a rate table should be applied.

Enter one of the lane types as listed in the Values/Codes column to the left. Be sure to match the capitalization shown. Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
service The type of service offered in the contract. Contract services are listed in the Contract services table. - Enter the name of the correct service as it appears in the table linked in the  Value/codes column. Contract N/A N/A
Lane N/A N/A
Service R Any
Fuel N/A N/A
stop_type Identifies the type of stop offered in the contract.

Pickup

Delivery

Any

- Enter the name of the stop type exactly as listed in the Values/Codes column, including capitalization. Contract N/A N/A
Lane N/A N/A
Service R Any
Fuel N/A N/A
location The name of the location associated with a service. - - No character restrictions. Contract N/A N/A
Lane N/A N/A
Service R Any
Fuel N/A N/A
index Identifies which fuel index is used in a contract to determine fuel costs.

Contract Fuel Indices are listed in the 

Contract Fuel Index codes table.

- Find and enter the name (not the code) for the fuel index to be used using the table linked in the Value/codes column. Contract N/A N/A
Lane N/A N/A
Service N/A N/A
Fuel R Any

Index_

effectiveness

The day of the week that the fuel index is effective. When rating the contract, Turvo will check for the fuel index rate on the day listed.

For example, if Monday is entered, the rate that was effective on the most recent Monday is used. If Current is entered, the most current rate is used, no matter what day of the week.

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

Sunday

Current

-

Enter the day of the week or "Current," as listed in the Values/Codes columns to the left.

Ensure the case of each character matches.

Contract N/A N/A
Lane N/A N/A
Service N/A N/A
Fuel O Any
index_min The minimum amount that triggers the fuel index. - - No character restrictions. Contract N/A N/A
Lane N/A N/A
Service N/A N/A
Fuel O Any
index_max The maximum amount that triggers the fuel index. - - No character restrictions. Contract N/A N/A
Lane N/A N/A
Service N/A N/A
Fuel O Any
origin_country The name of the country of origin for a shipment associated with the contract. - - No character restrictions. Contract N/A N/A
Lane R Any
Service O Any
Fuel R Any
origin_state The name of the state of origin for a shipment associated with the contract. - - No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
origin_city The name of the city of origin for a shipment associated with the contract. - - No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
origin_zip The zip code of origin for a shipment associated with the contract.

Examples:

72748

72748-9067

M5V 3T4

Must be a valid zip code.

No character restrictions.

Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
origin_3dzip The three-digit zip code of origin for a shipment associated with the contract. 

-

 

Must be a valid zip code.

No character restrictions. 

Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
destination_country The name of the destination country for a shipment associated with the contract. - - No character restrictions. Contract N/A N/A
Lane R Any
Service O Any
Fuel O Any
destination_state The name of the destination state for a shipment associated with the contract. - - No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
destination_city The name of the destination city for a shipment associated with the contract. - - No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
destination_zip The zip code destination for a shipment associated with the contract.

Examples:

72748

72748-9067

M5V 3T4

Must be a valid zip code.

No character restrictions.

Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
destination_3dzip Three-digit zip code of destination for a shipment associated with the contract. 

-

Must be a valid zip code.

No character restrictions. 

Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
pricing_type Identifies whether a contract entity is payable or billable.

Payable

Billable

- Enter the pricing type as listed in the Values/Codes columns to the left.
Ensure the case of each character matches.
Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
payable_account The name of the carrier account to be paid. -

This field should be left blank when the Parent contract is a payable/carrier contract (contract_account field contains a customer account name and the pricing_type field is set to Payable).

No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
bill_to_account The name of the customer account to be billed. -

This field should be left blank when the Parent account is a billable/customer contract (contract_account field contains a customer account name and the pricing_type field is set to Billable).

No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel O Any
equipment Type of equipment required on the contract. Equipment types are listed in the Equipment type codes table. - Find and enter the name (not the code) for the equipment type as it is listed in the table linked in the Value/codes column. Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
size Size of the trailer required on the contract. Equipment size codes are found in the Equipment and Asset size codes table. - Find and enter the name (not the code) of the for the asset’s size as listed in the Equipment size column of the table linked in the Value/codes column.  Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
route_type The type of lane route required on the contract.

Port to port

Door to door

Port to door

Door to port

Round trip

One way

- Enter the name of the route type as listed in the Values/Codes column. Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
business_unit The name of the business unit associated with a contract lane rate. - - No character restrictions. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
mode The carrier transportation mode for the lane or service.

Ocean

TL

Intermodal

Drayage

LTL

- Enter the name of the mode that applies as it is listed in the Values/Codes column to the left. Contract N/A N/A
Lane R -
Service R -
Fuel N/A N/A
service_level The level of service identified in the contract lane.

Standard

Expedited

Any

- Enter the name of the service level as listed in the Value/codes column. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
hazmat Indicates whether the lane rate includes transportation of hazardous materials.

Yes: Y

No: N

When a shipment with hazmat service at shipment level is rated, it only pulls lane rates with hazmat flag enabled. Enter "Y" to indicate the lane rate covers hazmat, or "N" to indicate that it does not. Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
rate_type Identifies the lane, service, or fuel rate type. 

Flat: F

Per Mile: PM

Per Hundredweight: PHW

Per Ton: PT

Per Unit: PU

Per Handling Unit: PHU

Per Hour: PH

Per Stop: PS

Percent of Freight: PF

Per Each: PE

Per Piece: PP

Per Pallet: PPAL

Percent: PER

Applicable values when item_type is lane: F, PM, PHW, PT, PU, PHU, & PH.

Applicable values when item_type is service: F, PM, PHW, PT, PU, PHU, PS, PE, PP, PPAL, & PER.

Applicable values when item_type is fuel: F, PM, & PF.  

Enter the 2-4 character abbreviation for the rate type as listed in the Value/Codes column to the left

Ensure that the applied value matches the item type.

Contract N/A N/A
Lane R LTL
Service O Any
Fuel R N/A
sub_rate_type If the rate has a sub-rate determined by the quantity of items, enter the code for that quantity type here (e.g., cases, pallets, etc.). Quantity type codes are found in the Quantity type codes table.

 

-

Find and enter the 2-4 character abbreviation for the rate type using the table linked in Value/Codes column to the left.

Ensure that the applied value matches the item type.

Contract N/A N/A
Lane O LTL
Service O Any
Fuel R N/A
rate The rate applied to the lane per unit of the rate type indicated in the rate_type field. -

*Required if item_type is lane, unless a rate_table_id is provided. If no rate table ID is provided, this field is optional.

No character restrictions. Contract N/A N/A
Lane O* LTL
Service O Any
Fuel N/A N/A
rate_table_id The ID for the contract’s rate table. Create a rate_table_id in the rate_table.csv file and apply it here. 

If a rate table is created, the contract.csv and rate_table.csv files must be uploaded at the same time.

Not applicable if a flat rate is entered in the rate field.

IDs cannot have spaces. Otherwise, no character restrictions. Contract N/A N/A
Lane O LTL
Service O Any
Fuel N/A N/A
rate_table_rule Defines whether the contract rate is the cumulative  rate defined by the rate table, or if only the highest rate is used.

CUMULATIVE

HIGHEST_RATE

If a rate table is created, the contract.csv and rate_table.csv files must be uploaded at the same time.

Not applicable if a flat rate is entered in the rate field.

Enter the rate table rule name as shown in the Value/codes column. Use all caps. Contract N/A N/A
Lane O LTL
Service O Any
Fuel N/A N/A
fuel_included Identifies whether or not fuel costs are included in the rate.

Yes: Y

No: N

Not applicable if a flat rate is entered in the rate field.

Enter "Y" to indicate that the fuel rate is included, or "N" to indicate that it is not. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
min_cost The minimum amount that is charged for lane rates. - - No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel N/A N/A
max_cost The maximum amount that is charged for lane rates. - - No character restrictions. Contract N/A N/A
Lane O Any
Service O Any
Fuel N/A N/A
priority Indicates the priority that the lane rate should take when Turvo looks for applicable rates. Enter a numerical value from 0 to 1000. The default value applied if left blank is 1000.  Numbers only.  Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
min_distance The minimum distance that triggers a lane rate. - - No character restrictions. Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
max_distance The maximum distance that triggers a lane rate. - - No character restrictions. Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
distance The distance of the lane. - Applicable only if item_type is service. No character restrictions. Contract N/A N/A
Lane N/A N/A
Service O Any
Fuel N/A N/A
distance_provider Identifies the distance provider used for the lane rate. PC Miler

PC Miler is currently the only applicable distance provider for lane rates.

Note: We recommend configuring PC Miler in Admin Console > Settings.

Enter the name of the distance provider as listed in the Values/Codes column. Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service O Any
Fuel N/A N/A
distance_unit The unit of measure for the lane rate distance.

Miles: mi

Kilometers: km

*Required if a distance is provided. Otherwise, leave blank. Enter "mi" or "km." Contract N/A N/A
Lane O* TL, Intermodal, Ocean, Drayage
Service O* Any
Fuel N/A N/A
distance_provider_version Identifies the version of the distance provider used.  Distance provider versions are listed in the Distance Provider Version codes table *Required if the distance_provider field is set to PC Miler. Otherwise, leave blank. Find and enter the abbreviation (not the code) for the Abbreviations for distance provider version using the table linked in the Value/Codes column. Contract N/A N/A
Lane O* TL, Intermodal, Ocean, Drayage
Service O* Any
Fuel N/A N/A
min_weight The minimum weight that triggers a lane rate. - - No character restrictions. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
max_weight Maximum weight that triggers a lane rate. - - No character restrictions. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
weight_unit Unit of measure for the lane rate weight.

Pounds: lb

Kilograms: kg

Tonnes (metric): t

Ounces: oz

Tons (imperial): ton

Grams: g

- Enter the 1-3 letter abbreviation for the unit type as listed in the Value/codes column. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
transit_time The estimated travel time for a specific lane. - - No character restrictions. Contract N/A N/A
Lane O TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
transit_time_unit Unit of measure for the transit time.

Days

Hours

Minutes

*Required if entering a transit time. Otherwise, leave blank. Enter the name of the appropriate unit as listed in the Value/codes column. Contract N/A N/A
Lane O* TL, Intermodal, Ocean, Drayage
Service N/A N/A
Fuel N/A N/A
transhipment_port Stop type where there is an intermediate port destination that will be visited in the middle of the route. - - Enter the name of the port, or enter “Direct," which means there is no shipment port and the shipment travels straight from the origin port to the destination port. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
precarriage_mode The mode of transportation for the cargo prior to loading on a vessel.

Truck

Rail

Barge

Applicable only when item_type is lane and mode is Ocean. Otherwise, leave blank. Enter the name of the pre-carriage mode as it appears in the Values/Codes column. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
oncarriage_mode The mode of transportation for the cargo after loading on a vessel.

Truck

Rail

Barge

Applicable only when item_type is lane and mode is Ocean. Otherwise, leave blank. Enter the name of the on-carriage mode as it appears in the Values/Codes column. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
capacity Maximum capacity for a lane. - - Integers only. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
capacity_unit Unit of measure for the capacity.

Shipments

TEUs

Containers

- Enter "Shipments," "TEUs," or "Containers" as it appears in the Values/Codes column. Contract N/A N/A
Lane O Any
Service N/A N/A
Fuel N/A N/A
origin_free_time Length of time allotted for pickup of cargo. - - Enter the number of days designated as free time. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
origin_detention Length of time cargo is kept beyond the free time outside the pickup port, terminal, or depot. - - Enter the number of days designated as detention. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
origin_demurrage Length of time cargo is kept beyond the free time for a pickup. - - Enter the number of days designated as demurrage. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
dest_free_time Length of time allotted for cargo at a destination. - - Enter the number of days designated as free time. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
dest_detention Length of time cargo is kept beyond the free time outside the destination port, terminal, or depot. - - Enter the number of days designated as detention. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
dest_demurrage Length of time cargo is kept beyond the free time at a destination.  - - Enter the number of days designated as demurrage. Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
container_grade Identifies the condition and rating of a container. 

A grade

B grade

C grade

D grade

Food grade

- Enter the grade name as it appears in the Value/codes column (include the word "grade"). Contract N/A N/A
Lane O Ocean
Service N/A N/A
Fuel N/A N/A
notes Open field for notes. - - No character restrictions. Contract O Any
Lane O Any
Service O Any
Fuel O Any
tariff_name Tariff name from SMC3 integration. - *Required only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3.

No character restrictions.

Must be a valid tariff name listed in SMC3 RateWareXL

Contract N/A N/A
Lane R* LTL
Service N/A N/A
Fuel N/A N/A
tariff_effective_date First date that a tariff from SMC3 integration is valid. - *Required only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3.

Format: YYYY-MM-

DD

Contract N/A N/A
Lane R* LTL
Service N/A N/A
Fuel N/A N/A
use_discounts Indicates whether the discount field is on.

Yes: Y

No: N

*Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. Enter "Y" to indicate that discounts are in effect, or "N" to indicate that no discounts are in effect. Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
min_charge_floor Minimum charge for a shipment. - *Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. - Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
min_charge_discount Minimum discount allowed for a carrier. Ranges from 0 to 99.99 *Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. Enter a number between 0 and 99.99 Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
surcharge_per Surcharge percentage for LTL. - *Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. Enter a number between 0 - 99.99. Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
rate_adjustment_factor A factor that is applied when calculating charges. Defaults to 1.000. - *Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. Integers only. Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
stop_alternation_weight Used to eliminate truckload deficit rating by adding a max weight to stop the rating alternation. - *Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. Enter a number between 0 - 999999.00. Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
surcharge_application Surcharge percentage applied to LTL shipments.

Gross

Net

*Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. Enter "Gross" or "Net." Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
use_dim_min_charge Indicates whether or not a dimensional minimum charge applies. 

Yes: Y

No: N

*Applicable only if item_type is lane, if mode is LTLand if contract_lane_type is SMC3. Enter Y to indicate that a dimension minimum charge applies, or N to indicate that it does not. Contract N/A N/A
Lane O* LTL
Service N/A N/A
Fuel N/A N/A
item_id The cost line items in LTL contracts. - - - Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
cost_item_type The cost type that is applied to the shipment for the fuel surcharge. Cost type codes are found in the Cost type codes table.

Only “Freight” cost type items are applicable.

Find and enter the name (not the code) of the cost type item using the table linked in the Value/codes column. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
item_amount The total value of the cost item added. This field is calculated by multiplying the quantity by the price. - - Integers only. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
item_qty Quantity of the cost item being added. - - - Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
item_price Price of the cost item being added. - - - Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
Billable Indicates whether or not the item is billable.

Yes: Y

No: N

- Enter "Y" to indicate that the cost is billable, or "N" to indicate that it is not. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
item_notes Enter any notes about the contract item. - - No character restrictions. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_L5C Discount applicable on LTL shipments weighing less than 500 lbs. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M5C Discount applicable on LTL shipments weighing 500 lbs. or more, but less than 1,000 lbs. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M1M Discount applicable on LTL shipments weighing 1,000 lbs. or more, but less than 2,000 lbs. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M2M Discount applicable on LTL shipments weighing 2,000 lbs. or more, but less than 5,000 lbs. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M5M Discount applicable on LTL shipments weighing 5,000 lbs. or more, but less than 10,000 lbs. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M10M Discount applicable on LTL shipments weighing 10,000 lbs. or more, but less than 20,000 lbs. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M20M Discount applicable on TL shipments weighing 20,000 lbs. or more, but less than 30,000 lbs. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M30M Discount applicable on TL shipments weighing 30,000 lbs. or more, but less than 40,000 lbs.  - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A
SMC3_M40M Discount applicable on TL shipments weighing 40,000 lbs. or more. - - Enter a number between 0 - 99.99. Contract N/A N/A
Lane R LTL
Service N/A N/A
Fuel N/A N/A

Filename: rate_table.csv

The rate_table.csv is not an independent TDI entity. Not all contracts require a rate table, so this file is considered optional if no rate tables are needed. However, if one of your contracts in the contract.csv file requires a rate table, configuring and uploading this sheet at the same time as the contract.csv file is required.

Multiple rate tables can be configured in the same upload sheet, where each row of a rate table corresponds to a row in the rate_table.csv sheet. The TDI import process parses these rows into separate rate tables by looking for matching Table IDs, and assigns the rate table to a contract by looking for a matching Table ID in the contract.csv upload sheet. 

Note: The rate_table.csv mapping table does not feature an Applicable modes column.

Field Description Values/codes Conditions

Format/

restrictions

Required (R), Optional (O), or Non-applicable (N/A) for:
id* A unique identifier for the row in the rate_table.csv file. If you do not have an existing ID to use in this field, create one. This ID should match the ID used in the contextid column.  IDs cannot have spaces. Otherwise, no character restrictions. Contract N/A
Lane R
Service R
Fuel R
contextid*

The identifier for the row in the individual rate table. 

This is distinct from the id column, which identifies the row within the overall rate_table.csv file.

If you do not have an existing ID to use in this field, create one. This ID should match the ID used in the id column.  IDs cannot have spaces. Otherwise, no character restrictions. Contract N/A
Lane R
Service R
Fuel R
table_id A unique identifier for the rate table. This ID is used by the contract.csv entity to link a contract to the rate table. If you do not have an existing ID to use in this field, create one. All rows in the same rate table must include the same Table ID.  IDs cannot have spaces. Otherwise, no character restrictions. Contract N/A
Lane O
Service O
Fuel O
start_range The beginning of the range covered in this row of the rate table. The range’s type is defined in the contract.csv’s rate_type column. - For example, if rate_type is set to PM (Per Mile), then this row defines a distance range. Inputting “5” would correspond to 5 miles. If set to PH (Per Hour), entering “5” would be 5 hours. Integers only.

Contract N/A
Lane O
Service O
Fuel O
end_range The end of the range covered in this row of the rate table. The range’s type is defined in the contract.csv’s rate_type column. -

For example, if rate_type is set to PM (Per Mile), then this row defines a distance range. Inputting “10” would correspond to 10 miles. If set to PH (Per Hour), entering “10” would be 10 hours.

Combined with the start_range column, then the ranges applied in the examples would be 5 to 10 miles or 5 to 10 hours.

If left blank, the final range in a rate table will not have an upper limit. If start_range is “30” and end_range is left blank, all values above 30 are included in the range.

Integers only, or leave blank on the final row in a rate table. Contract N/A
Lane O
Service O
Fuel O
rate The cost applied based on the defined rate range. - The rate that is applied based on the rate_type and rate_table_rule in contract.csv and the ranges applied to the table. Integers only. Contract N/A
Lane O
Service O
Fuel O

 

Was this article helpful?

0 out of 0 found this helpful