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 and Parent entities first. Some columns within the Factor 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 factor accounts to their respective 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 Factor accounts, it will provide the contact IDs necessary for the primaryContact column in factor.csv. If this is not the case, uploading the Contact entity later and assigning contacts to Factor accounts at that time is recommended.
Important note: Fields bolded and marked with an asterisk (*) are mandatory.
Filename: factor.csv
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
id* |
Unique system ID for the entity. This ID is used anytime you would like to make updates or changes to the Factor in TDI or when using TDI to associate additional details to the Factor. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot not contain spaces or special characters. |
name* |
The name of the factoring company. |
- |
Required. |
Duplicates are not allowed. No character restrictions. |
parentAccount |
Enter the Parent account ID if you would like to associate the Factor with a Parent account. |
Find the reference ID for the respective Parent account in the ID column of the Parent.csv upload sheet. |
- |
Must match the Parent account's ID exactly, if entered. |
status.code |
The status of the Factor indicates whether it can be used when billing shipments. |
Created: 2350 Active: 2352 Inactive: 2353 Prospect: 2354 |
Factors currently in use should be uploaded in Active status. This can be changed on the Details tab of the Factor profile in Turvo. |
Enter the four-digit code from the Values/Codes column to indicate the correct status. |
status.notes |
Notes related to or explaining the above status can be entered here. |
- |
- |
No character restrictions. |
url |
The Factoring company’s website address. |
- |
- |
No character restrictions. |
primary |
Enter the contact ID of the primary contact for the Factor. |
If the Contact entity was uploaded before the Factor entity, contact IDs can be found in the ID column of the contact.csv spreadsheet. |
If the Contact entity was not uploaded before the Factor entity, leave blank. |
Must match the parent contact ID exactly, if entered.
|
owner.id |
Enter the unique ID for the internal User who is the primary point of contact for this Factor. |
Owner IDs can be found in the ID column of the users.csv spreadsheet. |
- |
Must match the parent user ID exactly, if entered.
|
Filename : communication_channel.csv
Note: If the Factor accounts added via the factor.csv file only include one set of contact information for each column, this file is not required. If a factor has multiple addresses, phone numbers, email addresses, etc., that need to be associated with it, treat this file as required.
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
id* |
This serves as the unique ID for the row in this upload sheet where a communication channel is connected to a Factor account. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot not contain spaces or special characters. |
contextId* |
This ID corresponds to the Factor that this communication method should be associated with. |
Find and enter the reference ID for the Factor in the ID column of the factor.csv upload sheet. |
Required. |
Must match the Factor account's ID exactly. |
email.type |
The type of email (work, home, etc.) associated with the factor’s communication channel. |
Main email: 1090 Other email: 1091 Billing email: 1092 |
Required if entering an email address for the factor’s communication channel. |
Enter one of the four-digit codes listed in the Values/Codes column. |
|
The email address associated with the factor account. |
- |
- |
Standard email address format. |
phone.type |
Type of phone number (work, home, etc.) |
Main phone: 1031 Fax: 1034 Other phone: 1035 After hours phone: 1037 Billing phone: 1036 |
Required if entering a phone number for the factor’s communication channel. |
Enter one of the four-digit codes listed in the Values/Codes column. |
phone |
Factor’s phone number. |
- |
- |
Integers only. No dashes or parentheses. (Ex.: 3135551500) |
phone.extension |
Phone extension (if applicable). |
- |
Applicable only if entering a phone number for the factor’s communication channel. |
Integers only. |
phone.country |
Phone number country of origin. |
Enter the two-letter country code found in the Country codes table. |
- |
Examples: US CA |
address.type |
Identifies whether this is a work, home, or other kind of address. |
Main address: 1170 Other address: 1171 Billing address: 1172 |
Required if entering an address. |
Enter the corresponding code to indicate the type of address. |
address.line1* |
The first line of address associated with the factor's communication channel. |
_ |
Addresses are required for all factor communication channels. |
No character restrictions. |
address.line2 |
The second line of the address (if applicable). |
- |
- |
No character restrictions. |
address.city* |
The name of the address's city. |
- |
Required. |
No character restrictions. |
address.state* |
The name or abbreviation of the address's state/province. |
- |
Required. |
No character restrictions. Examples: CA California |
address.zip* |
Zip code or postal code. |
- |
Required. |
Must be a valid zip code. Examples: |
address.country |
Name of country. |
Enter the name of the country, not the country code. |
- |
No character restrictions. |
isPrimaryAddress |
Indicate whether this is the primary address for the User. |
True/False |
- |
Enter True if this is the primary address and False if it is not. |
isPrimaryEmail |
Indicate whether this is the primary email address for the User. |
True/False |
- |
Enter True if this is the primary email and False if it is not. |
isPrimaryPhone |
Indicate whether this is the primary phone number for the user. |
True/False |
- |
Enter True if this is the primary phone and False if it is not. |
Filename : payment_method.csv
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
id* |
This serves as the unique ID for the row in this upload sheet where a payment method is connected to a Factor account. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot not contain spaces or special characters. |
contextId* |
This ID corresponds to the Factor that this payment method should be associated with. |
Find and enter the reference ID for the Factor in the ID column of the factor.csv upload sheet. |
Required. |
Must match the Factor account's ID exactly. |
type.code* |
Indicates the payment method type. |
Paper check: 1700 COMCHEK: 1701 ACH: 1702 Factoring company: 1703 EFS: 1704 Wire: 1705 |
Required. Only one method is supported per Factor. |
Enter the corresponding four-digit code for the type of payment method, as listed in the Values/Codes column. |
payTo |
Enter the name of the business or person checks and payments should be made out to. |
- |
Applicable only if the type.code field contains the code for Paper check, ACH, or Wire. |
No character restrictions. |
bankName |
Enter the name of the “payto” entity’s bank. |
- |
Required when entering information into the payto column. Applicable only if the type.code column contains the code for ACH or Wire. |
No character restrictions. |
routingName |
Routing number for the “payto” entity bank account. |
- |
Applicable only if the type.code column contains the code for ACH or Wire. |
No character restrictions. |
accounting |
Bank account number for the “payto” entity. |
- |
Applicable only if the type.code column contains the code for ACH or Wire. |
No character restrictions. |
accountingType. |
Indicates the account type, whether Savings or Checking. |
Savings: 1751 Checking: 1752 |
Applicable only if the type.code column contains the code for ACH or Wire. |
Enter the corresponding four-digit code for the type of account, as listed in the Values/Codes column to the left. |
address.line1 |
First line of address. |
_ |
Required if the type.code column contains the code for Paper check. |
No character restrictions. |
address.line2 |
Second line of address (if applicable). |
_ |
|
No character restrictions. |
address.city |
Name of city. |
_ |
Required if the type.code column contains the code for Paper check. |
No character restrictions. |
address.state |
Name or abbreviation of state/province. |
_ |
Required if the type.code column contains the code for Paper check. |
No character restrictions. |
address.zip |
Zip code or postal code. |
_ |
Required if the type.code column contains the code for Paper check. |
No character restrictions. |
address.country |
Name of country. |
Enter the name of the country, not the country code. |
Required if the type.code column contains the code for Paper check. |
No character restrictions. |
Filename : externalids.csv
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
id* |
This serves as the unique ID for the row in this upload sheet where an external ID is added to the Factor account. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot not contain spaces or special characters. |
contextid* |
This ID corresponds to the Factor that this external ID should be associated with. |
Find and enter the reference ID for the Factor in the ID column of the factor.csv upload sheet. |
Required. |
Must match the Factor account's ID exactly. |
type* |
If you maintain a separate database with unique ID numbers corresponding to factoring companies, enter the type of external system or database here. |
CRM ID: crm_id ERP ID: erp_id Project ID: project_id Contract ID: contract_id Other: other_id |
Required. |
Enter the one of the values listed in the Values/Codes column to the right. If the type is CRM, enter "crm_id" (without quotations). |
value* |
The actual external ID to be added to the Factor’s profile in Turvo. This allows you to see additional IDs in Turvo and easily use those to search in external databases. |
- |
Required. |
No character restrictions. |
Filename : user_commissions.csv
Field |
Description |
Values/codes |
Conditions |
Format/restrictions |
id* |
Unique system ID for the TDI upload of User commissions. |
If you do not have an existing ID to use in this field, you will need to create one. |
Required. |
IDs cannot not contain spaces or special characters. |
contextId* |
This ID corresponds to the Factor that this User should be associated with to earn commission. |
Find and enter the reference ID for the Factor in the ID column of the factor.csv upload sheet. |
Required. |
Must match the Factor account's ID exactly. |
user* |
This ID corresponds to the User receiving commission from this Factor. |
Find and enter the reference ID for the User in the ID column of the user.csv file. |
Required. | No character restrictions. |
user.Commission* |
Indicates the commission percentage that the User should receive for shipments with this Factor. |
- |
Required. |
Enter the percentage as a decimal value. Example: If the user's commission is 5%, enter 0.05. |