The tap-freshbooks extractor pulls data from FreshBooks 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-freshbooks extractor to your
project using
:meltano add -
Configure the tap-freshbooks
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-freshbooksmeltano config tap-freshbooks set --interactivemeltano config tap-freshbooks testNext 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-freshbooks
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:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-freshbooks 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:
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-freshbooks 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.
Access Token (access_token)
-
Environment variable:
TAP_FRESHBOOKS_ACCESS_TOKEN
The token to authenticate against the API service
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set access_token [value]Client ID (client_id)
-
Environment variable:
TAP_FRESHBOOKS_CLIENT_ID
Your FreshBooks API client ID.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set client_id [value]Redirect Uri (redirect_uri)
-
Environment variable:
TAP_FRESHBOOKS_REDIRECT_URI
The API redirect URI.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set redirect_uri [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_FRESHBOOKS_REFRESH_TOKEN
Your FreshBooks API refresh token.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set refresh_token [value]Secret ID (secret_id)
-
Environment variable:
TAP_FRESHBOOKS_SECRET_ID
Your FreshBooks API secret ID.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set secret_id [value]Start Date (start_date)
-
Environment variable:
TAP_FRESHBOOKS_START_DATE
The earliest record date to sync
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set start_date [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_FRESHBOOKS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_FRESHBOOKS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_FRESHBOOKS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_FRESHBOOKS_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-freshbooks set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
