- Availability
- Airbyte Cloud Airbyte OSS
- Support Level
- Community
- Latest Version
- 0.2.4
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:
Please follow instruction to obtain all requirements:
- Client ID
- Client Secret
- Refresh Token
- Access Token
- Token Expiry Date
Setup guide
Step 1: Set up Xero
Step 2: Set up the Xero connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + new source.
- On the source setup page, select Xero from the Source type dropdown and enter a name for this connector.
- Click
Authenticate your Xero account. - Log in and
Allow access. - Tenant ID - Enter your Xero Organisation's Tenant ID
- Start Date - UTC date and time in the format
YYYY-MM-DDTHH:mm:ssZfrom which you'd like to replicate data.
For Airbyte Open Source:
- Create an application in Xero development center.
Supported sync modes
The Xero source connector supports the following sync modes:
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
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 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] |