QuickBooks Ingestion Source

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium QuickBooks connector.

In Gathr, it can be added as a channel to help in fetching customers’ and prospects’ data and transform it as needed before storing it in a desired data warehouse to run further analytics.

Data Source Configuration #

Configure the data source parameters as explained below.

Fetch From Source/Upload Data File #

To design the application, you can either fetch the sample data from the QuickBooks source by providing the data source connection details or upload a sample data file in one of the supported formats to see the schema details during the application design phase.

Upload Data File #

To design the application, please upload a data file containing sample records in a format supported by Gathr.

The sample data provided for application design should match the data source schema from which data will be fetched during runtime.

If Upload Data File method is selected to design the application, provide the below details.

File Format #

Select the format of the sample file depending on the file type.

Gathr-supported file formats for QuickBooks data sources are CSV, JSON, TEXT, Parquet and ORC.

For CSV file format, select its corresponding delimiter.

Header Included #

Enable this option to read the first row as a header if your QuickBooks sample data file is in CSV format.

Upload #

Please upload the sample file as per the file format selected above.

Fetch From Source #

If Fetch From Source method is selected to design the application, then the data source connection details will be used to get sample data.

Continue to configure the data source.

Connection Name #

Connections are the service identifiers. A connection name can be selected from the list if you have created and saved connection details for QuickBooks earlier. Or create one as explained in the topic - QuickBooks Connection →

Use the Test Connection option to ensure that the connection with the QuickBooks channel is established successfully.

A success message states that the connection is available. In case of any error in test connection, edit the connection to resolve the issue before proceeding further.

Entity #

Tables in QuickBooks are statically defined to model QuickBooks entities.

If you selected the Fetch From Source method to design the application, the Entities will list as per the configured connection. Select the entity to be read from QuickBooks.

If you selected the Upload Data File method to design the application, the exact name of the entity should be provided to read the data from QuickBooks.

If you selected the Fetch From Source method to design the application, the Fields would list as per the Entity chosen in the previous configuration parameter. Select the fields or provide a custom query to read the desired records from QuickBooks.

Fields #

The conditions to fetch source data from a QuickBooks table can be specified using this option.

Select Fields: Select the column(s) of the entity that should be read.

Custom Query: Provide an SQL query specifying the read conditions for the source data.

Example: SELECT "Id" FROM Companies

If you selected the Upload Data File method to design the application, provide a custom query to fetch records from the QuickBooks entity specified in the previous configuration.

Query #

The conditions to fetch source data from a QuickBooks table can be specified using this option.

Provide an SQL query specifying the read conditions for the source data.

Example: SELECT "Id" FROM Companies

Read Options #

This section contains additional configuration parameters.

Custom Field Mode #

How custom fields should display.

Possible Values: XML, JSON

XML is the traditional way of displaying custom fields and will be compatible with older implementations. However, JSON is more compact and may be more appropriate if the values are being saved to a database or other tool that cannot easily traverse the XML structure.

Page size #

The maximum number of results to return per page from QuickBooks.

Include Line Items #

Whether or not to request Line Item responses from QuickBooks when retrieving a base transaction, such as Invoices.

This will not affect Line Item tables, only base transaction tables.

Include Linked Txns #

Whether or not to request Linked Transactions from QuickBooks when retrieving a base transaction, such as Invoices.

This will not affect Linked Transaction tables, only base transaction tables.

Partitioning #

This section contains partitioning-related configuration parameters.

Enable Partitioning #

This enables parallel reading of the data from the entity.

Partitioning is disabled by default.

If enabled, an additional option will appear to configure the partitioning conditions.

Column #

The selected column will be used to partition the data.

Max Rows per Partition: Enter the maximum number of rows to be read in a single request.

Example: 10,000

It implies that a maximum number of 10,000 rows can be read in one partition.

Fetch Size #

The number of rows to be fetched per round trip. The default value is 1000.

Add Configuration: Additional properties can be added using this option as key-value pairs.

Schema #

Check the populated schema details. For more details, see Schema Preview →