The CData API Server enables you to use REST, OData, JSON, or Open APIs to connect to and query Xero data. The OData standard enables real-time access to the live data, and support for OData is integrated into PowerQuery. This article details how to import an OData feed of Xero data into Microsoft Power Query.
About Xero Data Integration
Accessing and integrating live data from Xero has never been easier with CData. Customers rely on CData connectivity to:
- Connect to Xero Accounts and both US and Australian Payroll APIs.
- Read, write, update, and delete Xero objects like Customers, Transactions, Invoices, Sales Receipts and more.
- Use SQL stored procedures for actions like adding items to a cart, submitting orders, and downloading attachments.
- Work with accounting, payroll, file, fixed asset, and project data.
Customers regularly integrate their Xero data with preferred tools, like Tableau, Qlik Sense, or Excel, and integrate Xero data into their database or data warehouse.
Getting Started
Set Up the API Server
If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure Xero OData services:
Connect to Xero
To work with Xero data from Microsoft Power Query, we start by creating and configuring a Xero connection. Follow the steps below to configure the API Server to connect to Xero data:
- First, navigate to the Connections page.
-
Click Add Connection and then search for and select the Xero connection.
π Selecting a data source (SQLite is shown)
-
Enter the necessary authentication properties to connect to Xero.
π Connecting to a datasource (SQLite is shown)
-
After configuring the connection, click Save & Test to confirm a successful connection.
Configure API Server Users
Next, create a user to access your Xero data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:
- On the Users page, click Add User to open the Add User dialog.
-
Next, set the Role, Username, and Privileges properties and then click Add User.
π Configure a new user.
-
An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:
π API Server user settings.
Creating API Endpoints for Xero
Having created a user, you are ready to create API endpoints for the Xero tables:
-
First, navigate to the API page and then click
Add Table
.
π Add tables
-
Select the connection you wish to access and click Next.
π Select the connection (SQLite is shown)
-
With the connection selected, create endpoints by selecting each table and then clicking Confirm.
π Adding tables from the connection (SQLite is shown)
Gather the OData Url
Having configured a connection to Xero data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:
π API Endpoints
Connect to Xero Data from Power Query
-
In Microsoft Excel, open the Power Query Editor. From the Data ribbon, click Get Data -> Launch Power Query Editor:
π Launch the Power Query Editor
-
Click New Source -> Other Sources -> OData feed:
π Open OData feed connection
-
In the OData feed connection, set the URL property to the OData Endpoint URL previously copied and click OK:
π The URL of the OData endpoint for API Server
-
In the next step of the wizard, define the authentication credentials. Select Basic and then enter the credentials for a user authorized to make requests. Specify the User name and enter the user's authtoken in the Password field:
π Authenticating with API Server
-
You can now access Xero data in Power Query. In the Navigator expand the node for the OData feed, right-click a table, and click Transform Data to open the Query Editor. This will display the table data.
π Table loaded in Power Query (SQLite is shown)
Free Trial & More Information
If you are interested in connecting to your Xero data (or data from any of our other supported data sources) from Microsoft Power Query, download API Server to begin creating flexible and customizable REST, OData, JSON and Open APIs from any database or data store! As always, our world-class support team is ready to answer any questions you may have.