Skip to main content

Xero

This is a setup guide for the Xero source connector which ingests data from the Accounting API.

Prerequisites

First of all you should create an application in Xero development center. The only supported integration type is to use Xero Custom Connections so you should choose it on creating your Xero App. After creating an application, on configuration screen, authorize user for your Xero Organisation. Also, issue new Client Secret and remember it - it will be required for setting up Xero connector in your Airbyte instance.

Supported streams

Accounts BankTransactions BankTransfers BrandingThemes ContactGroups Contacts CreditNotes Currencies Employees Invoices Items ManualJournals Organisation Overpayments Payments Prepayments PurchaseOrders RepeatingInvoices TaxRates TrackingCategories Users

Dates transformation

As Xero uses .NET, some date fields in records could be in .NET JSON date format. These dates are transformed into ISO 8601.

Set up the Xero source connector

  1. Click Sources and then click + New source.
  2. On the Set up the source page, select Xerp from the Source type dropdown.
  3. Enter a name for your new source.
  4. For Client ID, enter Client ID of your Xero App.
  5. For Client Secret, enter a Client Secret created on "Configuration" screen of your Xero App
  6. For Tenant ID field, enter your Xero Organisation's Tenant ID
  7. For Scopes field enter scopes you used for user's authorization on "Configuration" screen of your Xero App
  8. Choose Custom Connections Authentication as Authentication option
  9. For Start date enter UTC date and time in the format YYYY-MM-DDTHH:mm:ssZ as the start date and time of ingestion.
  10. Click Set up source.

Supported sync modes

The source connector supports the following sync modes:

  • Full Refresh
  • Incremental

Changelog

VersionDatePull RequestSubject
0.1.02021-11-1118666🎉 New Source - Xero [python cdk]