Skip to main content

QuickBooks

Availability:
Not available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
community
Connector Version:
3.0.4

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

Prerequisites​

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:

Supported Streams​

This Source is capable of syncing the following Streams:

Data type map​

Integration TypeAirbyte TypeNotes
stringstring
numbernumber
arrayarray
objectobject

Reference​

Config fields reference

Field
Type
Property name
object
credentials
string
start_date
boolean
sandbox

Changelog​

Expand to review
VersionDatePull RequestSubject
3.0.42024-05-2138518[autopull] base image + poetry + up_to_date
3.0.32024-03-2236389Add refresh token updater and add missing properties to streams
3.0.22024-02-2032236Small typo in spec correction
3.0.12023-11-0632236Upgrade to airbyte-cdk>=0.52.10 to resolve refresh token issues
3.0.02023-09-2630770Update schema to use number instead of integer
2.0.52023-09-2630766Fix improperly named keyword argument
2.0.42023-06-2827803Update following state breaking changes
2.0.32023-06-0827148Update description and example values of a Start Date in spec.json
2.0.22023-06-0726722Update CDK version and adjust authenticator configuration
2.0.12023-05-2826722Change datatype for undisclosed amount field in payments
2.0.02023-04-1125045Fix datetime format, disable OAuth button in cloud
1.0.02023-03-2024324Migrate to Low-Code
0.1.52022-02-1710346Update label Quickbooks -> QuickBooks
0.1.42021-12-208960Update connector fields title/description
0.1.32021-08-104986Using number data type for decimal fields instead string
0.1.22021-07-064539Add AIRBYTE_ENTRYPOINT for Kubernetes support
Was this page helpful?