airbyte/docs/integrations/sources/xero.md

Xero

This page contains the setup guide and reference information for the Xero source connector.

Prerequisites

• Tenant ID
• Start Date

Required list of scopes to sync all streams:

• accounting.attachments.read
• accounting.budgets.read
• accounting.contacts.read
• accounting.journals.read
• accounting.reports.read
• accounting.reports.tenninetynine.read
• accounting.settings.read
• accounting.transactions.read
• assets.read
• offline_access

For Airbyte Cloud:

• OAuth 2.0

For Airbyte Open Source:

There is two currently supported ways to authenticate with Xero:

For the bearer token strategy, please follow instruction to obtain all requirements:

• Client ID

For the OAuth client credentials, please follow instructions to obtain all requirements:

• Client ID
• Client Secret

Setup guide

Step 1: Set up Xero

Step 2: Set up the Xero connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
3. On the source setup page, select Xero from the Source type dropdown and enter a name for this connector.
4. Click Authenticate your Xero account.
5. Log in and Allow access.
6. Tenant ID - Enter your Xero Organisation's Tenant ID
7. Start Date - UTC date and time in the format YYYY-MM-DDTHH:mm:ssZ from which you'd like to replicate data.

For Airbyte Open Source:

1. Create an application in Xero development center.

For the client credentials, make sure you set the list of scopes mentioned above.

You can optionally use postman to generate the required access_token needed for the source setup.

Supported sync modes

The Xero source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append

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.

Performance considerations

The connector is restricted by Xero API rate limits.

Changelog

Expand to review

Version	Date	Pull Request	Subject
2.0.0	2024-06-06	39316	Add OAuth and Bearer strategies
1.0.1	2024-06-06	39264	[autopull] Upgrade base image to v1.2.2
1.0.0	2024-04-30	36878	Migrate to low code
0.2.6	2024-05-17	38330	Updating python dependencies
0.2.5	2024-01-11	34154	prepare for airbyte-lib
0.2.4	2023-11-24	32837	Handle 403 error
0.2.3	2023-06-19	27471	Update CDK to 0.40
0.2.2	2023-06-06	27007	Update CDK
0.2.1	2023-03-20	24217	Certify to Beta
0.2.0	2023-03-14	24005	Enable in Cloud
0.1.0	2021-11-11	18666	🎉 New Source - Xero [python cdk]