TDI field mapping tables - Customer

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 files:

Prerequisites:

None required. However, we recommend uploading the User, Group, and Parent entities first. Some columns within the Customer entity’s fields reference IDs found in these entities. If they are not uploaded first, these fields will be left blank and you will need to link Customer accounts to their respective groups, and to their parent and user accounts from within the Turvo UI at a later time. An entity cannot reference information from another entity if that entity has not already been uploaded.

Note: Uploading the Contact entity prior to uploading this entity is not required, but if you have a single contact that is assigned to multiple Customer accounts, it will provide the contact IDs necessary for the primaryContact column in customer.csv. If this is not the case, uploading the Contact entity later and assigning contacts to Customer accounts at that time is recommended.

Important note: Fields bolded and marked with an asterisk (*) are mandatory.

Filename: customer.csv

Field

Description

Available codes

Format/restrictions

id*

Unique system ID for the entity. This ID is used anytime you would like to make updates or changes to the Customer in TDI or when using TDI to associate additional details to the account. If you do not have an existing ID to use in this field, you will need to create one.

-

Important note: ID cannot contain any spaces.

name*

The Customer’s name. 

-

No character restrictions. The name must be unique - no duplicate Customer names allowed.

parentAccount

Enter the Parent account ID if you would like to associate the Customer with a Parent account. 

-

Parent ID can be found in the ID column of the parent.csv upload sheet. 

ID should not contain any spaces or special characters.

taxId

The Customer’s tax ID.

-

No character restrictions.

address.line1

First line of address.

-

No character restrictions.

address.line2

Second line of address for additional information, such as a unit number (if applicable).

-

No character restrictions. 

address.city

Name of city.

-

Address city is required if adding an address to a Customer. 

address.state

Name or abbreviation of state/province. 

-

No character restrictions.

address.zip

Zip code or postal code.

-

No character restrictions.

Must be a valid zip code. (Ex.:, 72748, 72748-9067, M5V 3T4)

address.country

Name of country.

-

No character restrictions. 

phone

Enter a phone number for the Customer. This will appear under the Customer account’s Details tab > General section.

-

Integers only - No dashes or parentheses.

(Ex.: 3135551500)

phone.extension

The extension of the phone number, if required.

-

Integers only.

A phone number is required to use this field.

phone.country

The phone number’s country code.

Examples:

US: United States

CA: Canada

Enter the two-letter country code found in the Country codes table.

email

Primary email address for the Customer account. 

-

Standard email address format.

primaryContact

Enter Contact ID for the primary contact for this account

-

No character restrictions. 

If the Contact entity was uploaded before the Customer entity, contact IDs can be found in the ID column within the contact.csv spreadsheet. 

If the Contact entity was not uploaded before the Customer entity, leave blank.

specialInstructions

Special instructions for that Customer.

-

No character restrictions.

url

The website URL for the account.

-

No character restrictions.

status

The status of the account in Turvo.

Created: 2200

Prospect: 2201

Active: 2202

Inactive: 2203

Suspended: 2204

Enter the number code corresponding to the correct status.

notes

A free text field used to provide notes about the status of the account.

-

Conditional field - only available if the status of the Customer is provided. 

No character restrictions.

payToName

Billing contact name.

-

payToName is required to enter any third party billing information.

No character restrictions.

Important note: If  payToName is empty then billing information in the customer.csv file, like creditLimit, billingEmails, and other billing information, will not display in Turvo. 

payToName is required to enter any third party billing information.

careOf

Enter the care of (℅) name for the third party billing contact. 

-

No character restrictions.

billingLine1

First line of the billing address.

-

No character restrictions.

billingLine2

Second line of billing address for additional information, such as a unit number (if applicable).

-

No character restrictions. 

billingCity

Name of city.

-

Address city is required if adding an address to a Customer. 

billingState

Name or abbreviation of state/province. 

-

No character restrictions.

billingZip

Zip code or postal code.

-

No character restrictions.

billingCountry

Name of country.

-

No character restrictions. 

billingPhone

Enter a billing phone number for the Customer. This will appear under the  Details tab > Billing section.

-

Integers only - No dashes or parentheses.

(Ex.: 3135551500)

billingPhoneExt

The extension of the phone number, if required.

-

Integers only.

A phone number is required to use this field.

billingPhoneCountry

The phone number’s country code.

Examples:

US: United States

CA: Canada

Enter the two-letter country code found in the Country codes table.

billingEmails

Email address for the billing contact of the Customer account. 

-

Standard email address format.

billingContact

Enter Contact ID for the billing contact for this account

-

No character restrictions. 

If the Contact entity was uploaded before the Customer entity, contact IDs can be found in the ID column within the contact.csv spreadsheet. 

If the Contact entity was not uploaded before the Customer entity, leave blank.

