- Starter
- Business
- Enterprise
- On-Premise
- Add-on
Overview
Etlworks Quickbooks Online connector allows the fastest and easiest way to connect to real-time Quickbooks Online data. The connector works just like any other connector for connected app.
Etlworks partnered with CData to provide access to Quickbooks Online using industry-standard JDBC protocol. Read about CData Quickbooks Online JDBC connector.
When to use Quickbooks Online connector
Use this connector to create Flows that extract data and load data into Quickbooks Online.
Alternative: Free API Connector
In addition to this native connector, Etlworks also offers a generic API Connector that can be used to connect to this platform via its public API. The API connector is free and is a good alternative when the native connector doesn’t support a specific feature or if you prefer working directly with the API.
Prerequisites
- Enable the Quickbooks Online connector for your Etlworks account. Contact support@etlworks.com to enable the connector.
- Create connected app.
Create connected app under your account
Step 1. Set up your developer account
Go to the Intuit Developer Portal and create a developer account.
Step 2. Create an app on the Intuit Developer Portal
The apps you create on our developer portal generate unique credentials and info you’ll need during connection creation.
- Sign in to your developer account.
- Select My Hub > App dashboard from the upper-right corner of the toolbar.
- Select the app card with a + to create a new app.
- Follow the on-screen steps.
When you create apps, you’ll pick your app’s scopes. Scopes limit the type of data your app can access. If your app only needs access to accounting data, select the accounting scope. If it also needs to access payment data, also select the payments scope.
You also need to specify
Note: accounting scope has to be included since it is requested by Etlworks connector by default and cannot be removed.
By default newly created app is a Development app and can only connect to sandbox account. If you need to access you production account data, update your app to Production app.
- Select Keys & Credentials from the left navigation pane.
- Switch Development to Production.
- Complete provided list of tasks in any order to unlock your production credentials.
Step 3. Configure Redirect URIs.
- Select Settings from the left navigation pane.
- Select Redirect URIs tab.
- Replace default URI or click on Add URI to add new one
- It should be equal to Etlworks instance domain name with protocol plus /rest/v1/io/oauth/quickbooks/callback.
- Example: https://app.etlworks.com/rest/v1/io/oauth/quickbooks/callback
Step 3. Copy App credentials.
- Select Keys and credentials from the left navigation pane.
- If you’re connecting a sandbox company, choose Development and turn on the Show credentials switch.
- If you’re setting up a production app, choose Production and turn on the Show credentials switch.
- Copy the Client ID and Client secret.
Create a Connection
You can create a Connection in just two steps, and they are the following:
Step 1. In the Connections window, click +, and type in quickbooks online.
Step 2. Enter Connection parameters:
- App ID: enter Client ID from Create connected app section.
- App Secret: enter Client secret from Create connected app section.
- OAuth Scopes: select one or multiple OAuth scopes.
- OAuth Token: connect to QuickBook.
Use Other Parameters to specify the Connection string options. Read about available Connection string options.
Work with Quickbooks Online
Quickbooks Online Data Model
The connector models entities in the QuickBooks Online API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.
API limitations and requirements are documented in the following sections; you can use the SupportEnhancedSQL feature, set by default to circumvent most of these limitations.
Read about the data model.
Stored procedures
Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the data retrieval is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return a dataset that contains the collection of tuples that constitute the response.
Read about available stored procedures in the data model.
To call stored procure from the SQL Flow or Before/After SQL, use EXEC sp_name params=value.
Example:
EXECUTE my_proc @second = 2, @first = 1, @third = 3;SQL Compliance
The connector supports several operations on data, including querying, deleting, modifying, and inserting.
Read about SQL Compliance.
Extract data from Quickbooks Online
Note: Extracting data from Quickbooks Online is similar toextracting data from the relational database.
Here are the steps on how you can extract data from Quickbooks Online:
Step 1. Create Quickbooks Online Connection which will be used as a source (FROM).
Step 2. Create a destination Connection, for example, a Connection to the relational database, and if needed, a Format (Format is not needed if the destination is a database or well-known API).
Step 3. Create a Flow where the source is a connected app, and the destination is a Connection created in step 2, for example, a relational database.
Step 4. Add a new source-to-destination transformation.
Step 5. Select the Quickbooks Online Connection created in step 1 as a source Connection and select the data object you are extracting data from.
Step 6. Select TO Connection, Format (if needed), and object (for example, database table) to load data into.
Step 7. Click MAPPING and optionally enter Source query (you don't need a query if you are extracting data from the Quickbooks Online data object unconditionally).
Step 8. Optionally define the per-field Mapping.
Step 9. Add more transformations if needed.
Load data in Quickbooks Online
Note: Loading data in Quickbooks Online is similar toloading data into a relational database.
Here are the steps on how you can load data in Quickbooks Online:
Step 1. Create a source Connection and a Format (if needed).
Step 2. Create a destination Quickbooks Online Connection.
Step 3. Create a Flow where the destination is a connected app.
Step 4. Add new source-to-destination transformation.
Step 5. Select FROM and TO Connections and objects (also a FROM Format if needed).
Step 6. Optionally define the per-field Mapping.
Step 7. Add more transformations if needed.
Browse data in Quickbooks Online
You must have Quickbooks Online Connection to browse objects and run SQL queries.
Use the Etlworks Explorer to browse data and metadata in Quickbooks Online as well as execute DML and SELECT queries against the Quickbooks Online Connection.