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

Viewing Xero Data in RAD Studio Data Explorer


How to view Xero data in RAD Studio Data Explorer using the CData ODBC Driver for Xero.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Xero, you gain access to live Xero data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve and update Xero data. This article will walk through connecting to Xero using the Data Explorer.

Configure a Connection to Xero

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.

Connecting to Xero Data Using Data Explorer

You can create a simple application for displaying Xero data by utilizing the CData FireDAC Components for Xero and a new VCL Forms Application:

  1. Open the Data Explorer in RAD Studio and expand FireDAC.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Xero.
  6. Back in the Data Explorer, expand the tables for the connection.

  7. Create a new VCL Forms application and drag a table (for example: Items) onto the form.

  8. Select the ItemsTable object on the form and set the Active property to true.

  9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

  10. Arrange the TStringGrid on the form and run the application to see the Items data.