The tap-xero extractor pulls data from Xero that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-xero extractor to your
project using
:meltano add -
Configure the tap-xero
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-xeromeltano config tap-xero set --interactivemeltano config tap-xero 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-xero
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:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-xero 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:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-xero 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_XERO_CLIENT_ID
Your Xero client ID. Issued when you create your app.
Configure this setting directly using the following Meltano command:
meltano config tap-xero set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_XERO_CLIENT_SECRET
Your Xero client secret.
Configure this setting directly using the following Meltano command:
meltano config tap-xero set client_secret [value]Include Archived Contacts (include_archived_contacts)
-
Environment variable:
TAP_XERO_INCLUDE_ARCHIVED_CONTACTS
Whether to include archive contacts in the sync.
Configure this setting directly using the following Meltano command:
meltano config tap-xero set include_archived_contacts [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_XERO_REFRESH_TOKEN
Your Xero refresh token.
Configure this setting directly using the following Meltano command:
meltano config tap-xero set refresh_token [value]Start Date (start_date)
-
Environment variable:
TAP_XERO_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-xero set start_date [value]Tenant ID (tenant_id)
-
Environment variable:
TAP_XERO_TENANT_ID
Your Xero tenant ID.
Configure this setting directly using the following Meltano command:
meltano config tap-xero set tenant_id [value]User Agent (user_agent)
-
Environment variable:
TAP_XERO_USER_AGENT
The user agent sent with your requests to the Xero API.
Configure this setting directly using the following Meltano command:
meltano config tap-xero set user_agent [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
-2-c0c0c4){kind=icon}
-7-c0c0c4){kind=icon}
