Connect Kompass to Xero
Overview
This article explains how to connect your Kompass account to Xero for automatic syncing of clients and invoices. Only admin users can set up and manage the Xero connection.
Prerequisites
- A Xero account with access to the organisation you wish to connect
- Admin access to your Kompass account
Step 1: Create a Xero Configuration
- Navigate to the Admin site by adding /admin after your Kompass URL (e.g. your-server.kompassbms.com/admin).
- Under the Xero group, select Configurations.
- Click Add in the top right to create a new configuration.
- Select the Kompass organisation(s) that should be linked to this Xero connection.
- Click Save.
Step 2: Authorise with Xero
- On the Configurations list page, select the configuration you just created using the tick-box.
- From the Action drop-down menu, select Authorize with Xero and click Go.
- You will be redirected to the Xero login page. Sign in with your Xero credentials.
- Xero will ask you to select which Xero organisation to authorise. Choose the organisation you wish to connect.
- Review the permissions Kompass is requesting and click Allow access.
- You will be redirected back to the Kompass Admin with a success message.
If you authorise multiple Xero organisations, Kompass will automatically select the first one. To use a different organisation, disconnect and re-authorise with only the desired organisation selected.
Step 3: Configure Sync Settings
Before enabling the sync, you must complete the following configuration:
- Open the configuration you created and set the Account default; this is the Xero account used for all invoice syncs.
- Under Sync modules, select the modules you wish to sync:
- Clients: syncs Kompass clients as Xero contacts
- Invoices: syncs Kompass invoices as Xero invoices, credit notes, or manual journals
- If you enable Invoices, you must also enable Clients.
- Tick the Enable checkbox to activate the connection.
- Click Save.
Step 4: Map Items, Accounts, and Tax Rates (Optional)
For more accurate invoice syncing, you can configure additional mappings in the Admin under Xero:
- Items: map Kompass departments/services to Xero items. You can also set a default item as a fallback.
- Accounts: map Kompass nominal accounts to Xero general ledger accounts.
- Tax rates: link Kompass VAT rates to Xero tax types.
Disconnecting from Xero
If you need to disconnect your Xero integration:
- Go to Xero → Configurations.
- Select the configuration using the tick-box.
- From the Action drop-down, select Disconnect from Xero and click Go.
- Confirm the disconnection when prompted.
The sync will stop immediately. You can re-authorise at any time by following Step 2 again.