The Marketplacer platform can automatically send remittance notifications to Xero after completing your Xero Settings configuration.
These are the topics in this article:
- Xero integration settings
- Configure Xero OAuth2 API integration
- Create a Xero OAuth2 App
- Set up Xero OAuth 2.0 in Marketplacer
Xero integration settings
Enable Xero integration
Select the Enable Xero integration checkbox to enable the Marketplacer platform to send remittance notifications to Xero. If the Xero integration is not enabled, nothing is validated and you can leave the fields in the Xero section blank.
Account Code
The key in the account code to which you want your remittances to go.
To view your account code in Xero:
- Select Accounting on the menu bar at the top.
- Select Chart of accounts.
- From the list, select which account you want your remittances to go to.
- Enter the code for the account in the Account Code field in Marketplacer.
Note: The account type has to be "expense" because the remittances come through as unpaid bills. The integration does not work with a "revenue" account type.
Bank Details Prefix
The Bank Details Prefix field is optional. This field prefixes the string entered in the field to each seller's bank details sent to Xero. This is useful if you plan to export to Excel, which requires an additional string. This also helps ensure leading zeros are not omitted.
Bank Details Prefix is optional if the Xero integration is enabled and the account code, line amount type, client ID, and client secret must be provided. There is a max length validation and tenant ID must be provided if there are tenants.
Specify Tax & Line Account Type
- Specify tax: If this checkbox is not selected, the tax is assumed and is in a separate line item.
- Line Account Type: The option you selected here is reflected in the remittance invoice line amount types field in Xero. You must define if your line types are tax-inclusive or not (NoTax).
Enable Xero OAuth2 integration
OAuth 2.0 is a protocol that lets your app access a user's account without accessing their password. Essentially this option provides a more modern and secure integration to Xero and is highly recommended. Optionally, you can enter the OAuth2 Client ID and OAuth2 Client Secret in this section.
Configure Xero OAuth2 API integration
OAuth 2.0 is a protocol that lets your app access a user's account without accessing their password. It provides a secure integration to Xero. You must go through this process when:
- You’re setting up the integration for the first time.
- Anytime the integration is interrupted.
Create a Xero OAuth2 App
- Go to https://developer.xero.com/myapps/ and sign in using your Xero credentials.
- Select New App.
- Add an app name (for example, Marketplace) and select Auth code.
- Add your domain (for example, https://www.marketplacer.com) as the Company or Application URL.
- Complete the OAuth2.0 redirect_url field.
Example: Your marketplace domain is "https://www.bikeexchange.com.au". Followed by "/administration/app_config/external_account_settings/xero_authorization_callback.
“https”. The complete URL looks like this: "https://www.bikeexchange.com.au/administration/app_config/external_account_settings/xero_authorization_callback"
Note: If you are not live yet, the URL must be the Marketplacer URL without "www". The suggested URL is displayed on the screen. - Click Create app.
- Go to the new app details.
- Generate a client secret and copy it somewhere.
Note: The client secret is ONLY visible once, so you must copy it immediately. - Likewise, copy the client id.
Set up Xero OAuth 2.0 in Marketplacer
After setting up your OAuth 2.0 connection within Xero, connect to it through the Marketplacer admin.
- Sign in to your Marketplacer admin account and go to CONFIGURATION > External Account Settings.
- Scroll down to the Xero Settings section.
- Select Enable Xero integration.
- Paste the client id and client secret from your text document into the respective fields.
- Click Submit.
- Refresh the page.
- Follow the link in the next section.
- The link opens a page in Xero. After you sign in, select an organization. Select the organization to which you want to grant permission to Marketplacer.
- Complete the final steps. You will be redirected back to the Marketplacer admin and see a confirmation indicating the setup is successful.
If you are having issues with setting up Xero, refer to this article for troubleshooting tips and recommended resolutions.
Related articles