tap-quickbooks - Meltano Hub

Quickbooks

tap-quickbooks (hotgluexyz variant)🥈

Accounting management platform

The tap-quickbooks 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 using
```
meltano add
```
:

meltano add extractor tap-quickbooks

Configure the tap-quickbooks settings using

meltano config

:

meltano config tap-quickbooks set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-quickbooks test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-quickbooks may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

discover
properties
state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-quickbooks settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

client_id
client_secret
is_sandbox
max_workers
realmId
refresh_token
select_fields_by_default
start_date
state_message_threshold

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-quickbooks list

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 plugin.

Client ID (client_id)

Environment variable: TAP_QUICKBOOKS_CLIENT_ID

Your Quickbooks Online OAuth client ID

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set client_id [value]

Client Secret (client_secret)

Environment variable: TAP_QUICKBOOKS_CLIENT_SECRET

Your Quickbooks Online OAuth client secret

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set client_secret [value]

Is Sandbox (is_sandbox)

Environment variable: TAP_QUICKBOOKS_IS_SANDBOX
Default Value: false

Use Quickbooks Sandbox

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set is_sandbox [value]

Max Workers (max_workers)

Environment variable: TAP_QUICKBOOKS_MAX_WORKERS
Default Value: 8

Maximum number of threads to use

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set max_workers [value]

Realm ID (realmId)

Environment variable: TAP_QUICKBOOKS_REALMID

[No description provided.]

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set realmId [value]

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.

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set refresh_token [value]

Select Fields By Default (select_fields_by_default)

Environment variable: TAP_QUICKBOOKS_SELECT_FIELDS_BY_DEFAULT
Default Value: true

Select by default any new fields discovered in Quickbooks objects

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set select_fields_by_default [value]

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.

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set start_date [value]

State Message Threshold (state_message_threshold)

Environment variable: TAP_QUICKBOOKS_STATE_MESSAGE_THRESHOLD
Default Value: 1000

Generate a STATE message every N records

Configure this setting directly using the following Meltano command:

meltano config tap-quickbooks set state_message_threshold [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

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.

Install

meltano add extractor tap-quickbooks

Maintenance Status

Repo

https://github.com/hotgluexyz/tap-quickbooks

Maintainer

Meltano Stats

Keywords