creditLimit

Enter the Customer’s credit limit. 

-

Integers only - Decimals allowed.

payTerms

Enter the pay terms for the Customer. 

45 days: 7102

Standard 15 days: 7100

30 days: 7101

Enter the number code corresponding to the correct pay term.

instructions

Any billing instructions for the Customer. 

-

No character restrictions. 

paysUnloading

Indicate whether the Customer pays for the unloading.  

True/False

Enter True if the Customer is paying for unloading or False if they are not. 

invoiceDocuments

Indicate whether documents attached to shipments are required to Invoice the Customer and automatically move the shipment from “Route complete” to “Ready for billing”. 

True/False

Enter True if Invoices should be generated with or without necessary documents attached. Enter False if necessary documents should be attached before generating an Invoice.

autoInvoice

Indicate whether Invoices should be generated automatically for this Customer when a shipment reaches “Ready for billing” status.

True/False

Enter True to enable automatic Invoice generation, or False to keep manual Invoice generation.

isThirdParty

Indicate whether this is a third party billing entity.

True/False

Enter True if it is a third party billing entity, or False if it is not.

accountingSystem

The third party accounting integration information. This will appear in the Details tab > Accounting section of the Customer’s profile. 

Xero: 14000

Netsuite: 14003

CARMS: 14005

Quickbooks Online: 14006

Dynamics GP: 14007

Enter the number code corresponding to the correct Accounting system. 

accounting.type

The ID type used in the accounting system. This will appear in the Details tab > Accounting section of the Customer’s profile. 

GL Code: 9701

Cost center: 9702

Account: 9703

Xero ID: 9705

Netsuite ID: 9706

Quickbooks Online ID: 9707

DynamicsGP ID: 9708

Enter the number code corresponding to the correct Accounting system ID type.

accounting.value

Enter the ID value for the Customer’s Accounting system ID (EX: 123ABC). This will appear in the Details tab > Accounting section of the Customer’s profile. 

-

No character restrictions.

accountOwner

The ID of the Turvo user responsible for managing the Customer. 

-

No character restrictions.

Find the reference ID for the respective user in the user.csv upload sheet.

user

This ID corresponds to the User receiving commission from this Customer.

_

The ID is the value entered in the ID column in the user.csv file.

No character restrictions.

userCommission

Indicate the commission percentage that the above User should receive for shipments with this Customer.

Note: If you have entered a user in the above row, you must enter a commission here.

_

Decimal values allowed.

groupId

If the Customer should belong to a group, enter the ID created for the group to establish the mapping.

Note: If a Customer belongs to multiple groups, additional groups will be configured in the optional group.csv file.

-

No character restrictions.

Find the reference ID for the respective group in the Group.csv upload sheet.

Filename: communication_channel.csv

Note: If the customer accounts added via the customer.csv file only include one set of contact information for each column, this file is not required. If a customer has multiple addresses, phone numbers, email addresses, etc., that need to be associated with it, treat this file as required.

Field

Description

Available codes

Format/restrictions

id*

Unique system ID for the entity. If you do not have an existing ID to use in this field, you will need to create one.

-

Important note: ID cannot contain any spaces.

contextId*

This ID corresponds to the Customer that this contact information should be associated with.

-

Find the reference ID for the respective Customer in the customer.csv upload sheet.

No character restrictions.

email.type

Indicate the type of email address for the contact.

Main email: 1085

Other email: 1086

Billing email: 1087

Enter the number code corresponding to the type of email address.

Email type is required if entering an email address.

email

Enter an email address for the Customer. This will appear under the Customer Details tab > General > Profile section.

-

Standard email address format.

phone.type

Type of phone number (work, home, etc.)

Main phone: 1010

Fax: 1011

After hours phone: 1012

Other phone: 1013

Billing phone: 1014

Enter the number code corresponding to the type of phone number.

Phone type is required if entering a phone number.

phone

Enter a phone number for the Customer. This will appear under the location Details tab > General section.

-

Integers only - No dashes or parentheses.

(Ex.: 3135551500)

phone.extension

The extension of the phone number, if required.

-

Integers only.

A phone number is required to use this field.

phone.country

The phone number’s country code.

Examples:

US: United States

CA: Canada

Enter the two-letter country code found in the Country codes table.

address.type

Indicate the type of address for the contact.

Main address: 1160

Billing address: 1161

Other address: 1163

Enter the number code corresponding to the type of address.

address.line1*

First line of address.

-

No character restrictions.

address.line2

Second line of address for additional information, such as a unit number (if applicable).

-

No character restrictions. 

address.city*

Name of city.

-

Address city is required if adding an address to a Customer account. 

address.state*

Name or abbreviation of state/province. 

-

No character restrictions.

address.zip*

Zip code or postal code.

