Skip to main content

Xero Connections

Note

This feature may not be available in all product editions. For more information on available features, see Compare Editions.

Xero is cloud-based accounting software for small businesses. It performs bookkeeping functions such as invoicing and payroll and allows you to connect to a live bank feed. For more information, seehttps://www.xero.com/.

Tip

This connection is in early preview. It is read-only and available only in SaaS product editions. For more information on early previews, see Early Preview Connection Types.

Limitations and Requirements

Note

During normal selection or import of an entire table, you may encounter an error indicating a problem with a specific column. Since some tables require filtering based on a particular column, data from them can only be ingested using custom SQL statements. In this case, the problematic column can be used as a filter in the WHERE clause of a custom SQL statement to ingest the table.

  • For more information, please consult the CData driver documentation for the specific table.

  • For more information on using custom SQL, see Create Dataset with SQL.

Note

For filtering date columns, this connection type supports a set of literal functions on dates. You can use these to reduce the volume of data extracted from the database using a custom SQL query. For more information, see the pg_dateliteralfunctions.htm page in the driver documentation for this connection type.

Create Connection

via Designer Cloud application

When you create the connection, please review the following properties and specify them accordingly:

Connection Property

Description

Xero API

The following is the default value.

ACCOUNTING

The possible values are: ACCOUNTING, ASSETS, PAYROLLAUS, FILES, PROJECTS

Organisation

You can enter your preferred organisation name. This field is optional. You can leave it blank.

Connect String Options

The following default value sets the connection timeout in seconds:

Timeout=0;

Setting this value to 0 disables timeouts.

OAuth 2.0

The OAuth client is created and selected for you.

Note

When you create the connection in this window, you must click Authenticate, which authenticates to the app. This step is required.

Default Column Data Type Inference

Leave this value as Enabled.

For more information, see the driver documentation https://cdn.cdata.com/help/DXG/jdbc/default.htm.

Data Type Conversions

For more information, see the driver documentation https://cdn.cdata.com/help/DXG/jdbc/default.htm.