airbyte/docs/integrations/sources/quickbooks.md

QuickBooks

This page contains the setup guide and reference information for the QuickBooks Source connector.

Prerequisites

• Intuit QuickBooks account
• Intuit Developer account
• OAuth2.0 credentials (see OAuth 2.0 playground)
• Realm ID

Setup guide

Step 1: Set up QuickBooks

1. Create an Intuit Developer account
2. Create an application
3. Obtain credentials. The easiest way to get these credentials is by using Quickbook's OAuth 2.0 playground

Step 2: Set up the QuickBooks connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
3. On the source setup page, select QuickBooks from the Source type dropdown and enter a name for this connector.
4. Client ID - The OAuth2.0 application ID
5. Client Secret - The OAuth2.0 application secret
6. Refresh Token - Refresh token used to get new access token every time the current one is expired
7. Access Token - Access token to perform authenticated API calls with
8. Token Expiry Date - DateTime when the access token becomes invalid
9. Realm ID - The Labeled Company ID you'd like to replicate data for streams.
10. Start date - The date starting from which you'd like to replicate data.
11. Sandbox - Turn on if you're going to replicate the data from the sandbox environment.
12. Click Set up source.

For Airbyte Open Source:

1. Client ID - The OAuth2.0 application ID
2. Client Secret - The OAuth2.0 application secret
3. Refresh Token - Refresh token used to get new access token every time the current one is expired
4. Access Token - Access token to perform authenticated API calls with
5. Token Expiry Date - DateTime when the access token becomes invalid
6. Realm ID - The Labeled Company ID you'd like to replicate data for streams.
7. Start date - The date starting from which you'd like to replicate data.
8. Sandbox - Turn on if you're going to replicate the data from the sandbox environment.

Supported sync modes

The Quickbooks Source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported Streams

This Source is capable of syncing the following Streams:

• Accounts
• BillPayments
• Budgets
• Bills
• Classes
• CreditMemos
• Customers
• Departments
• Deposits
• Employees
• Estimates
• Invoices
• Items
• JournalEntries
• Payments
• PaymentMethods
• Purchases
• PurchaseOrders
• RefundReceipts
• SalesReceipts
• TaxAgencies
• TaxCodes
• TaxRates
• Terms
• TimeActivities
• Transfers
• VendorCredits
• Vendors

Data type map

Integration Type	Airbyte Type	Notes
string	string
number	number
array	array
object	object

Changelog

Version	Date	Pull Request	Subject
2.0.4	2023-06-28	27803	Update following state breaking changes
2.0.3	2023-06-08	27148	Update description and example values of a Start Date in spec.json
2.0.2	2023-06-07	26722	Update CDK version and adjust authenticator configuration
2.0.1	2023-05-28	26722	Change datatype for undisclosed amount field in payments
2.0.0	2023-04-11	25045	Fix datetime format, disable OAuth button in cloud
1.0.0	2023-03-20	24324	Migrate to Low-Code
0.1.5	2022-02-17	10346	Update label Quickbooks -> QuickBooks
0.1.4	2021-12-20	8960	Update connector fields title/description
0.1.3	2021-08-10	4986	Using number data type for decimal fields instead string
0.1.2	2021-07-06	4539	Add AIRBYTE_ENTRYPOINT for Kubernetes support