tap-xero

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

• Pulls raw data from Xero's API
• Extracts the following resources from Xero
  • Bank Transactions
  • Contacts
  • Credit Notes
  • Invoices
  • Manual Journals
  • Overpayments
  • Prepayments
  • Purchase Orders
  • Journals
  • Accounts
  • Bank Transfers
  • Employees
  • Expense Claims
  • Items
  • Payments
  • Receipts
  • Users
  • Branding Themes
  • Contact Groups
  • Currencies
  • Organisations
  • Repeating Invoices
  • Tax Rates
  • Tracking Categories
  • Linked Transactions
• Outputs the schema for each resource
• Incrementally pulls data based on the input state

Limitations

• Only designed to work with Xero Partner Applications, not Private Applications.

Authentication

This tap requires a client id, client secret, tenant id, and refresh token in order to authenticate (and thus receive an access token).

See the Xero documentation for more info.

Refresh token

The tap is able to use the refresh token to refresh the access token. Doing so also generates a new refresh token, which the tap is able to write back to you.

There are two ways to pass in a refresh token, and two ways to have an updated refresh token written back to you.

To pass in a refresh token, either use the refresh_token arg or the refresh_token_path arg.
If refresh_token is not set, the refresh token will be read as the entire contents of the file at refresh_token_path.
If refresh_token_path is set, a new refresh token will override the entire contents of the file as well as being written to the config JSON (which is the default behavior if refresh_token_path is not set).

This is important for the use of this tap via Meltano. Since Meltano generates an ephemeral config JSON, writing the new refresh token to it is not very helpful.

---

Copyright © 2017 Stitch