TPI Command Line Parameters – as of 12/22/2009
Did you know you can set your text file, transaction type, and delimiter and other settings when starting the importer? Here are some tips for taken advantage of "hidden" features in the product: (simply edit the shortcut that starts TxnPro and add the following "switches")
To add command line switches, make a copy of the program shortcut and add the custom switches you need in the "target" property of the shortcut
Example: This sets the text file, delimiter, and transaction type in the command line.
1. Right click on the Windows START button on the lower left of your desktop and left click OPEN
2. Double click Programs folder. Double Click the 01 Transaction Pro Importer 3.0 or 4.0 folder.
3. You will see a shortcut named “Transaction Pro Importer 3.0” or “Transaction Pro Importer 4.0”. Make a copy of this folder by clicking Edit/Copy then Edit/Paste.
4. Bring up the properties for this new program shortcut (right click on the shortcut and choose properties)
5. Edit the target from this:
NOTE: If Using TPI 3.0 Substitute “Transaction Pro Importer 3.0.exe” for “Transaction Pro Importer 4.0.exe”
"C:\Program Files\01 Transaction Pro Importer 4.0\Transaction Pro Importer 4.0.exe"
to this:
"C:\Program Files\01 Transaction Pro Importer 4.0\Transaction Pro Importer 4.0.exe" -TEXT_FILE=C:\Program Files\01 Transaction Pro Importer 4.0\Sample Import Files\CREDIT MEMO SAMPLE.TXT -DELIMITER=Tab -TXN_TYPE=Credit Memo
Usage:
To set the file name:
e.g. -TEXT_FILE=C:\My Text File.txt
To Set the delimiter use one of the three values (Comma, Tab, Pipe)
e.g. -DELIMITER=Comma
To Set the transaction type use one of the values from the list
e.g. –TXN_TYPE=Sales Receipt
So for the above example your target would be:
"C:\Program Files\01 Transaction Pro Importer 4.0\
Transaction Pro Importer 4.0.exe” -TEXT_FILE=C:\My Text File.txt -DELIMITER=Comma –TXN_TYPE=Sales Receipt
|
Command Line |
Feature |
Version 2.0 |
Version 3.0 |
Version 4.0 |
|
-ACCTXREF |
Cross reference a code for the Chart of Accounts Description field in QuickBooks |
ü |
ü |
ü |
|
-AUTORUN |
Starts and runs TPI and automatically clicks through all buttons. Interface still loads and shows each step in the wizard. Be sure you have a valid import before enabling this. NOTE: UNSUPPORTED FEATURE. |
ü |
ü |
ü |
|
-AUTORUN –HIDE |
Runs TPI in system tray
with no user interface unless error occurs. NOTE: UNSUPPORTED FEATURE. |
|
ü |
ü |
|
-BILLCOLROW |
When enabled additional fields are available for mapping column values as new expense lines on a bill transaction |
ü |
ü |
ü |
|
-BROWSE_PATH=directory path |
Sets the starting file directory when browsing for an import file or map |
ü |
ü |
ü |
|
-CHECKCOLROW |
When enabled additional fields are available for mapping column values as new expense lines on a check transaction |
|
ü |
ü |
|
-CUST_COMPANY |
Adds Customer “Company Name”, “Customer Type” and “Customer Resale No” to sales transactions. Use to add these fields to field mapping. |
ü |
ü |
ü |
|
-CUSTOMFIELDS |
Adds custom fields to the mapping screen for transaction types that support custom fields. Custom fields in the mapping screen are noted by the following prefixes: cfc- (customer), cfv- (vendor), cfi- (item) |
ü |
ü |
ü |
|
-DEBUG=1 |
Outputs all incoming and outgoing qbXML to a log file in the program folder |
ü |
ü |
ü |
|
-DELIMITER=Comma |
Specify the field delimiter; Comma, Tab, Pipe (text files only) |
ü |
ü |
ü |
|
-EMPLCHECK=1 |
When you specify this startup parameter you will see a new transaction type called "Checks (Employee)". When TPI encounters a payee that doesn't exist it adds it as a new employee. Note that your Payee data column must specify the employee name in First Middle Last Name format. |
ü |
ü |
ü |
|
-EMPLXREF |
Employee Cross Reference. Cross reference a code for the employee number in QuickBooks |
ü |
ü |
ü |
|
-FILE_SOURCE=DSN |
Sets the file source to DSN. If not specified defaults to File. |
|
ü |
ü |
|
-ITEMACCT |
Adds “Item Account” to the Invoice transaction map. Allows you to specify the account that each item gets added as if it doesn’t exist in QuickBooks. |
ü |
ü |
ü |
|
-ITEMXREF=Item Custom Field name that stores cross reference value
Example –ITEMXREF=My Custom Field |
Item cross reference. If your import file contains an item name that doesn’t match the item name in QuickBooks, you can store the matching item name in a item custom field. When this option is enabled TPI will lookup and replace the item name from the import file with the proper name in the QB item list. If no match is found a blank value is returned in the mapped field grid. Exceptions are outputted to the program directory to the file named “Item Cross Reference Exception File.txt”
|
ü |
ü |
ü |
|
-JE_DEBITCREDIT |
Added new option switch for importing Journal Entries with a single column for both debits and credits. You can now enable a command line switch to change the mapping in TPI so you only have to map to a single column for the amount. Previously you had to have your debits and credits in separate columns. |
ü |
ü |
ü |
|
-JE_NAME |
Adds additional fields to specify the entity type in the Journal Entry “Name” column. In “JE Name Type” specify C for Customer, V for Vendor, E for Employee, O for Other Name. |
|
ü |
ü |
|
-JE_OFFSET_ACCOUNT=Account Name or Number |
When set will balance out of balance journal entry imports to this account. |
|
ü |
ü |
|
-LOG_FILE=full file path and file name
Example: -LOG_FILE=c:\mydir\ |
Override
the default log file location that is created when specifying the –AUTORUN
command line. File name cannot be changed and is always |
|
ü |
ü |
|
-MAP_FILE=full file path and file name
Example: -MAP_FILE=c:\mymap.dat |
Set map file path |
ü |
ü |
ü |
|
-NON_US_ARACCOUNT |
Non US Versions of QuickBooks – Adds AR Account map field for Invoice and Credit Memo transaction types. |
ü |
ü |
ü |
|
-NOREQ |
Bypass all required fields in mapping |
ü |
ü |
ü |
|
-QB_COMPANY_PATH=full file path and file name |
Set QuickBooks file name to work with. Requires Integrated app preference in QB file to be set to “Allow this company to login automatically” |
|
ü |
ü |
|
-RECORD_TERM=CRLF |
Sets the record terminator to the value specified. Valid value are CR or CRLF or LF |
ü |
ü |
ü |
|
-RECPAY2 |
Changes the functionality of the Receive Payment import such that by specifying repeating rows with the same check number TPI will allow you to apply to multiple invoices. Supply the check number, invoice number and amount to apply. |
ü |
ü |
ü |
|
-RECPAY3 |
Changes the functionality of the Receive Payment import so a customer is not required. Matching of payment to invoice is done by invoice number only. |
|
ü |
ü |
|
-RECPAY_AUTOAPPLY |
A new mapping field "Auto Apply" will appear. Setting the field blank to N will force QuickBooks to not apply the payment. Putting a Y in the field will tell QuickBooks to auto-apply the payment. |
|
ü |
ü |
|
-TEXT_FILE=full file path and file name
Example: -TEXT_FILE=c:\myfile.txt |
Set import file path |
ü |
ü |
ü |
|
-TIME_RATE |
When enabled the Rate field is added to the time tracking mapping. When a rate is supplied TPI looks up and either adds or updates the rate for the matching Payroll Item. If the payroll item doesn’t exist TPI adds it using the rules below:
Payroll Item – payroll item name you want to create (if left blank then no new payroll item is created and the other fields are ignored) WageExpenseAccount – optional but if left blank assumes expense account “Payroll Expenses” WageType – use one of the following values (if blank assumes HourlyRegular)
|
ü |
ü |
ü |
|
–TXN_TYPE=Sales Receipt |
Sets transaction type. Specify a name from the transaction type list |
ü |
ü |
ü |
|
-USE_AMOUNT |
User can now specify Amount rather than price on line items. Use the following command line switch to enable |
ü |
ü |
ü |
|
-USE_MC |
Enables multi-currency fields for UK 2005-2006 |
|
|
ü |
|
-XL_SHEET |
Sets the sheet to use within an Excel file. Also works to set the database object name in 3.0/4.0 |
ü |
ü |
ü |