Skip to main content

Setup Xero source

Updated

Pulls journals, invoices, contacts, payments, budgets and payroll data from Xero via Sign in with Xero.

Setup at a glance

  1. 01KleeneAdd Source
  2. 02XeroSSO & Auth
  3. 03KleeneComplete Setup
  4. Connected
  • Connector type API
  • Auth method Sign in with Xero

Before you start

  • For Payroll UK reports: a Payroll provisioned organisation, and an authenticating user who is a Payroll Administrator

Connect Xero to Kleene

  1. Add the source in Kleene

    1. In the Kleene app, go to Add a source.
    2. Scroll down or search for Xero.
    3. Click Connect.

  2. Sign in at Xero

    1. Click Sign in with Xero and log in with your Xero username and password.
    2. Select a tenant when prompted.

    To minimise setup time, the Kleene integration accesses data from all tenants regardless of which tenant you select at this stage. This is the behaviour for reports that are not using the Payroll APIs.

  3. Finish the setup in Kleene

    The new source now appears on the Sources screen.

Before you extract — Xero limits and report notes

This guide covers source setup only. When you move on to creating extracts, these are the connector-specific things to know.

Connector capabilities

Backfill Yes — all-time, apart from P&L Reports (10 years)
Incremental Yes — all reports apart from Items, Accounts, Budgets, Tracking Categories, Organisations, Balance Report, P&L Report, Bank Summary, Budget Summary, Executive Summary, Aged Payables and Aged Receivables. Custom backfill is not supported
API reliability Reliable

Available reports

Reports cover Journals and Journal Lines, Manual Journals, Accounts, Credit Notes, Invoices, Purchase Orders, Contacts, Bank Transactions and Bank Transfers, Tracking Categories, Payments, Budgets and Budget Lines, Items, Overpayments, Prepayments, Organisations, the Balance Sheet, Trial Balance and other summary reports, three Payroll UK reports, and Contacts PDFs Attachment Upload. See the full Xero report list on docs.kleene.ai for every report with its incremental and primary keys.

Extract notes

  • For Payroll API reports you still need to input a tenant-id on the extract setup page. Find it by running an Organisations report.
  • Payroll UK API reports require the organisation behind that tenant-id to be Payroll provisioned, and the authenticated user to be a Payroll Administrator.

Limits and gotchas

You will get duplicates

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.

Run Journals backfills one at a time

The first backfill for Journals reports may take some time to run because of Xero's rate limits. To ensure these run successfully, it is best practice to only run one backfill extract at a time.

Limitations

  • The Contacts PDFs Attachment Upload (S3 only) report is limited to uploading PDF attachments to the S3 bucket associated with your application.

Related to

Powered by Zendesk