This document is a step-by-step guide for setting up the Xero integration within BrightGauge.

Connect to Xero

To connect to Xero:

1. Log in to your BrightGauge account.
2. Navigate to DATA > Datasources.
   
3. Click Add a New Datasource.
4. Under the All tab, find and select Xero.
5. Click Connect to Xero. If you are not already logged in to Xero, you are prompted to log in.
6. Allow BrightGauge access to your Xero company file. After authentication, the window closes and a successful test connection shows in BrightGauge.
7. Enter a Name for the datasource.
8. Click Save. Dashboards, reports, datasets, and gauges begin syncing after the datasource is saved. The sync typically takes 20 to 30 minutes to complete.

Default Resources

BrightGauge provides the following dashboards and reports for the Xero datasource.

For a list of default gauges, click Gauges from the top menu bar in BrightGauge.

Default Dashboards

• BGS - Accounts Overview
• BGS - Financials Overview
• BGS - Invoices and Bills

Default Reports

• BGS - Financials Overview
• Quarterly Financial Review
• Weekly Account Review

Default Datasets

• Balance Sheet
• Bill Line Items 
• Bills
• Invoice Line Items
• Invoices
• Profit and Loss
• Purchase Order Line Items
• Purchase Orders

Data Diagram

After you connect the datasource, the datasets, gauges, and dashboards are loaded into your account. All data is a one-way sync from Xero.  BrightGauge does not alter any data within Xero.

All of the gauges have descriptions in them to help you understand what they are about.  To help you better understand the datasets, here's a data diagram:

FAQs

How often does the data sync?

The datasets sync by default each day at midnight your timezone.

If you have a dashboard up with the Xero gauges, then the data syncs every 8 hours. This limitation is to not overload the Xero API.  If you have a report scheduled to be sent out, the data will refresh the hour before the report goes out. View the documentation to learn more about dataset syncing.

How do I remove the Xero datasource?

If you ever want to remove Xero data from BrightGauge, navigate to the Xero datasource in your datasources page and click Delete.  After you confirm the deletion, everything is permanently deleted. There is no way to recover deleted setups in BrightGauge.

This only deletes the information within BrightGauge. You can reconnect Xero as a datasource at any time to start the integration over.

Who do I contact if I have a suggestion for this integration?

If you want other parts of the Xero app to be included in BrightGauge, let us know! Please contact Support by selecting Help > Open a Ticket from the top menu bar. Because this is an API integration, we will need to do some investigation into feasibility.

If you have any questions, please contact Support by selecting Help > Open a Ticket from the top menu bar.