Skip to main content

QuickBooks Online Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

QuickBooks Online is a cloud-based accounting software for businesses, offering financial management tools like expense tracking, invoicing, and payroll. Features are tailored to self-employed individuals and larger companies. It provides easy bank integration, customizable reports, and helps businesses efficiently manage their financial operations.

The QuickBooks Online Reader connects to the QuickBooks Online platforms and reads supported objects.

Feature summary

Feature

Supported?

Notes

Objects

Standard objects

✓

Custom objects

✓

Authentication

Basic authentication

Username and password

OAuth authentication

✓

Manual configuration based

Custom authentication methods

Not all methods may be supported

Operations

Automated mode

✓

Initial load

✓

Pull-based incremental load

✓

Push-based incremental load

Automated pipeline

Governance

Connection profile

Sherlock AI

Sentinel AI

Schema handling

Initial schema creation

✓

Works with supported targets

Schema evolution

Setup

Wizard template

Flow Designer

✓

Striim TQL

✓

Runtime

Resilience/recovery

✓

Parallel execution

Metrics

✓

Standard metrics

Supported authentication method

The QuickBooks Online Reader supports OAuth authentication. Creating a connection requires creating an application in your Intuit Developer account, obtaining OAuth credentials from the portal, and setting connection properties.

To create a connection using OAuth authentication:

  1. Access the Intuit Developer portal at https://developer.intuit.com.

  2. Log in to your Intuit Developer account.

  3. Create an application:

    1. Navigate to My Apps and choose Create an app.

    2. Select QuickBooks Online and Payments.

    3. Enter an app name.

    4. Choose appropriate scopes (Accounting, Payments).

  4. Retrieve the credentials:

    1. In the app dashboard, go to the Keys & OAuth section.

    2. Find your Client ID and Client secret.

    3. Verify your email and complete your account profile to unlock your production keys.

Sample authorization code request

curl -X GET \ "https://appcenter.intuit.com/connect/oauth2" \ -d "client_id=YOUR_CLIENT_ID" \ 
-d "response_type=code" \ -d "scope=com.intuit.quickbooks.accounting" \ 
-d "redirect_uri=YOUR_REDIRECT_URI"

Sample access token request

curl -X POST \ "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer" \ 
-H "Content-Type: application/x-www-form-urlencoded" \ -d "client_id=YOUR_CLIENT_ID" \ 
-d "client_secret=YOUR_CLIENT_SECRET" \ -d "code=AUTHORIZATION_CODE" \ 
-d "grant_type=authorization_code" \ -d "redirect_uri=YOUR_REDIRECT_URI"

Supported objects

The following are the supported objects for reading from QuickBooks Online:

  • Accounts

  • AttachableRefs

  • Attachables

  • BalanceSheetSummaryReport

  • BillLineItems

  • BillLinkedTransactions

  • BillPaymentLineItems

  • BillPayments

  • Bills

  • Budgetdetails

  • Budgets

  • Class

  • CompanyCurrency

  • CompanyInfo

  • CreditCardPayments

  • CreditMemoLineItems

  • CreditMemos

  • CustomerBalanceDetail

  • Customers

  • CustomerTypes

  • Departments

  • DepositLineItems

  • Deposits

  • Employees

  • Entitlements

  • EstimateLineItems

  • EstimateLinkedTransactions

  • Estimates

  • ExchangeRates

  • GetDeletedAsView

  • InvoiceLineItems

  • InvoiceLinkedTransactions

  • Invoices

  • Items

  • JournalCode

  • JournalEntries

  • JournalEntryLinkItems

  • PaymentLineItems

  • PaymentMethods

  • Payments

  • Preferences

  • PurchaseLineItems

  • PurchaseOrderLineItems

  • PurchaseOrderLinkedTransactions

  • PurchaseOrders

  • Purchases

  • RecurringBillTransactions

  • RecurringCreditMemoTransactions

  • RecurringCreditMemoTransactionsLineItems

  • RecurringDepositTransactions

  • RecurringDepositTransactionsLineItems

  • RecurringEstimateTransactions

  • RecurringEstimateTransactionsLineItems

  • RecurringInvoiceTransactions

  • RecurringInvoiceTransactionsLineItems

  • RecurringJournalEntryTransactions

  • RecurringJournalEntryTransactionsLineItems

  • RecurringPurchaseTransactions

  • RecurringPurchaseTransactionsLineItems

  • RecurringRefundReceiptTransactions

  • RecurringRefundReceiptTransactionsLineItems

  • RecurringSalesReceiptTransactions

  • RecurringSalesReceiptTransactionsLineItems

  • RecurringTransferTransactions

  • RecurringVendorCreditTransactions

  • RecurringVendorCreditTransactionsLineItems

  • RefundReceiptLineItems

  • RefundReceipts

  • SalesReceiptLineItems

  • SalesReceipts

  • TaxAgency

  • TaxCodes

  • TaxRates

  • Terms

  • TimeActivities

  • Transfers

  • Thresholds

  • VendorCreditLineItems

  • VendorCredits

  • Vendors

QuickBooks Online Reader properties

Property

Type

Default value

Notes

Client ID

String

The client ID assigned when you register your application with an OAuth authorization server.

Client secret

Password

The client secret assigned when you register your application with an OAuth authorization server.

Refresh token

Password

The OAuth refresh token for the corresponding OAuth access token.

Connection pool size

Integer

20

Specifies the maximum number of active connections.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Specify the name of the column that contains the start position value. This column must meet the following criteria:

  • It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID).

  • The values must be unique and continuously increasing to ensure proper incremental reading.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list:

  • Automated mode

  • Initial load

  • Incremental load

Automated

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

Integer

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The reader polls the source at the specified interval.

Start Position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the source. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.