The comprehensive dashboards and smart Business Intelligence (BI) solutions that come with Xero's integration with MSPbots provide MSP businesses with more opportunities to grow and enhance business management. This article is your guide for setting up this integration so that you can start utilizing MSPbots automation with Xero to get books done faster and to track bills and payments, inventory, invoicing, purchase orders, and reporting more efficiently.
Prerequisites
You must have the following to ensure a successful connection between MSPbots and Xero:
- A standard or advisor role to your account in the Xero app
- Admin role for modifying the settings in the MSPbots app
Data flow diagram
MSPbots sync customer data from Xero through the following interfaces, and once synced to MSPbots, they are displayed in datasets, widgets, bots and dashboards.
- account.settings
- accounting.contacts
- accounting.transactions
- accounting.reports.read
How to connect Xero to MSPbots
- Log in to the MSPbots app as an admin and go to Integrations.
-
In the Integrations window, search for Xero and click it to open the connection settings.
As an alternative, go to the Categories section on the side menu, select Accounting, and click Xero.
-
Next, click Save and Sync to authorize MSPbots to connect to your Xero company files. This action will open the login page for Xero. If you are already logged in, you will be directed straight to the Xero application.
- When the Log in to Xero pop-up opens, enter your Xero Email address and Password and click Log in.
- Enter the authentication code and click Confirm.
- Select an organisation you want MSPbots to access and click Allow access.
- You have successfully connected MSPbots to Xero when the pop-up with the message MSPbots Xero oauth redirect success! appears.
-
Go back to Integrations on the MSPbots app to verify your connection. The status Success should be displayed beside Xero.
The data sync should be completed within 20-30 minutes. Once the data source is saved, the dashboard, reports, datasets, and pointers will be added to your account.
(Optional) How to set permissions for Xero integration
If you have specific requirements, selectable permissions can be configured.
If you want to know the descriptions of each permission, refer to Description of Xero Permissions.
- Log in to the MSPbots app as an admin and go to Integrations.
- In the Integrations window, search for Xero.
- Click
and select Permission.
- Click the Permission List dropdown, and select the permissions that users belonging to your company need to have.
- The permission displayed as
when hovering over is a default permission that is checked and cannot be configured.
- The permission displayed as
when hovering over is a selectable permission.
- The permission displayed as
- When Success appears, it means you have successfully configured.
-
To apply your settings successfully, repeat steps 3 to 8 in the How to connect Xero to MSPbots chapter to reconnect the Xero integration.
FAQs
1. How to disconnect from Xero?
- In the Integrations window, search for Xero.
- Click the
button, and select Remove.
- Click Remove.
2. When and how does data sync occur?
We automatically synchronize customer data in Xero.
To check sync datails:
- Click the
- Check the sync details for each API. For more information, see Checking API Sync Details.
3. If you want to use the Xero Budgets, Xero Journals, or Xero Payroll Employees V1 APIs, or if you encounter sync failures with these APIs, what should you do?
Refer to How to set permissions for Xero integration to select the following permissions, as the permissions for the Xero Budgets, Xero Journals, and Xero Payroll Employees V1 APIs are not checked by default.
- accounting.budgets.read
- accounting.journals.read
- payroll.employees.read
Description of Xero Permissions
|
No. |
Permission |
Status |
Xero Offical Description |
Usage in MSPbots |
| 1 | offline_access | Checked by default |
To get a refresh token, you must request the offline_access scope. A refresh token allows you to refresh your access token and maintain an offline connection. |
Basic permission, allows MSPbots to call Microsoft APIs persistently, enabling further automation of syncing user information. After the tenant authorize Xero integration in MSPbots, there is no need for repeated authorization. MSPbots will automatically sync the latest information of all users in that tenant. |
| 2 |
accounting.settings. read |
Checked by default |
View your organisation settings. |
After the tenant authorizes Xero integration, allows MSPbots to read your organization settings information of all users in the current tenant, including accounts, branding themes, currencies, employees, items, invoice reminders, organizations, tax rates, tracking categories, and users. |
| 3 |
accounting.reports. read |
Checked by default |
View your reports. |
After the tenant authorizes Xero integration, allows MSPbots to read the reports information of all users in the current tenant, including accounts payable listed by contact, accounts receivable listed by contact, balance sheet, bank summary, BAS report, budget summary, executive summary, GST report, profit and loss statement, and trial balance. |
| 4 |
accounting.contacts. read |
Checked by default |
View your contacts. |
After the tenant authorizes Xero integration, allows MSPbots to read contacts and contact groups of all users in the current tenant. |
| 5 |
accounting. transactions |
Checked by default |
View and manage your business transactions.
|
After the tenant authorizes Xero integration, allows MSPbots to read business transactions of all users in the current tenant, including bank transactions, bank transfers, batch payments, credit notes, expense claims, invoices, related transactions, manual journals, overpayments, quotes, payments, prepayments, purchase orders, receipts, and repeating invoices. |
| 6 |
payroll.employees. read |
Optional |
View your employees. |
After the tenant authorizes Xero integration, allows MSPbots to read employees and leave application information of all users in the current tenant. |
| 7 |
accounting.journals. read |
Optional |
View your general ledger. |
After the tenant authorizes Xero integration, allows MSPbots to read the journals of all users in the current tenant. |
| 8 |
accounting.budgets.read |
Optional |
View your budgets |
After the tenant authorizes Xero integration, allows MSPbots to read the budgets of all users in the current tenant. |
4. Descriptions for Xero Profit and Loss Report
- If the profit and loss report is run on the default accrual basis, the date is the assigned date of the document.
- If the profit and loss report includes the parameter paymentsonly=true, the report date is based on the assigned date of the payment transaction.