Skip to main content

Intuit QuickBooks Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from an Intuit QuickBooks location.
intuit_qb_api.png

Intuit QuickBooks

Follow the instructions below to create a new data flow that ingests data from an Intuit QuickBooks source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Intuit QuickBooks connector tile from the list of available connectors. Then, select the credential that will be used to connect to the QuickBooks account, and click Next; or, create a new Intuit QuickBooks credential for use in this flow.

  3. In Nexla, Intuit QuickBooks data sources can be created using pre-built endpoint templates, which expedite source setup for common QuickBooks endpoints. Each template is designed specifically for the corresponding QuickBooks endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Intuit QuickBooks sources can also be configured manually, allowing you to ingest data from QuickBooks endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common QuickBooks endpoints. Each template is designed specifically for the corresponding QuickBooks endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Records of Type

    Returns all records of a specific resource. Use advanced tab for customizing slices of data to be fetched.

    • Enter the QuickBooks Online Company ID (Realm ID) in the QuickBooks Online Company ID/ Realm ID field. This is the unique identifier of your QuickBooks company. You can get it from your Settings >> Account and settings >> Billing & Subscription page, or by clicking Control + Option + ? in your account.
    • Select or enter the type of resource whose records you wish to fetch in the Resource Type field. Available options include Customer, Account, Invoice, CompanyInfo, Bill, Employee, and Vendor. You can also add custom resource types if needed. The default value is Customer if not specified.
    • Enter the API minor version in the API Minor Version field. This determines which minor version of the QuickBooks API you wish to access. The default value is 65 if not specified.
    • The endpoint uses GET requests to https://quickbooks.api.intuit.com/v3/company/{realm_id}/query?query=Select+*+from+{resource_type}+maxresults+1000&minorversion={minorversion} where {realm_id} is the QuickBooks Online Company ID you provide, {resource_type} is the Resource Type you select, and {minorversion} is the API Minor Version you provide. The endpoint URL is automatically constructed based on the QuickBooks API base URL and all the parameters.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $.QueryResponse.{resource_type}[*], which extracts all items from the resource type array in the API response.

    This endpoint retrieves all records of a specific resource type from your QuickBooks account. The endpoint uses a simple SELECT query to fetch all records of the specified resource type, with a maximum of 1000 results per request. You can customize the data to be fetched using the advanced tab. The endpoint supports various resource types including customers, accounts, invoices, company information, bills, employees, and vendors. For detailed information about available resource types and the API response format, see the QuickBooks API documentation.

    Perform Custom Query to Fetch Records

    Perform a query to fetch records from the QuickBooks API.

    • Enter the QuickBooks Online Company ID (Realm ID) in the QuickBooks Online Company ID/ Realm ID field. This is the unique identifier of your QuickBooks company. You can get it from your Settings >> Account and settings >> Billing & Subscription page, or by clicking Control + Option + ? in your account.
    • Enter the query statement to be executed in the Query field. Note that the query can only be run on the resource type. The default value is Select * if not specified. You can specify which fields to select in your query.
    • Select or enter the type of resource whose records you wish to fetch in the Resource Type field. Available options include Customer, Account, Invoice, CompanyInfo, Bill, Employee, and Vendor. You can also add custom resource types if needed. The default value is Customer if not specified.
    • Enter the query filter in the Query Filters field. This is usually a combination of WHERE clauses and maxresults to be fetched. The default value is startposition 0 maxresults 1000 if not specified. You can use WHERE clauses to filter records based on specific conditions.
    • Enter the API minor version in the API Minor Version field. This determines which minor version of the QuickBooks API you wish to access. The default value is 65 if not specified.
    • The endpoint uses GET requests to https://quickbooks.api.intuit.com/v3/company/{realm_id}/query?query={query}+from+{resource_type}+{query_condition}&minorversion={minorversion} where {realm_id} is the QuickBooks Online Company ID you provide, {query} is the Query you provide, {resource_type} is the Resource Type you select, {query_condition} is the Query Filters you provide, and {minorversion} is the API Minor Version you provide. The endpoint URL is automatically constructed based on the QuickBooks API base URL and all the parameters.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $.QueryResponse.{resource_type}[*], which extracts all items from the resource type array in the API response.

    This endpoint allows you to perform custom queries to fetch records from your QuickBooks account. The endpoint supports custom SELECT queries with WHERE clauses and filtering options, giving you full control over which records are retrieved. You can specify which fields to select, filter records based on specific conditions, and control pagination using startposition and maxresults. The endpoint supports various resource types including customers, accounts, invoices, company information, bills, employees, and vendors. For detailed information about query syntax, available resource types, and the API response format, see the QuickBooks API documentation.

Configure Manually​

Intuit QuickBooks data sources can be manually configured to ingest data from any valid QuickBooks API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex QuickBooks sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the QuickBooks API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The QuickBooks API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the QuickBooks API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. QuickBooks API endpoints typically follow the pattern https://quickbooks.api.intuit.com/v3/company/{realm_id}/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires OAuth2 authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The endpoint URL must include your QuickBooks Online Company ID (Realm ID) in the path. For detailed information about QuickBooks API endpoints and available APIs, see the QuickBooks API documentation.