Connecting to a Xero Data Source

Table of contents

Getting Started

Connecting to the Xero datasource

Selecting data

Frequently asked questions

Next Steps

Getting started

To add a Xero data source to an existing Data Model:

  1. Open an existing Data Model from the RESOURCE EXPLORER.
  2. Expand Data Sources.
  3. Click Add Data Source.

Connecting to the Xero data source

  1. Click Xero then click Connect.
  2. Select the Xero API Schema to connect to from: Accounting, Assets, Files Payroll AUS or, Project.
  3. Click Sign in.
  4. In the Log in to Xero pop-up, enter your Xero account and password and click Log in.

  1. Enter your authentication code in the Xero Multi-factor authentication screen and click Log in.
  2. Select an Organization from the dropdown list, and click the blue button to allow access.
  3. You can continue adding Organizations by signing out (black cross icon) and signing in again for every Organization.

  1. Once you have finished adding / allowing access to Organization, navigate to the COMPANY SELECTION tab.
  2. Review the Organizations you wish to synchronise in Data Hub by checking/unchecking them and select a Primary Organization.
  3. Save the datasource and click Process Model to refresh the data.

Selecting data

  1. Select tables to be added as pipelines using the check box column.
  2. To add the pipelines to the data model, there are three options:
    • Use Add Pipelines to add tables as individual pipelines.
    • Use the Add Pipeline as Union of Tables option from the Add Pipelines drop-down menu, to add a single pipeline created from a union of the selected tables.
    • Use Finish to add tables as individual pipelines and finish adding the Xero data source.
 

Note

If all of the tables in the data source are selected, the pipeline will always perform a union on all tables from the data source, even if the table list changes. For example, if the data source contains only tables of sales for USA, UK, and Europe, selecting them all will union the three tables into a single pipeline. If a fourth table with sales for Australia is later added, it will automatically be included in the union for the pipeline.

  1. If the Finish button was not used to add pipelines, Click Finish to complete adding the Xero data source.

 

Frequently asked questions

Q: Does Data Hub remember my login, or do I have to reconnect every now and then?

A: You only need to sign-in once to Xero, Data Hub remembers your login and keeps the connection to Xero active.

 

Q: How do I disconnect from Xero?

A: Simply click the black cross button to sign out within the Xero datasource.

 

Q: Which Xero APIs can Data Hub connect to?

A: Data Hub lists all the available APIs in the Schema dropdown list. Supported APIs are are: Accounting, Assets, Files, Projects and Payroll AUS APIs.

 

Q: Can I combine more than one Xero organization in Data Hub?

A: Yes. Xero requires that you re-authenticate and allow access to the company you would like to connect to. You will need to sign-out and sign-in again, then select a company to connect to. Once you have allowed access to this company, Data Hub will list it in the COMPANY SELECTION tab of the Xero connector. When more than one organization is selected, Data Hub automatically combines the Xero data, so modeling is only done once and applies to all organizations.

 

Q: Does the Xero connector write data to Xero?

A: No. The Xero connector only extracts data from Xero.

 

Q: Can I connect and extract data coming from Xero Reports?

A: Yes. You will notice that ZAP also lists all Xero Reports as endpoints in the TABLES tab of the datasource.

 

Q: Can I sign-in with more than one Xero account ?

A: Yes. You can add organizations that are linked to a different Xero account and automatically combine them in the data warehouse. Open the Xero datasource, navigate to the Additional Sources tab, click + Add Datasource, locate the Xero connector then click Connect. The same authentication configuration then applies.

 

Next Steps

For information on configuring Pipelines, see: Using Pipelines.

For a list of Available Data Sources, see: About Available Data Sources.

For information about Xero, visit: https://www.xero.com.