Use the CData API Server in Microsoft Power BI



You can use the CData API Server to feed Xero data to Power BI dashboards. Simply drag and drop Xero data into data visuals on the Power BI canvas.

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 Power BI. This article details how to import an OData feed of Xero data into Microsoft Power BI.

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 BI, we start by creating and configuring a Xero connection. Follow the steps below to configure the API Server to connect to Xero data:

  1. First, navigate to the Connections page.
  2. Click Add Connection and then search for and select the Xero connection.
  3. Enter the necessary authentication properties to connect to Xero.
  4. 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:

  1. On the Users page, click Add User to open the Add User dialog.
  2. Next, set the Role, Username, and Privileges properties and then click Add User.
  3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:

Creating API Endpoints for Xero

Having created a user, you are ready to create API endpoints for the Xero tables:

  1. First, navigate to the API page and then click Add Table .
  2. Select the connection you wish to access and click Next.
  3. With the connection selected, create endpoints by selecting each table and then clicking Confirm.

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:

Connect to Xero Data from Power BI Desktop

  1. Open Power BI Desktop and click Get Data -> OData feed.
  2. In the OData feed connection, set the URL property to the OData Endpoint URL previously copied and click OK (e.g. "http://localhost:8080/api.rsc"):
  3. 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:
  4. Select the tables that you would like to import into Power BI and click Load

Create Data Visualizations

After pulling the data into Power BI, you can create data visualizations in the Report view. Follow the steps below to create a pie chart:

  1. Select the pie chart icon in the Visualizations pane.
  2. Select a dimension in the Fields pane: for example, Genre Name.
  3. Select a measure in the Fields pane: for example, GenreId.

You can change sort options by clicking the ellipsis (...) button for the chart. Options to select the sort column and change the sort order are displayed.

You can use both highlighting and filtering to focus on data. Filtering removes unfocused data from visualizations; highlighting dims unfocused data. You can highlight fields by clicking them:

You can apply filters at the page level, at the report level, or to a single visualization by dragging fields onto the Filters pane. To filter on the field's value, select one of the values that are displayed in the Filters pane.

Click Refresh to synchronize your report with any changes to the data.

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 BI, 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.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server