Xero
Version 0.1.6
Set up
To set up Xero as a source you will just need your Xero username and password. Once you click sign in with Xero you will be asked to log in, then you will be asked to select a tenant.
Data will be pulled from all tenants (for non Payroll reports)
To minimize the time taken to set up, the kleene integration will access data from all tenants regardless of which tenant is selected at this stage (this is the behaviour for reports that are not using the Payroll APIs).
For Payroll API reports, you would still need to input a
tenant-idon the extract setup page. Thetenant-idcan be found if you run anOrganisationsReport.
Payroll UK API reports
These reports will require that:
- The organisation's tenant-id you are using on the extract setup page is for an organisation that is Payroll provisioned
- The user who has authenticated is a User that is a Payroll Administrator
Rate Limits
The first backfill for Journals reports may take some time to run due to the rate limits of Xero - in order to ensure these run successfully, it is best practice to only run 1 backfill extracts at the same time.
Features
| Feature | Support | Notes |
|---|---|---|
| Backfill | ✅ | All-time, apart from P&L Reports (10 Years) |
| Incremental | ✅ | All reports apart from Items, Accounts, Budgets, Tracking Categories, Organisations, Balance Report, P&L Report, Bank Summary, Budget Summary, Executive Summary, Aged Payables, Aged Receivables |
| Custom backfill | ❌ | |
| API reliability | 🟢 | Reliable |
Reports detail
| ⬇️ Report | 🔑 Incremental key | 🔑 Primary key | 📄 Link to API endpoint |
|---|---|---|---|
| Journals | CREATED_DATE_UTC | JournalID | Get Journals |
| Journal Lines | CREATED_DATE_UTC | JournalNumber | Get Journals |
| Manual Journals | UPDATED_DATE_UTC | ManualJournalID | Get Manual Journals |
| Manual Journal Lines | UPDATED_DATE_UTC | ManualJournalID | Get Manual Journals |
| Accounts | - | AccountID | Get Accounts |
| Credit Notes | UPDATED_DATE_UTC | CreditNoteID | Get CreditNotes |
| Invoices | UPDATED_DATE_UTC | InvoiceID | Get Invoices |
| Contacts | UPDATED_DATE_UTC | ContactID | Get Contacts |
| Bank Transactions | UPDATED_DATE_UTC | BankTransactionID | Get Bank Transactions |
| Tracking Categories | - | TrackingCategoryID | Get Tracking Categories |
| Payments | UPDATED_DATE_UTC | PaymentID | Get Payments |
| Budgets | - | BudgetID | Get Budgets |
| Budget Lines | - | BudgetID, AccountID | Get Budget Lines |
| Items | - | ItemID | Get Items |
| Over Payments | UPDATED_DATE_UTC | OverpaymentID | Get Overpayments |
| Pre Payments | UPDATED_DATE_UTC | PrepaymentID | Get Prepayments |
| Purchase Orders | UPDATED_DATE_UTC | PurchaseOrderID | Get Purchase Orders |
| P&L Report | N/A | N/A | Profit And Loss Report |
| Trial Balance Report | DATETIME | N/A | Trial Balance Report |
| Bank Transfers Report | CREATED_DATE_UTC | N/A | Bank Transfers Report |
| Balance Sheet Report | N/A | N/A | Balance Sheet Report |
| Organisations Report | N/A | N/A | Organisations Report |
| Bank Summary Report | N/A | N/A | Bank Summary Report |
| Employees (Payroll UK API) | N/A | EMPLOYEE_ID | Employees |
| Earning Rates (Payroll UK API) | N/A | EARNINGS_RATE_ID | Earning Rates |
| Salary and Wages (Payroll UK API) | N/A | SALARY_AND_WAGES_ID | Salary and Wages |
Limitations
- See info on rate limits above.
- To ensure there are no missing records, duplicates will occur with Xero. You will need to create a de-duplication transform to run after the extracts.
Updated 27 days ago