How do I connect Klipfolio and Xero?

You can set up a connection between Klipfolio and your Xero data to display your accounting metrics on a dashboard.

This article includes:

What options do I have for visualizing my Xero data?

Create data visualizations based on pre-built options or build your own. The choice is yours!

Pre-built by Klipfolio

In collaboration with industry experts and adhering to current best practices and trends, Klipfolio focuses on getting the most out of your data and presenting it in meaningful, actionable visualizations. Our pre-built content, including pre-built data sources and pre-built Klips, can act as a complete solution or as a starting point toward custom building.

  • Xero pre-built data sources: Data sources provide the foundation for Klip building, so we suggest you create a data source as a first step (before building Klips and adding them to your dashboard). Our pre-built data sources focus on the most sought-after Xero data and are found on the Service Connectors page, available from this link or from your list of data sources. When you select a service connector from this page, the data source for that service is automatically added.

  • Xero pre-built Klips: Pre-built Klips enable you to quickly set up a dashboard using predefined visualizations that display common key metrics. Pre-built Klips are found in the Klip Gallery or, for White Label customers, in the Integration Gallery.

Custom-built by you

Taking the time to learn how to create your own data sources and Klips unlocks your data and enables you to control, manipulate, and transform it, leading you to unprecedented insights into your business.

  • Custom data sources: When you create a custom data source, you can either use the pre-built data source as a starting point from which to write your own query or you can write your own queries from the ground up and build a data source from scratch. You create custom-built data sources from the Service Connectors page, accessible from this link or from your list of data sources.

  • Custom Klips: Using our Klip Editor, you can construct and manipulate your data, including integrating multiple data sources, to produce unique, custom-built data visualizations. You create custom Klips from either your list of Klips or your Dashboard.

 

Regardless of whether you choose pre-built, custom-built, or a combination of both, before you can start building Klips and dashboards you need to connect to Xero data in Klipfolio.

How do I connect to Xero data in Klipfolio?

When you connect your Xero data to Klipfolio, you will be prompted to connect your Xero account by entering your username and password.

Doing so will create a token that enables Klipfolio to securely access your Xero account. Your token looks like George@Xero. You can use and reuse the same token every time you connect to Xero.

Note: You manage your connections (tokens) to Xero in Klipfolio under Connected Accounts in the Account section.

How do I add a Xero pre-built data source?

To add a Xero pre-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose Xero from the list.
  2. Select a pre-built data source from the left section of the Pick a Data Request page.
  3. If this is your first time connecting to Xero:
    • Click Connect an Account. Enter your Xero login credentials and click Next. If prompted, click Allow Access to enable Klipfolio to securely access your Xero data. Click Next Step.
  4. If you have connected with Xero before:
    • Select an existing connection (token) from the drop-down list and click Next Step.
  5. Choose the Data Format in which you would like your data to be returned: XML, CSV, or JSON.
  6. 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 Submit.

How do I add Xero pre-built Klips?

In the Klip Gallery or, for White Label customers, in the Integration Gallery you can browse individual Xero pre-built Klips and add them to your dashboard. You replace the sample data that is included in pre-built Klips with your own Xero data by clicking the menu in the Klip and selecting Connect your data.

How do I create a Xero custom-built data source?

To create a Xero custom-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose Xero from the list.
  2. On the Pick a Data Request 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 Next. If prompted, click Allow Access to enable Klipfolio to securely access your Xero data. Click Next Step.
  4. If you have connected with Xero before:
    • Select an existing connection (token) from the drop-down list and click Next Step.
  5. Edit the Query URL to return the data you need. Refer to the Xero API documentation.
  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 Submit.

If you want to edit a data source that you already created, check out How to edit or reconfigure a data source, and get step-by-step instructions.

How do I create a Xero data source from scratch?

You can choose to build a data source from scratch. 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 assistance using APIs, enlist a data analyst or developer.

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

When you are happy with your query, click Submit, and then save and name your new data source. You're now ready to use it to build a Xero Klip.

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

API Documentation Xero API documentation

Authentication Method

OAuth Token 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()}

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

How do I create a Xero custom Klip?

You create custom Klips from either your list of Klips or your Dashboard. You choose a data visualization format, for example, a pie chart, gauge, or table, and decide whether you want to use an existing data source or create a new one. In the Klip Editor, there are limitless opportunities to modify, relate, and display your data. See the following related articles for more information and get building!

Related Links