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
- Create an Intuit Developer account
- Create an application
- 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:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + new source.
- On the source setup page, select QuickBooks from the Source type dropdown and enter a name for this connector.
- Client ID - The OAuth2.0 application ID
- Client Secret - The OAuth2.0 application secret
- Refresh Token - Refresh token used to get new access token every time the current one is expired
- Access Token - Access token to perform authenticated API calls with
- Token Expiry Date - DateTime when the access token becomes invalid
- Realm ID - The Labeled Company ID you'd like to replicate data for streams.
- Start date - The date starting from which you'd like to replicate data.
- Sandbox - Turn on if you're going to replicate the data from the sandbox environment.
- Click Set up source.
For Airbyte Open Source:
- Client ID - The OAuth2.0 application ID
- Client Secret - The OAuth2.0 application secret
- Refresh Token - Refresh token used to get new access token every time the current one is expired
- Access Token - Access token to perform authenticated API calls with
- Token Expiry Date - DateTime when the access token becomes invalid
- Realm ID - The Labeled Company ID you'd like to replicate data for streams.
- Start date - The date starting from which you'd like to replicate data.
- 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:
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 |
Reference
Config fields reference
Field
Type
Property name
object
credentials
string
start_date
boolean
sandbox
Changelog
Expand to review
Version | Date | Pull Request | Subject |
---|---|---|---|
3.0.17 | 2024-08-12 | 43829 | Update dependencies |
3.0.16 | 2024-08-10 | 43563 | Update dependencies |
3.0.15 | 2024-08-03 | 43052 | Update dependencies |
3.0.14 | 2024-07-27 | 42666 | Update dependencies |
3.0.13 | 2024-07-20 | 42358 | Update dependencies |
3.0.12 | 2024-07-13 | 41745 | Update dependencies |
3.0.11 | 2024-07-10 | 41414 | Update dependencies |
3.0.10 | 2024-07-10 | 41325 | Update dependencies |
3.0.9 | 2024-07-09 | 40660 | Fix configured catalog, inline schemas |
3.0.8 | 2024-07-06 | 40885 | Update dependencies |
3.0.7 | 2024-06-25 | 40355 | Update dependencies |
3.0.6 | 2024-06-22 | 39955 | Update dependencies |
3.0.5 | 2024-06-06 | 39285 | [autopull] Upgrade base image to v1.2.2 |
3.0.4 | 2024-05-21 | 38518 | [autopull] base image + poetry + up_to_date |
3.0.3 | 2024-03-22 | 36389 | Add refresh token updater and add missing properties to streams |
3.0.2 | 2024-02-20 | 32236 | Small typo in spec correction |
3.0.1 | 2023-11-06 | 32236 | Upgrade to airbyte-cdk>=0.52.10 to resolve refresh token issues |
3.0.0 | 2023-09-26 | 30770 | Update schema to use number instead of integer |
2.0.5 | 2023-09-26 | 30766 | Fix improperly named keyword argument |
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 |