Use the API Server and Xero ADO.NET Provider to Access Xero Data in Microsoft PowerPivot



Use the API Server to connect to live Xero data in the PowerPivot business intelligence tool.

This article will explain how to use the API Server and the ADO.NET Provider for Xero (or any of 200+ other ADO.NET Providers) to provide Xero data as OData services and then consume the data in Microsoft Excel's PowerPivot business intelligence tool. Follow the steps below to retrieve and edit Xero data in Power Pivot.

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

Follow the steps below to begin producing secure Xero OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Xero

After you deploy the API Server and the ADO.NET Provider for Xero, provide authentication values and other connection properties needed to connect to Xero by clicking Settings -> Connections and adding a new connection in the API Server administration console.

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. Set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

You can then choose the Xero entities you want to allow the API Server access to by clicking Settings -> Resources.

Additionally, click Settings -> Server and set the Default Format to XML (Atom) for compatibility with Excel.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Import Xero Tables in Power Pivot

Follow the steps below to import tables that can be refreshed on demand:

  1. In Excel, click the PowerPivot Window icon in the PowerPivot tab to open PowerPivot.
  2. Click Home -> Get External Data -> From Data Service -> From OData Data Feed.
  3. Add authentication parameters. Click Advanced and set the Integrated Security option to Basic. You will need to enter the User Id and Password of a user who has access to the CData API Server. Set the password to the user's authtoken.

  4. In the Base URL box, enter the OData URL of the CData API Server. For example, http://localhost:8032/api.rsc.

  5. Select which tables you want to import and click Finish.

  6. You can now work with Xero data in Power Pivot.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server