Rightworks Transaction Pro Importer Command Line Codes

Feb 19, 2024

2240

Rightworks Transaction Pro Importer Command Line Codes

Some additional features exist for Transaction Pro Importer that are not included with the standard installation. These additional features can be accessed by adding Command Line Codes to the Transaction Pro properties. For more information about how to add a Command Line Code, please reference THIS ARTICLE.

The chart below explains the additional features that are available for Importer, with which import type the feature will work, and for which version of Importer the feature is available. In addition, there is a download file attached to this article on either the right-hand side or below the article (depending on browser) that also contains this information.

Command Line	Use with Import Type	Feature	V6	V7	V8
/ADDR_LINE5	Bill, Check, Credit Card Charge, Credit Card Credit, Credit Memo, Customer List, Estimate, Invoice, Purchase Order, Sales Order, Sales Receipt, and Vendor Credit	Adds an Address Line 5 field for the addresses on the mapping.	✔	✔	✔
/BILLCOLROW	Bill	Enables columns as rows for expenses on a Bill import. If the OPTION is selected in TPro, it allows for 16 columns to be imported. If additional columns are needed, the command code can be used to specify the number of columns by adding =xx to the end of the command line, where xx equals the number of columns to needed. EXAMPLE: /BILLCOLROW=20 would allow for 20 columns to be imported	✔	✔	✔
/CHECKCOLROW	Check	Enables columns as rows for expenses on a Check import. By default, it allows for 16 columns to be imported. If additional columns as needed, specify the number of columns by adding =xx to the end of the command line, where xx equals the number of columns to needed. EXAMPLE: /CHECKCOLROW=20 would allow for 20 columns to be imported	✔	✔	✔
/CREDITCARDCOLROW	Credit Card Charge and Credit Card Credit	Enables columns as rows for expenses on a Credit Card Charge and a Credit Card Credit import. By default, it allows for 16 columns to be imported. If additional columns as needed, specify the number of columns by adding =xx to the end of the command line, where xx equals the number of columns to needed. EXAMPLE: /CREDITCARDCOLROW=20 would allow for 20 columns to be imported	✔	✔	✔
/EMPLCHECK=1	Check	When you specify this startup parameter you will see a new transaction type called CHECKS (EMPLOYEES). When Importer encounters a Payee that does not exist, it adds it as a new Employee. Note that the Payee data column must specify the Employee name in First Middle Last Name format.	✔	✔
/EMPLXREF	Time Tracking	Employee Cross Reference. Cross reference the code in the Employee Number field in QB. If importing checks, the command line /EMPLCHECK=1 must also be specified.	✔	✔	✔
/EXPENSES_CUSTOMER_NO_ADD	Bill, Check, and Vendor Credit	Prevents a new Customer from being setup automatically on Bill, Check, and Vendor Credit imports when the Customer specified for the expense does not already exist in QB.	✔	✔	✔
/INVOICECREDITMEMO	Invoice and Credit Memo	Creates a new transaction type INVOICE CREDIT MEMO that allows both Invoices and Credit Memos to be imported within the same file. A column must be included in the import file to specify I for Invoice or C for Credit Memo for each row. The amounts for both types of transactions should be positive numbers.	✔	✔	✔
/INVOICESO=1	Invoice and Sales Order	Creates a new transaction type INVOICE LINK SALES ORDER that allows imported Invoices can be linked to existing Sales Orders. A valid Sales Order RefNumber is required.	✔	✔	✔
/ITEMACCT	Invoice	Adds ITEM ACCOUNT field to the mapping screen. Allows an Account to be specified for an Item that will be setup "on the fly" during the import that is different than the Account specified on the last screen of Importer. Works for SERVICE, OTHER CHARGE, and NON-INVENTORY PART types. The type will be determined by the setting on the last screen of Importer.	✔	✔	✔
/ITEMNON_USE_INCOME_ACCT	All	Opens the Income Account field on the final screen of Importer for NON-INVENTORY PART. With this option, the Account field will import as the Expense Account for any new Non-Inventory Parts created during import.	✔	✔	✔
/JE_NAME	Journal	Allows Importer to create new names during import. It will also allow Importer to be told to which list the new name should be added.			✔
/NO_COA	All	Stops Importer from loading the Chart of Accounts from QB. Suggested to be used when QB company file has Chart of Accounts greater than 5000 accounts. Must be used with the appropriate /NO_COA account setup for the final screen below.	✔	✔	✔
/NO_COA_ACCT=account name or number Example: /NO_COA_ACCT=Sales	All	To be used with /NO_COA to specify the ACCOUNT on the final screen of Importer when Item type is SERVICE, OTHER CHARGE, or NON-INVENTORY PART.	✔	✔	✔
/NO_COA_COGS_ACCT=account name or number Example: /NO_COA_COGS_ACCT=Cost of Goods Sold	All	To be used with /NO_COA to specify the COGS account on the final screen of Importer when Item type is INVENTORY PART.	✔	✔	✔
/NO_COA_INCOME_ACCT=account name or number Example: /NO_COA_INCOME_ACCT=Sales	All	To be used with /NO_COA to specify the Income account on the final screen of Importer when Item type is INVENTORY PART.	✔	✔	✔
/NO_COA_ASSET_ACCT=(Account Name or Number)	All	To be used with /NO_COA to specify the Asset account on the final screen of Importer when Item type is INVENTORY PART. EXAMPLE: /NO_COA_ASSET_ACCT=Inventory	✔	✔	✔
/NON_US_ARACCOUNT	Invoice and Credit Memo	Non US Versions of QB – Adds AR Account map field for Invoice and Credit Memo transaction types.	✔	✔	✔
/NOREQ	All	Bypass all required fields in mapping.	✔	✔	✔
/RECINTEGER	Receive Payment	Changes the Receive Payment import to search first by Customer and then find the matching Invoice. This is a workaround for the QBSDK integer limitation and should only be used if an issue exists with Importer not finding a matching Invoice number due to large integer limitations (Invoice numbers greater than 2147483647).	✔	✔	✔
/RECPAY2	Receive Payment	Allows the same Check number to be applied to multiple Invoices for the same Customer and only show as one Payment on the Customer's account. Cannot be used with /RECPAY3.	✔	✔	✔
/RECPAY3	Receive Payment	Removes the requirement of the Customer name for a Payment import and applies the Payment by the Invoice number only. Cannot be used with /RECPAY2.	✔	✔	✔
/RECPAY_AUTOAPPLY	Receive Payment	Adds a new mapping field AUTO APPLY. Setting the field blank to N will force QB to not auto-apply the Payment. Putting a Y in the field will tell QB to auto-apply the Payment.	✔	✔	✔
/SMALL_QUERY	All	Use only for troubleshooting memory issue when Customers or Accounts exceed 10,000. With this command code, Importer retrieves lists in smaller batches to reduces size of XML response.	✔	✔	✔
/USE_AMOUNT	Bill, Check, Credit Memo, Estimate, Invoice, Invoice Credit Memo, Sales Order, Sales Receipt, and Vendor Credit	Allows user to specify Amount rather than Price on Line Items on indicated transaction import types.	✔	✔	✔

