Quickbooks
Table of Contents
The tap-quickbooks
Meltano extractor pulls data from Quickbooks that can then be sent to a destination using a loader.
Getting Started #
Prerequisites #
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration #
-
Add the
tap-quickbooks
extractor to your project usingmeltano add
:meltano add extractor tap-quickbooks
-
Configure the settings below using
meltano config
.
Next steps #
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
Capabilities #
Settings #
tap-quickbooks
requires the
configuration
of the following settings:
The settings for extractor tap-quickbooks
that are known to Meltano are documented below.
To quickly find the
setting you're looking for, use the Table of Contents at
the top of the page.
Realm ID (realmId
)
#
-
Environment variable:
TAP_QUICKBOOKS_REALMID
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set realmId <realmId>
export TAP_QUICKBOOKS_REALMID=<realmId>
Client ID (client_id
)
#
-
Environment variable:
TAP_QUICKBOOKS_CLIENT_ID
Your Quickbooks Online OAuth client ID
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set client_id <client_id>
export TAP_QUICKBOOKS_CLIENT_ID=<client_id>
Client Secret (client_secret
)
#
-
Environment variable:
TAP_QUICKBOOKS_CLIENT_SECRET
Your Quickbooks Online OAuth client secret
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set client_secret <client_secret>
export TAP_QUICKBOOKS_CLIENT_SECRET=<client_secret>
Refresh Token (refresh_token
)
#
-
Environment variable:
TAP_QUICKBOOKS_REFRESH_TOKEN
Access to Quickbooks’s API requires a refresh token that will authenticate you with the server.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set refresh_token <refresh_token>
export TAP_QUICKBOOKS_REFRESH_TOKEN=<refresh_token>
Start Date (start_date
)
#
-
Environment variable:
TAP_QUICKBOOKS_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set start_date YYYY-MM-DDTHH:MM:SSZ
export TAP_QUICKBOOKS_START_DATE=YYYY-MM-DDTHH:MM:SSZ
Is Sandbox (is_sandbox
)
#
-
Environment variable:
TAP_QUICKBOOKS_IS_SANDBOX
- Default:
false
Use Quickbooks Sandbox
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set is_sandbox true
export TAP_QUICKBOOKS_IS_SANDBOX=true
Select Fields By Default (select_fields_by_default
)
#
-
Environment variable:
TAP_QUICKBOOKS_SELECT_FIELDS_BY_DEFAULT
- Default:
true
Select by default any new fields discovered in Quickbooks objects
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set select_fields_by_default false
export TAP_QUICKBOOKS_SELECT_FIELDS_BY_DEFAULT=false
State Message Threshold (state_message_threshold
)
#
-
Environment variable:
TAP_QUICKBOOKS_STATE_MESSAGE_THRESHOLD
- Default:
1000
Generate a STATE message every N records
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set state_message_threshold 1000
export TAP_QUICKBOOKS_STATE_MESSAGE_THRESHOLD=1000
Max Workers (max_workers
)
#
-
Environment variable:
TAP_QUICKBOOKS_MAX_WORKERS
- Default:
8
Maximum number of threads to use
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-quickbooks set max_workers 8
export TAP_QUICKBOOKS_MAX_WORKERS=8
Looking for help? #
If you're having trouble getting the
tap-quickbooks
extractor to work, look for an
existing issue in its repository, file a new issue,
or
join the Meltano Slack community
and ask for help in the #plugins-general
channel.
Found an issue on this page? #
This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!