Xero
TARGET_SYSTEM: xero
Xero is a suite of online accounting software for small businesses, accountants, and bookkeepers.
Read | Create | Update | ||
---|---|---|---|---|
Accounts | ✅ | ✅ | ⌛ | |
Bills | ⌛ | ⌛ | ⌛ | |
Contacts | ❌ | ✅ | ✅ | |
Customers | ✅ | ❌ | ❌ | |
Credit notes | ⌛ | ⌛ | ⌛ | |
Expenses | ⌛ | ⌛ | ⌛ | |
Files | ⌛ | ⌛ | ⌛ | |
Invoices | ✅ | ✅ | ⌛ | |
Items | ⌛ | ⌛ | ⌛ | |
Journal entries | ✅ | ✅ | ⌛ | |
Suppliers | ✅ | ❌ | ❌ | |
Tracking categories | ✅ | ⌛ | ⌛ | |
Transactions | ⌛ | ✅ | ⌛ | |
Vendor credits | ⌛ | ⌛ | ⌛ |
✅ = Endpoint available
⌛ = Endpoint in progress
❌ = Endpoint not supported by Xero
How to connect to Xero
To allow your customers to link your application with their Xero accounts, you need to set up a Xero App and submit your application credentials to maesn.
Prerequisites
Before you begin, make sure you have the following:
- A Xero account with administrator permissions.
You can sign-up for a free trial at https://www.xero.com/signup/, if you do not have a Xero account already. Note that you will not need to use this Xero account for anything else than managing the Xero App and, if you want to, becoming a Xero partner later.
Create the Xero App
In this step we create the App that a user can choose to install into their Xero instance to authorize the integration with your application.
- Navigate to the Xero developer portal and log in, if you are not already logged in.
- On the tab “my Apps”, click “New App”.
- In the pop-up, enter the below details:
- App Name: This should be your application’s name. When your users link their Xero account, they will see that “App Name” is requesting to integrate with their Xero account.
- Integration Type: Web app.
- Company or application URL: The homepage of your company’s website, e.g. https://yourcompany.com/.
- Redirect URI: Should be set to https://api.maesn.dev/auth/callback/xero
Generate your client secret
Now it is time to generate the unique client secret for your App.
- Navigate to the Configuration tab of your newly created App
- Click the “Generate a secret” button.
- Note your
client id
, which you will need together with theclient secret
in subsequent steps. - Copy the
client secret
by clicking the Copy button next to the value. Make sure that you have copied the value before navigating away from this page. Once navigating away, you will not be able to retrieve it again.
Configure your integration in the maesn API
In the last step, we setup your API tenant with your App’s details:
- Get in touch with your contact person at maesn to submit the client id and client secret.
If you are not sure who your technical contact is, do not hesitate to reach out to us via support@maesn.com, but do not enter your client credentials directly in the email. That’s not safe!
Becoming a Xero Partner
Anyone can become a Xero app partner. The requirements and steps to become a partner are detailed here.
Note that it is only possible to link 25 Xero accounts to your app before it is certified through the app partnership process. In addition, your customers cannot link more than two applications that are not certified.
Was this page helpful?