ODBC Driver for Xero

Build 22.0.8462

Windows DSN Configuration

Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

  1. Select Start > Search, and enter ODBC Data Sources in the Search box.
  2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
  3. Click the System DSN tab.
  4. Select the system data source and click Configure.
  5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

Connecting to a Xero API

The driver supports the following Xero APIs:

  • Accounting API: Set the Schema connection property to ACCOUNTING
  • Australian Payroll API: Set the Schema connection property to PAYROLLAUS
  • Files API: Set the Schema connection property to FILES
  • Fixed Assets API: Set the Schema connection property to ASSETS
  • Projects API: Set the Schema connection property to PROJECTS

It is also recommended that you set the Tenant property, which can be the name or ID of a Xero organization. Xero allows you to authorize the driver to access multiple organizations. By default the driver will pick the first one, which may not be the one you expect if the driver is granted access to additional organizations.

If you need to confirm what organizations the driver has access to, you can connect without an Tenant and read the Tenants view. This will provide both the ID and the name of each connected organization. You should use the ID to set the Tenant property when possible since multiple organizations can have the same name.

Authenticating to Xero

All connections to Xero are authenticated using OAuth. The driver supports using PKCE applications and OAuth applications. For desktop applications, the driver's embedded application is the simplest way to authenticate.

When the driver starts, it will open a browser and Xero will request your login information. The driver will use the credentials you provide to access your Xero data. These credentials will be saved and automatically refreshed as needed. For desktop applications, the driver's default application is the simplest way to authenticate.

When the driver starts, it will open a browser and Xero will request your login information. The driver will use the credentials you provide to access your Xero data. These credentials will be saved and automatically refreshed as needed.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462