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

How to Query Xero Data in MySQL Workbench


Execute MySQL queries against live Xero data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Xero to query Xero data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Xero data in MySQL Workbench.

Connect to Xero Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Xero data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Xero from MySQL Workbench

The steps below outline connecting to the virtual Xero database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Xero data.

Connect to Xero through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Xero).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Xero Data

  1. Open the connection you just created (CData SQL Gateway for Xero).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Xero data, like SELECT * FROM `CData Xero Sys`.Items;

With access to live Xero data from MySQL Workbench, you can easily query and update Xero, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Xero and the CData SQL Gateway.