tap-xero from singer-io

Accounting Software

The tap-xero extractor pulls data from Xero that can then be sent to a destination using a loader.

Getting Started


If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-xero extractor to your project using
    meltano add
  2. meltano add extractor tap-xero
  3. Configure the tap-xero settings using
    meltano config
  4. meltano config tap-xero set --interactive
  5. Test that extractor settings are valid using
    meltano config
  6. meltano config tap-xero test

Next steps

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


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.


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

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.

Client ID (client_id)

  • Environment variable: TAP_XERO_CLIENT_ID

Your Xero client ID. Issued when you create your app.

Client Secret (client_secret)

  • Environment variable: TAP_XERO_CLIENT_SECRET

Your Xero client secret.

Tenant ID (tenant_id)

  • Environment variable: TAP_XERO_TENANT_ID

Your Xero tenant ID.

Refresh Token (refresh_token)

  • Environment variable: TAP_XERO_REFRESH_TOKEN

Your Xero refresh token.

Include Archived Contacts (include_archived_contacts)


Whether to include archive contacts in the sync.

User Agent (user_agent)

  • Environment variable: TAP_XERO_USER_AGENT

The user agent sent with your requests to the Xero API.

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-xero 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


meltano add extractor tap-xero

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License


  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version


  • api