VOOZH about

URL: https://www.cdata.com/kb/tech/xero-excel-setup.rst

⇱ Getting Started with the CData Excel Add-In for Xero

Getting Started with the CData Excel Add-In for Xero

Complete guide to installing, licensing, and connecting with the CData Excel Add-In for Xero.

This guide explains everything you need to get started with the CData Excel Add-In for Xero. You will learn how to install the add-in, understand licensing behavior, configure your first connection, and import real-time Xero data directly into Excel for analysis, reporting, and automation.

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


Installation & Licensing

System Requirements

  • Windows: Windows 10/11 or Windows Server 2016+
  • Microsoft Excel: Excel 2016 or later, Excel for Microsoft 365
  • .NET Framework: .NET Framework 4.0 or later

Installing the Excel Add-In

Download and install the Excel Add-In from the CData website by visiting the Excel Add-In download page. Fill in the appropriate contact information when prompted.

👁 Filling in contact info

Note: If you are downloading a licensed installer, use your company email address and license key.

  1. Run the installer and follow the setup wizard
  2. Once installation is complete, open Excel and verify that the CData tab appears in the Excel ribbon

Licensing the Excel Add-In

The Excel Add-In handles licensing during installation. When running the installer, you can choose to:

  • Use the trial license, or
  • Install a licensed build provided by CData

If you require a subscription license, contact the CData Orders Team at [email protected] to obtain your license key. Once the add-in is installed, it is ready for use.

Common Licensing Questions

Can I install the add-in on multiple machines?
Your subscription tier determines how many activations are included. Contact [email protected] for details.

I lost my license key. How do I retrieve it?
Email [email protected] with your order number, and we'll resend your license key.

How do I transfer my license?
To transfer the license to a different machine, you will need to submit a License Transfer Request on our site linked below:

https://www.cdata.com/lic/transfer/

After the License Transfer Request is submitted and successfully processed, an activation will be added to your Product Key and you will be able to activate the full license on the other machine. Once this process is finished, the license on the previous machine will be invalid.

For additional licensing questions, contact [email protected]. Viewing and upgrading your license can now be done through our self-service portal at portal.cdata.com.

Connection Configuration

Once the add-in is installed, you can configure a secure connection to Xero directly from the Excel ribbon. The add-in stores connection settings inside the Excel environment and uses them to fetch live Xero data.

Creating a New Connection

  1. Open Excel and navigate to the CData tab in the ribbon
  2. Click Get Data > From Xero. Then, click New Xero Connection to create a new connection
    3. 👁 Clicking button in Excel
  3. Provide a name for your connection and enable Update, Insert, or Delete operations as required
  4. The CData Connection dialog opens. Enter the authentication details required for Xero (OAuth, API token, credentials, etc.)

Configuring Connection Properties

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.

Testing your Connection

  1. Click Test Connection to validate your input
    2. 👁 Testing the connection
  2. Click OK to save the connection

Importing Data into Excel

After creating a connection, you can import Xero data into Excel using the built-in query interface.

Selecting Tables and Views

  1. From the CData ribbon, click Get Data > From Xero and choose the connection you just made
  2. The CData Query window opens. Click Select to choose a table or view
    3. 👁 Choosing a table
  3. Select your desired table and click OK

Running the Query

  1. A SQL query is automatically generated for your selected table
    2. 👁 Displaying a SQL Query
  2. Review the query (optional), then click OK to run it
  3. The results populate directly into your Excel worksheet
    4. 👁 Displaying Excel spreadsheet

You can now build pivot tables, charts, or use Excel formulas to analyze your Xero data.

Common Connection Issues

Authentication Failed

Solution: Verify your credentials or OAuth configuration. Ensure that your Xero account has the required API permissions.

Cannot Connect to Xero

Solution: Check your internet connection, firewall settings, or proxy configuration. Contact [email protected] for specific port requirements.

Table Not Found

Solution: Confirm your account has access to the selected Xero data object. Use the table selector in the Query window to browse available resources.

Query Returned No Results

Solution: Verify any filters or WHERE clauses in the generated SQL. Remove or adjust filters to broaden your query.

What's Next

Now that you have installed, licensed, and configured the Excel Add-In, explore how to automate reporting, refresh live dashboards, and build advanced queries using SQL or Excel functions.

Excel Add-InArticle Title
Microsoft ExcelTransfer Data from Excel to Xero

Get Support

If you need assistance at any point:

FAQs

Installation & Licensing

  • Does Excel require administrator rights to install the add-in?
    Administrative privileges are required for installation.
  • How do I activate a license?
    Licensing occurs during installation. Licensed installers automatically apply subscription keys.

Connecting

  • Can I use multiple Xero accounts?
    Each time you click Get Data, you can configure a new connection.
  • Can I connect through a proxy?
    You can configure proxy settings in the Connection dialog.

Performance & Troubleshooting

  • Why is my query slow?
    Add filters using the query editor or narrow the selected fields.
  • How do I enable logging?

    Add the following to your connection manager:

    • Logfile: /path/to/logfile.log
    • Verbosity: 3

    Be prepared to securely upload the log file upon request when reaching out to [email protected] for troubleshooting analysis.

  • How do I refresh data?
    Select the imported table and click Refresh from the CData ribbon.

For questions not covered in this FAQ, contact [email protected].

Ready to get started?

Download a free trial of the Excel Add-In for Xero to get started:

 Download Now

Learn more:

👁 Xero Icon
Excel Add-In for Xero

The Xero Excel Add-In is a powerful tool that allows you to connect with live Xero accounting data, directly from Microsoft Excel.

Use Excel to read, write, and update Xero Customers, Transactions, Invoices, Sales Receipts, etc. Perfect for mass imports / exports / updates, data cleansing & de-duplication, Excel based data analysis, and more!