Learn more
 

Ready to get started?

Download a free trial of the Xero ODBC Driver to get started:

 Download Now

Learn more:

Xero Icon Xero ODBC Driver

The Xero ODBC Driver is a powerful tool that allows you to connect with live data from Xero accounting software , directly from any applications that support ODBC connectivity.

Access Xero data like you would a database - read, write, and update Xero Customers, Transactions, Invoices, Sales Receipts, etc. through a standard ODBC Driver interface.

In this article

Related articles

Connect to Xero Data in DBArtisan


Use wizards in DBArtisan to configure Xero data as a data source.

The CData ODBC Driver for Xero seamlessly integrates Xero data into database management tools like DBArtisan by enabling you to access Xero data as a database. This article shows how to create an data source for Xero in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Xero Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to 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 follow the steps below to register Xero data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic ODBC.
  3. Enter a name for the data source and select the DSN.
  4. Finish the wizard to connect to Xero data. Xero entities are displayed in the Datasource Explorer.

You can now work with Xero data as you work with any other database. See the driver help documentation for more information on the queries supported by the Xero API.