> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/xero.md).

# Xero

## OAuth app properties

| Property                | Value                                                                                                                                                                                                               |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Multi-tenant**        | **Yes.** Any Xero organisation can connect, up to the connection limit of the app's plan.                                                                                                                           |
| **Vendor review**       | **Required** for more than 50 connections: App Certification (Plus plan and above), and a security assessment from the Advanced plan. Starter (5 connections) is free; Core (50) needs a payment method, no review. |
| **Review time**         | Not published.                                                                                                                                                                                                      |
| **Users before review** | 5 connections on Starter, 50 on Core (AUD 35 a month).                                                                                                                                                              |
| **App owner**           | Any Xero account. The plan and billing belong to the app.                                                                                                                                                           |
| **Regions**             | One app works worldwide.                                                                                                                                                                                            |
| **Client secret**       | No expiry documented.                                                                                                                                                                                               |
| **Rate limits**         | Per organisation: 5 calls at a time, 60 per minute, 1,000 per day (Starter) or 5,000 per day (Core and above). Per app: 10,000 per minute across all organisations.                                                 |
| **Checked**             | 2026-11-13                                                                                                                                                                                                          |

**Limitations**

* Every organisation a user selects on the consent screen counts as one connection. Once the plan's limit is reached, new connections fail until you disconnect old ones or move to a higher plan.
* An organisation can connect at most five uncertified apps.
* A refresh token that is not used for 60 days expires, and the account stops working. The user then connects it again.
* **List Journals** uses the Journals endpoint, a premium feature of the Advanced plan that needs a security assessment and use case approval.

Sources: [API limits](https://developer.xero.com/documentation/guides/oauth2/limits), [Pricing and policies](https://developer.xero.com/pricing), [FAQ](https://developer.xero.com/faq). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## Register the app

Go to <https://developer.xero.com/app/manage> and create a new app. Fill the application name and redirect URL (<https://api.appmixer.com/auth/xero/callback>).

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-1672701aae9f10d2807c2fecfbddc65f91b72e64%2Fxero-1.png?alt=media" alt=""><figcaption></figcaption></figure>

Get you *client ID* and *clientSecret* in the "Configuration" section

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-18c537583ad54419c416215bcd61532097958e5b%2Fxero-2.png?alt=media" alt=""><figcaption></figcaption></figure>

Set them in the Backoffice, see [Backoffice configuration](#backoffice-configuration).

## Webhooks

All trigger components (for example `NewInvoice`) use Xero webhooks. In order to use this component(s) in Appmixer, you have to register Appmixer's Xero URI in Xero first.

Go to [https://developer.xero.com/myapps](https://developer.xero.com/app) then choose your Appmixer app. Navigate to the "Webhooks" section and add a new webhook.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-2336922e966695a8a4f80aa78e2b5750ac0a3e58%2Fxero-4.png?alt=media" alt=""><figcaption><p>Xero Webhooks configuration</p></figcaption></figure>

Fill the field **Send notifications to** with `https://api.acme.appmixer.cloud/plugins/appmixer/xero/webhooks` (replace `acme` with your subdomain) and select the events you want to listen to.

For detailed steps, see [Xero documentation](https://developer.xero.com/documentation/guides/webhooks/creating-webhooks/).

Copy the **Webhooks key**. It goes into the `webhookKey` key of the Backoffice configuration.

## Backoffice configuration

Configuration ID: `appmixer:xero` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

* `clientId` — Client ID from the **Configuration** section of the Xero app registered above. Not needed when Xero is authenticated through the Appmixer Auth Hub.
* `clientSecret` — Client secret of the same app. Not needed with the Auth Hub.
* `webhookKey` — The **Webhooks key** from the **Webhooks** section of the Xero app. The plugin uses it to verify the `x-xero-signature` of every webhook; without it all webhook deliveries are rejected, so the triggers never fire. Only needed when a trigger is used.
* `requireListenerToken` — Optional. Set to `true` to reject triggers that register without an access token (triggers of older Xero connector versions). By default they are accepted and a warning is logged.
* `listCacheTTL` — Optional. How long, in milliseconds, the results of **ListContacts**, **ListAccounts**, **ListTenants** and **ListTrackingCategories** are cached for the inspector dropdowns. The cache is kept per connected user. Default `120000` (2 minutes).
* `outputFilePrefix` — Optional. File name prefix of the CSV file that **ListContacts**, **ListAccounts**, **ListTenants**, **ListTrackingCategories**, **ListJournals**, **FindManualJournals** and **FindPurchaseOrders** create when their output is set to a file; the file is named `<prefix>-<component name>.csv`. Default `xero-export`.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-d2aad1845fe0af69a33b41bb05902ab6f52667ac%2Fxero-3.png?alt=media" alt=""><figcaption></figcaption></figure>

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-3e3f1978fba1582eefb176a9989e57179a66f78d%2Fxero-5.png?alt=media" alt=""><figcaption><p>Appmixer BackOffice configuration for Xero Webhooks</p></figcaption></figure>

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:xero -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>",
  "webhookKey": "<webhooks key>"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/xero.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