In addition, there are some OPTIONS in Importer that can either be selected manually within the application by clicking the OPTIONS button on the first window of Importer or a Command Line Code can be used to preset these options or to set options with an automated import.

The chart below explains these options, with which import type the option will work, and for which version of Importer the option is available. In addition, there is a download file attached to this article on either the right-hand side or below the article (depending on browser) that also contains this information.

Command Line	Use with Import Type	Feature	V6	V7	V8
/ACCTXREF	Bank Statement, Bill, Check, Credit Card Charge, Credit Card Credit, Credit Card Statement, and Vendor Credit	Cross reference an Account Name with the Account description field in QB.	✔	✔	✔
/ALIAS_FILE	Bank Statement, Bill, Bill Payment, Credit Card Charge, Credit Card Credit, Credit Card Statement, Inventory Adjustment, Item Receipt, Item Receipt w/Bill, Journal Entry, and Vendor Credit	Set alias file path.	✔	✔	✔
/AUTO_ASSIGN=1	Credit Memo, Estimate, Invoice, Journal Entry, Purchase Order, Sales Order, and Sales Receipt	Ability to check or uncheck Auto Assign transaction numbers. /AUTO_ASSIGN=1 to check the box /AUTO_ASSIGN=0 to uncheck the box	✔	✔	✔
/AUTORUN	All	Starts and runs Importer and automatically proceeds through all screen. Interface still loads and shows each step in the wizard. Be sure import and settings are valid before enabling this feature. NOTE: UNSUPPORTED FEATURE NOTE: When using with Version 8, you must add /ACTIVATED before /AUTORUN if using as a bat file to launch a specific application. See this ARTICLE for more information.	✔	✔	✔
/AUTORUN /HIDE	All	Runs Importer in system tray with no user interface unless error occurs. Be sure import and settings are valid before enabling this feature. NOTE: UNSUPPORTED FEATURE NOTE: When using with Version 8, you must add /ACTIVATED before /AUTORUN if using as a bat file to launch a specific application. See this ARTICLE for more information.	✔	✔	✔
/BROWSE_PATH=(directory path)	All	Specifies the starting file directory when browsing for an import file or map.	✔	✔	✔
/CUST_COMPANY	Credit Memo, Estimate, Invoice, Sales Order, and Sales Receipt	Adds the fields COMPANY NAME, CUSTOMER TYPE, and CUSTOMER RESALE NO to the mapping for all Sales transactions.	✔	✔	✔
/CUSTOMFIELDS	Credit Memo, Customer List, Employee List, Estimate, Invoice, Item Assembly, Item Group, Item List, Sales Order, Sales Receipt, and Vendor List	Adds custom fields to the mapping screen for list and transaction types that support custom fields as allowed by QB. Custom fields in the mapping screen are noted by the following prefixes: cfc- (customer), cfv- (vendor), and cfi- (item).	✔	✔	✔
/DEBUG=1	All	Outputs all incoming and outgoing qbXML to a log file in the program folder.	✔	✔	✔
/DELIMITER=Comma	All	Specifies the Field Delimiter: COMMA, TAB, or PIPE (text files only).	✔	✔	✔
/FILE_SOURCE=DSN	All	Sets the file source to DSN. If not specified, defaults to File.	✔	✔	✔
/ITEMXREF=(Item Custom Field name that stores cross reference value)	Bill, Check, Credit Card Charge, Credit Card Credit, Credit Memo, Estimate, Inventory Adjustment, Invoice, Item Receipt, Item Receipt w/Bill, Purchase Order, Sales Order, Sales Receipt, and Vendor Credit	Item cross reference. If the import file contains an Item name that does not match the Item name in QB, a cross reference name can be stored in an Item Custom Field. When this option is enabled, Importer will lookup and replace the Item name from the import file with the correct Item Name in the QB Item list. The Item and cross reference value must be setup in QB prior to importing. Example /ITEMXREF=My Custom Field	✔	✔	✔
/JE_DEBITCREDIT	Journal Entry	Allows Journal Entries to be imported with Debits and Credits in a single column. Positive numbers will import as Debits and negative numbers will import as Credits.	✔	✔	✔
/JE_OFFSET_ACCOUNT=(Account Name or Number)	Journal Entry	If Journal Entry is out of balance, QB will post the amount necessary to balance the entry to this Account. Example /JE_OFFSET_ACCOUNT=Ask My Accountant	✔	✔	✔
/LOG_ERROR	All	Creates a troubleshooting log file of all XML based communications with the QB file. Use for troubleshooting only.	✔	✔	✔
/LOG_FILE=(drive and directory name)	All	Override the default log file location that is created when specifying the /AUTORUN command line. File name cannot be changed and is always TPI Log – yyyy-mm-dd-hhmmss.txt Example /LOG_FILE=c:\mydir\	✔	✔	✔
/MAP_FILE=(full file path and file name)	All	Specify the location of the map file for the import. Example /MAP_FILE=c:\mymap.dat	✔	✔	✔
/QB_COMPANY_PATH=(full file path and file name)	All	Specifies the QB company file into which to import. Requires the Integrated App Preference in the QB company to be set to ALLOW THIS COMPANY TO LOGIN AUTOMATICALLY.	✔	✔	✔
/RECORD_TERM=CRLF	All	Sets the record terminator to the value specified. Valid values are CR, CRLF, or LF.	✔	✔	✔
/TEXT_FILE=full file path and file name	All	Specifies the location of the import file. Example /TEXT_FILE=c:\myfile.txt NOTE: For DSN connections, use the contents of the text box to the left of the Connect button.	✔	✔	✔
/TXN_TYPE=(transaction type)	All	Sets transaction type to import. Specify a name from the transaction type list. Example /TXN_TYPE=Sales Receipt	✔	✔	✔
/XL_SHEET=(Excel sheet name)	All	Selects the sheet to use within an Excel file. Also works to set the database object name. Example /XL_SHEET=Sheet 2	✔	✔	✔

Tags

Attachments