Klips: Connecting to Xero

 

If you want to create data sources for custom Klips, you're in the right place.

If you want to add pre-built Klips, see Pre-built Klips and the Klip Gallery and Klip Gallery: Xero.

If you're using PowerMetrics and want to create data sources for custom metrics, go here.

 

Visualize, discover, and act on your data with Klips and Klip dashboards.

Ready to get the most from your Xero accounting data? Get started by setting up a connection between Klipfolio and your Xero data and adding some data sources.

When you're finished adding Xero data sources, you'll use them to power your custom Klips.

This article includes:

Connecting to your Xero data

Here are a couple things to note about connecting Klipfolio to your Xero data:

Your data is safe with us. The first time you connect your Xero data to Klipfolio, you'll be prompted to sign in to Xero and give permission to allow Klipfolio to securely access data within your Xero account. We are serious about protecting your data privacy.

Managing your connections. By default, your connection name looks like this: yourname@Xero <date and time created>. You can modify the default connection name when you create a new connection or from your list of connections, accessed by clicking your Account Name (located at the bottom of the left navigation sidebar) and selecting Account > Connected Accounts or by clicking the button in the left navigation sidebar and selecting Connections.

You can use and reuse the same account connection every time you connect to Xero. If you have trouble accessing an existing connection, your OAuth token may have expired. If that happens to you, check out these troubleshooting tips.

Adding a Xero pre-built data source

Our pre-built data sources focus on the most sought-after Xero data. Either use them as complete solutions or as starting points for custom building.

To add a Xero pre-built data source:

  1. Click the + beside Data Sources in the left navigation sidebar.

If you don’t see the option above, go to the bottom of the left navigation sidebar and click your Account Name > Data Sources > Create a New Data Source.

  1. On the Where is your data? page, select Xero.
  2. Select a pre-built data source from the left section of the Choose a pre-built or custom connection page.
  3. If this is your first time connecting to Xero:
    • Click Connect an account. Enter your Xero login credentials and click Log in. To confirm the organization you want data for is now connected to Klipfolio, click the drop-down arrow at Select another organisation, where it will be listed under “Already connected”. Click Continue.  When prompted, name the new connection and click Apply. Click Continue to enter the Configure your data source page.
  4. If you have connected with Xero before:
    • Select an existing connection from the drop-down list and click Continue.
  5. At Connected Organization(s), click the drop-down arrow and select the organization for which you want to get data.
  6. Choose the Data Format in which you would like your data to be returned: XML, CSV, or JSON.
  7. If you chose CSV, select from the Summary and Detailed report options.

A summary report returns aggregated results. A detailed report breaks down the transaction by individual entries.

  1. Click Get data.
  2. Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your dataLearn more about modelling your data source. Note: If you selected JSON or XML as your data format, go here to learn how to model your data.
  3. Click Continue.
  4. Name, choose refresh settings, and, optionally, share your data source.
  5. Click Save.

The data source is added to your account and is ready to use for custom Klips. You can see all your data sources in your Data Source Library, accessed by clicking Data Sources in the left navigation sidebar.

Adding a Xero custom data source

Need a unique set of data? When our pre-built data sources don't include exactly what you're looking for, create your own custom data source. You can either use a pre-built data source query as a base or write your own queries from scratch.

To add a Xero custom data source:

  1. Click the + beside Data Sources in the left navigation sidebar.

If you don’t see the option above, go to the bottom of the left navigation sidebar and click your Account Name > Data Sources > Create a New Data Source.

  1. On the Where is your data? page, select Xero.
  2. On the Choose a pre-built or custom connection page, click Create a custom Xero data source.
  3. If this is your first time connecting to Xero:
    • Click Connect an account. Enter your Xero login credentials and click Log in. To confirm the organization you want data for is now connected to Klipfolio, click the drop-down arrow at Select another organisation, where it will be listed under “Already connected”. Click Continue. When prompted, name the new connection and click Apply. Click Continue to enter the Configure your data source page.
  4. If you have connected with Xero before:
    • Select an existing connection from the drop-down list and click Continue.
  5. At Connected Organization(s), click the drop-down arrow and select the organization for which you want to get data.
  6. Edit the Query URL to return the data you need. Refer to the Xero API documentation.
  7. Choose the Data Format in which you would like your data to be returned: XML, CSV, or JSON.
  8. If you chose CSV, select from the Summary and Detailed report options.

A summary report returns aggregated results. A detailed report breaks down the transaction by individual entries.

  1. Click Get data.
  2. Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source. Note: If you selected JSON or XML as your data format, go here to learn how to model your data.
  3. Click Continue.
  4. Name, choose refresh settings, and, optionally, share your data source.
  5. Click Save.

The data source is added to your account and is ready to use for custom Klips. You can see all your data sources in your Data Source Library, accessed by clicking Data Sources in the left navigation sidebar.

Custom building: About APIs and queries

Want to learn more about custom building? This section is for you. Klipfolio connects to hundreds of services in the cloud that have a REST API. If you take the time to learn your service’s API to create queries for the data you want, your possibilities are endless. Here’s a quick overview video on APIs and Klipfolio:

Klipfolio API's 101

If you need help using APIs, ask a data analyst or developer.

Refer to the Xero API documentation to discover more data requests.

See the reference table below for API related information and sample queries.

API Documentation

Xero API Documentation

Authentication Method OAuth Authentication
Response Format JSON, XML, CSV (supported for Reports endpoint only)

API Limits and Notes

Xero returns a maximum of 100 records per query. To retrieve a specific set of records, specify a date range in the query or, to retrieve more records, pagination (supported only for certain endpoints) is required.

Pagination Method

Xero returns a maximum of 100 records per query and only certain endpoints (such as invoices and contacts) support pagination. Use the page parameter to retrieve more than 100 records, for example page=2.

Note that Xero does not provide a count of the total number of records, so it is necessary to know in advance how many pages to request.

Refer to Data Sources with Multiple Pages for details on how to handle pagination.

Date Format

Example date format:

fromDate={date.add(-30).format()}&toDate={date.add(-1).format()}

Note that date formats are supported for the Xero connector as a header parameter.

Sample Queries

In Klipfolio, Xero API queries use the base URL:

https://api.xero.com/

Examples:

https://api.xero.com/api.xro/2.0/Reports/ProfitandLoss?fromDate={date.add(-30).format()}&toDate={date.add(-1).format()}

https://api.xero.com/api.xro/2.0/accounts

Next steps

Great! You've connected to your Xero data and created one (or more) data sources. Now you're ready to use those data sources in custom Klips.

Want to learn more?

Check out these related articles:

Have more questions? Submit a request