The tap-quickbooks Singer tap pulls data from Quickbooks that can then be sent to a destination using a Singer target.

Standalone usage #

Install the package using pip:

pip install git+

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-quickbooks instructions to learn more.

Capabilities #

These capabilities can also be overriden by specifying the capabilities key in your meltano.yml file.

Settings #

tap-quickbooks requires the configuration of the following settings:

The settings for tap 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.

You can override these settings or specify additional ones in your meltano.yml by adding the settings key. Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this tap.

Realm ID (realmId) #

Client ID (client_id) #

Your Quickbooks Online OAuth client ID

Client Secret (client_secret) #

Your Quickbooks Online OAuth client secret

Refresh Token (refresh_token) #

Access to Quickbooks’s API requires a refresh token that will authenticate you with the server.

Start Date (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.

Is Sandbox (is_sandbox) #

  • Default: false

Use Quickbooks Sandbox

Select Fields By Default (select_fields_by_default) #

  • Default: true

Select by default any new fields discovered in Quickbooks objects

State Message Threshold (state_message_threshold) #

  • Default: 1000

Generate a STATE message every N records

Max Workers (max_workers) #

  • Default: 8

Maximum number of threads to use

Looking for help? #

If you're having trouble getting the tap-quickbooks tap 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!