-

No character restrictions.

address.country

Name of country.

-

No character restrictions. 

isPrimaryAddress

Indicate whether this is the primary address for the Customer.

True/False

Enter True if the address entered above is the primary address or False if it is not. 

isPrimaryEmail

Indicate whether this is the primary email address for the Customer.

True/False

Enter True if the email address entered above is the primary email address or False if it is not. 

isPrimaryPhone

Indicate whether this is the primary phone number for the Customer.

True/False

Enter True if the phone number entered above is the primary phone number or False if it is not. 

Filename: user_commissions.csv

Field

Description

Available codes

Format/restrictions

id*

Unique system ID for the TDI upload of User commissions.

_

Important note: ID cannot contain any spaces.

contextId*

This ID corresponds to the Customer that this User should be associated with to earn commission.

_

Find the reference ID for the Customer in the customer.csv upload sheet.

No character restrictions.

user*

This ID corresponds to the User receiving commission from this Customer. 

_

The ID is the value entered in the ID column in the user.csv file.

No character restrictions.

userComission*

Indicate the commission percentage that the User should receive for shipments with this Customer.

_

Integers in percentage format only (e.g 15%, 25%, etc.)

 

Filename: account_distribution.csv

Field

Description

Available codes

Format/restrictions

id*

A system ID for the TDI upload of third party accounting information.

-

Important note: ID cannot contain any spaces.

contextId*

This ID corresponds to the Customer that this third party accounting information should be associated with. This will appear in the Details tab > Accounting section of the Customer’s profile. 

-

Find the reference ID for the Customer in the customer.csv upload sheet.

No character restrictions.

accountingSystem*

Third party accounting information for the Customer. This will appear in the Details tab > Accounting section of the Customer’s profile. 

Xero: 14000

Quickbooks: 14001

Netsuite: 14003

Turvo: 14004

CARMS: 14005

Quickbooks Online: 14006

DynamicsGP: 14007

Enter the number code corresponding to the correct Accounting system. 

accounting.id*

An external ID from the accounting system.

-

No character restrictions.

accounting.type*

The ID type used in the accounting system. This will appear in the Details tab > Accounting section of the Customer’s profile. 

GL Code: 9701

Cost center: 9702

Account: 9703

Xero ID: 9705

Netsuite ID: 9706

Quickbooks Online ID: 9707

DynamicsGP ID: 9708

Enter the number code corresponding to the correct Accounting system ID type.

accounting.value*

Enter the ID value for the Customer’s Accounting system ID (EX: 123ABC). This will appear in the Details tab > Accounting section of the Customer’s profile. 

-

No character restrictions.

 

Filename: settings.csv

Field

Description

Available codes

Format/restrictions

id*

Unique system ID used as the identifier for the settings upload.

-

Important note: ID cannot contain any spaces.

contextId*

Unique ID of the related Customer. 

-

The ID entered into the id field of the customer.csv.

ID should not contain any spaces or special characters.

appt.approachingLate

Indicate whether approaching late thresholds should be configured for Customer shipments with the scheduling type ‘By appt’.

True/False

Enter True to enable approaching late thresholds and tag shipments with #ApproachingLate.

Enter False to keep approaching late thresholds disabled.

Note: If appt.approachingLate is enabled, appt.runningLate must be enabled as well.  

appt.approaching
LateDuration

Enter the approaching late threshold. 

-

Integers only.

Minimum value is -120 and approaching late must be less than running late. 

appt.runningLate

Indicate whether running late thresholds should be configured for Customer shipments with the scheduling type ‘By appt’.

True/False

Enter True to enable running late thresholds and tag shipments with #RunningLate.

Enter False to keep running late thresholds disabled.

Note: If appt.runningLate is enabled, appt.approachingLate must be enabled as well. 

appt.running
LateDuration

Enter the running late threshold. 

-

Integers only.

Running late value must be more than approaching late. 

fcfs.approachingLate

Indicate whether approaching late thresholds should be configured for Customer shipments with the scheduling type ‘FCFS (first come, first served)’.

True/False

Enter True to enable approaching late thresholds and tag shipments with #ApproachingLate.

Enter False to keep approaching late thresholds disabled.

Note: If fcfs.approachingLate is enabled, fcfs.runningLate must be enabled as well. 

fcfs.approaching
LateDuration

Enter the approaching late threshold for shipments with the scheduling type FCFS (first come, first served). 

-

Integers only.

Minimum value is -120 and approaching late must be less than running late. 

fcfs.runningLate

Indicate whether running late thresholds should be configured for Customer shipments with the scheduling type ‘FCFS (first come, first served)’.

True/False

Enter True to enable running late thresholds and tag shipments with #RunningLate.

Enter False to keep running late thresholds disabled.

