Access QuickBooks Data as a Remote Oracle Database



Use the Oracle ODBC Gateway and Heterogeneous Services technology to access QuickBooks data from your Oracle system.

The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for QuickBooks to create a database link from QuickBooks to Oracle and to query QuickBooks data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

About QuickBooks Data Integration

CData simplifies access and integration of live QuickBooks data. Our customers leverage CData connectivity to:

  • Access both local and remote company files.
  • Connect across editions and regions: QuickBooks Premier, Professional, Enterprise, and Simple Start edition 2002+, as well as Canada, New Zealand, Australia, and UK editions from 2003+.
  • Use SQL stored procedures to perform actions like voiding or clearing transactions, merging lists, searching entities, and more.

Customers regularly integrate their QuickBooks data with preferred tools, like Power BI, Tableau, or Excel, and integrate QuickBooks data into their database or data warehouse.


Getting Started


Connect to QuickBooks as an ODBC Data Source

Information for connecting to QuickBooks follows, along with different instructions for configuring a DSN in Windows and Linux environments.

When you are connecting to a local QuickBooks instance, you do not need to set any connection properties.

Requests are made to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines.

The first time you connect, you will need to authorize the Remote Connector with QuickBooks. See the "Getting Started" chapter of the help documentation for a guide.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Note: If you need to modify the DSN or create other QuickBooks DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.

Linux

If you are installing the CData ODBC Driver for QuickBooks in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData QuickBooks Source] Driver = CData ODBC Driver for QuickBooks Description = My Description URL = http://remotehost:8166 User = admin Password = admin123

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Set Connection Properties for Compatibility with Oracle

The driver provides several connection properties that streamline accessing QuickBooks data just as you would an Oracle database. Set the following properties when working with QuickBooks data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.

  • MapToWVarchar=False

    Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.

  • MaximumColumnSize=4000

    Set this property to restrict the maximum column size to 4000 characters.

  • IncludeDualTable=True

    Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.

Linux Configuration

In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-quickbooks/lib/cdata.odbc.quickbooks.ini in a text editor and set the encoding.

cdata.odbc.quickbooks.ini

[Driver] DriverManagerEncoding = UTF-8

Configure the ODBC Gateway, Oracle Net, and Oracle Database

Follow the procedure below to set up an ODBC gateway to QuickBooks data that enables you to query live QuickBooks data as an Oracle database.

  1. Create the file initmyquickbooksdb.ora in the folder oracle-home-directory/hs/admin and add the following setting:

    initmyquickbooksdb.ora

    HS_FDS_CONNECT_INFO = "CData QuickBooks Sys"
  2. Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.

    If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = myquickbooksdb) (ORACLE_HOME = your-oracle-home) (PROGRAM = dg4odbc) ) )

    If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = myquickbooksdb) (ORACLE_HOME = your-oracle-home) (PROGRAM = hsodbc) ) )
  3. Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:

    tnsnames.ora

    myquickbooksdb = (DESCRIPTION= (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521)) (CONNECT_DATA=(SID=myquickbooksdb)) (HS=OK) )
  4. Restart the listener.
  5. Test the configuration with the following command:

    tnsping myquickbooksdb
  6. Open SQL*Plus and create the database link with the command below:

    CREATE DATABASE LINK myquickbooksdb CONNECT TO "user" IDENTIFIED BY "password" USING 'myquickbooksdb';

You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):

SELECT * from "Customers"@myquickbooksdb WHERE Type = 'Commercial';

Ready to get started?

Download a free trial of the QuickBooks ODBC Driver to get started:

 Download Now

Learn more:

QuickBooks Icon QuickBooks ODBC Driver

The QuickBooks ODBC Driver is a powerful tool that allows you to connect with live data from QuickBooks directly from any applications that support ODBC connectivity.

Access QuickBooks data like you would a database - read, write, and update Customers, Transactions, Invoices, Sales Receipts, etc. through a standard ODBC Driver interface.