Search API Connector Documentation
Import Xero Data to Google Sheets
In this guide, we’ll walk through how to pull Xero accounting data data directly into Google Sheets, using the API Connector add-on for Sheets.
- What Does This Integration Do?
- Before You Begin
- Part 1: Connect to the Xero API
- Part 2: Create Your Xero Request URL
- Part 3: Pull Xero API Data into Sheets
- Part 4: More Example API URLs
- Part 5: Handle Pagination
- Part 6: API Documentation
What Does This Integration Do?
This integration pulls accounting data from Xero's Accounting API into Google Sheets. It enables the following scopes:
Before You Begin
Click here to install the API Connector add-on from the Google Marketplace.
Part 1: Connect to the Xero API
If you haven't connected to the Xero API before, you'll first need to initiate the connection.
- Open up Google Sheets and click Extensions > API Connector > Manage Connections.
- In the list of available connections, find Xero and click Connect.
- You will be directed to Xero. Select your company and click Allow Access.
- You'll then be returned to your Google Sheet, and can verify that your Xero connection is active in the Connections screen.
Part 2: Create Your Xero API Request URL
For our first request, we'll get a list of invoices for your Xero account.
- API root: https://api.xero.com
- Endpoint: /api.xro/2.0/Invoices
Putting it all together, we get the full API Request URL.
Part 3: Pull Xero API Data into Sheets
Now let's enter that URL into API Connector.
- Back in the Create Request interface, enter the Request URL we just created above.
- Under OAuth, choose Xero from the dropdown menu. You should see the "Connected" badge
- You don't need any headers for this request so just leave that section blank.
- Create a new tab and click Set current to use that tab as your data destination.
- Name your request and click Run. A moment later you’ll see some invoice data populate your sheet.
- If you have multiple company accounts in Xero, you can add them by clicking the plus (+) sign, and then toggle between them using the dropdown account selector.
Part 4: Example API URLs
You can access the Xero Accounting API documentation here, but if you just want to get started, you can try the following example URLs.
- Bank Transactions
- P&L Report
for the P&L report, clean up the data with a JMESPath expression of
Part 5: Handle Pagination
Xero limits the number of records returned in each request. By default, only 100 records will be returned unless you use the 'page' parameter as described in their documentation.
To access more than 100 records, loop through pages automatically with pagination handling, like this:
- Pagination type:
- Page parameter:
- Run until: choose when to stop fetching data
Part 6: API Documentation
Official API documentation: https://developer.xero.com/documentation/api/api-overview
- How do I disconnect from Xero?
To disconnect from Xero, click the Manage Connections link and click Disconnect next to the Xero connection. You can also navigate to https://apps.xero.com/!XJG5x/ca/connected (or click your company dropdown > App Store > Connected Apps) and disconnect there.
- What doesn’t your integration do?
This integration does not push data from Google Sheets to Xero. It is a one-way connection that pulls data from Xero to Sheets.
- When and how does data get pulled into Sheets?
Data can be pulled into Sheets by opening your request and manually clicking Run, which will refresh your sheet with the latest data from Xero's API. Alternatively, you can enable scheduling and automatically refresh requests at the cadence you select (up to 1x an hour).
- Can I run scheduled updates more than once an hour?
Scheduled triggers can not run more than once an hour. This limit is set by Google.
- How much data can I pull into Sheets?
There is no specific limit on the amount of data you can pull from Xero's API into Google Sheets. However, Google Sheets only lets requests run for 6 minutes per execution, so very large requests may time out and fail to complete. If you experience issues, please limit requests where possible (e.g. use append mode to fetch new data instead of fetching the entire data set each time).