Note: If fcfs.runningLate is enabled, fcfs.approachingLate must be enabled as well.

fcfs.runningLateDuration

Enter the running late threshold for shipments with the scheduling type FCFS (first come, first served). 

-

Integers only.

Running late value must be more than approaching late. 

shareOperatingCarrier

Indicate whether the Carrier operating the shipment will be shared with the Customer. 

True/False

Enter True to share the Carrier with the Customer, or enter False to not share the Carrier.

 

Filename: group.csv

Field

Description

Available codes

Format/restrictions

id*

Unique system ID used as the identifier for the group. This ID is used anytime you would like to make updates or changes to the group via TDI or when using TDI to associate additional details to the group. If you do not have an existing ID to use in this field, you will need to create one.

-

Important note: ID cannot contain any spaces or special characters.

contextId*

Unique ID of the related Customer. 

-

The ID entered into the id field of the customer.csv.

ID should not contain any spaces or special characters.

groupId*

The Turvo reference ID for the group to establish the mapping.

-

No character restrictions.

Find the reference ID for the respective group in the Group.csv upload sheet.

 

Filename: externalIds.csv

Field

Description

Available codes

Format/restrictions

id*

Unique system ID used as the identifier for the external ID. This ID is used anytime you would like to make updates or changes to the external ID via TDI or when using TDI to associate additional details to the group. If you do not have an existing ID to use in this field, you will need to create one.

-

Important note: ID cannot contain any spaces or special characters.

contextId*

Unique ID of the related Customer. 

-

The ID entered into the id field of the customer.csv.

ID should not contain any spaces or special characters.

type*

The type of external ID.

CRM: crm_id

ERP: erp_id

Project ID: project_id

Contract ID: contract_id

Other: other_id

Enter the appropriate ID type from the list provided. 

value*

The actual letters, numbers, and characters that make up the external ID (Ex: ABC123).

-

No character restrictions.

 

Filename: billing.csv

Field

Description

Available codes

Format/restrictions

id*

Unique system ID used as the identifier for the billing information. If you do not have an existing ID to use in this field, you will need to create one.

-

Important note: ID cannot contain any spaces or special characters.

contextId*

Unique ID of the related Customer. 

-

The ID entered into the id field of the customer.csv.

ID should not contain any spaces or special characters.

toName*

Third party billing information - Enter the name of the business or person payments should be made out to. 

-

No character restrictions.

careOf

Enter the care of (℅) name for the billing contact. 

-

No character restrictions.

address.line1

First line of the billing address.

-

No character restrictions.

address.line2

Second line of billing address for additional information, such as a unit number (if applicable).

-

No character restrictions. 

address.city

Name of city.

-

Address city is required if adding an address to a Customer. 

address.state

Name or abbreviation of state/province. 

-

No character restrictions.

address.zip

Zip code or postal code.

-

No character restrictions.

Must be a valid zip code. (Ex.:, 72748, 72748-9067, M5V 3T4)

address.country

Name of country.

-

No character restrictions. 

phone.number

Enter a billing phone number for the Customer. This will appear under the  Details tab > Billing section.

-

Integers only - No dashes or parentheses.

(Ex.: 3135551500)

phone.extension

The extension of the phone number, if required.

-

Integers only.

A phone number is required to use this field.

phone.country

The phone number’s country code.

Examples:

US: United States

CA: Canada

Enter the two-letter country code found in the Country codes table.

emails

Email address for the billing contact of the Customer account. 

-

Standard email address format.

contactId

Enter Contact ID for the billing contact for this account.

-

No character restrictions. 

Contact ID can be found in the ID column of the contact.csv upload sheet.

creditLimit

Enter the Customer’s credit limit. 

-

Integers only - Decimals allowed.

payTerms

Enter the pay terms for the Customer. 

45 days: 7102

Standard 15 days: 7100

30 days: 7101

Enter the number code corresponding to the correct pay term.

instructions

Any billing instructions for the Customer. 

-

No character restrictions. 

paysUnloading

Indicate whether the Customer pays for the unloading.  

True/False

Enter True if the Customer is paying for unloading or False if they are not. 

invoiceDocuments

Indicate whether documents attached to shipments are required to Invoice the Customer and automatically move the shipment from “Route complete” to “Ready for billing”. 

True/False

Enter True if Invoices should be generated with or without necessary documents attached. Enter False if necessary documents should be attached before generating an Invoice.

autoInvoice

Indicate whether Invoices should be generated automatically for this Customer when a shipment reaches “Ready for billing” status.

True/False

Enter True to enable automatic Invoice generation, or False to keep manual Invoice generation.

isThirdParty

Indicate whether this is a third party billing entity.

True/False

Enter True if it is a third party billing entity, or False if it is not.

 

Was this article helpful?

0 out of 0 found this helpful