> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Xero

> How to set up the Xero connector, plus the actions and events that are available.

![Xero](https://stackone-logos.com/api/xero/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/xero/changelog.md)

[77 actions](#actions) · [12 events](#events) · 1 auth method

Accounting
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/xero/guides/connector-profile/oauth-2-0.md)
>
> Login to your Xero account to connect your data.

Optionally, configure receiving Events for Xero into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/xero/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/xero/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounting.banktransactions

accounting.banktransactions.read

accounting.contacts

accounting.contacts.read

accounting.invoices

accounting.invoices.read

accounting.journals.read

accounting.manualjournals

accounting.manualjournals.read

accounting.payments

accounting.payments.read

accounting.reports.aged.read

accounting.reports.balancesheet.read

accounting.reports.banksummary.read

accounting.reports.budgetsummary.read

accounting.reports.executivesummary.read

accounting.reports.profitandloss.read

accounting.reports.trialbalance.read

accounting.settings

accounting.settings.read

offline\_access

openid

No scopes found

77 actions

ActionDescriptionRequired scopes

List Accounts`xero_list_accounts`

Retrieve the chart of accounts

`accounting.settings.read`

Get Account`xero_get_account`

Retrieve a single account by ID

`accounting.settings.read`

Create Account`xero_create_account`

Create a new account in the chart of accounts

`accounting.settings`

Update Account`xero_update_account`

Update an existing account

`accounting.settings`

Delete Account`xero_delete_account`

Delete an account from the chart of accounts

`accounting.settings`

List Bank Transactions`xero_list_bank_transactions`

Retrieve a list of bank transactions

`accounting.banktransactions.read`

Get Bank Transaction`xero_get_bank_transaction`

Retrieve a single bank transaction by ID

`accounting.banktransactions.read`

Create Bank Transaction`xero_create_bank_transaction`

Create a spend or receive money bank transaction

`accounting.banktransactions`

Update Bank Transaction`xero_update_bank_transaction`

Update an existing spend or receive money transaction

`accounting.banktransactions`

Delete Bank Transaction`xero_delete_bank_transaction`

Delete a spend or receive money transaction

`accounting.banktransactions`

List Branding Themes`xero_list_branding_themes`

Retrieve a list of branding themes

`accounting.settings.read`

Get Branding Theme`xero_get_branding_theme`

Retrieve a single branding theme by ID

`accounting.settings.read`

List Companies`xero_list_companies`

List all companies (organisations) connected to the Xero account

`openid``offline_access`

List Contacts`xero_list_contacts`

Retrieve a list of contacts with optional filtering and pagination

`accounting.contacts.read`

Get Contact`xero_get_contact`

Retrieve a single contact by ID

`accounting.contacts.read`

Create Contact`xero_create_contact`

Create a new contact

`accounting.contacts`

Update Contact`xero_update_contact`

Update an existing contact

`accounting.contacts`

List Credit Notes`xero_list_credit_notes`

Retrieve a list of credit notes

`accounting.invoices.read`

Get Credit Note`xero_get_credit_note`

Retrieve a single credit note by ID

`accounting.invoices.read`

Create Credit Note`xero_create_credit_note`

Create a credit note

`accounting.invoices`

Update Credit Note`xero_update_credit_note`

Update an existing credit note

`accounting.invoices`

Get Unified Credentials`xero_unified_get_me`

Get the current Xero connection's unified credentials and identity.

`accounting.settings.read`

List Unified Organizations`xero_unified_list_organizations`

List unified organizations in Xero.

`accounting.settings.read`

Get Unified Organization`xero_unified_get_organization`

Get a unified Xero organization by ID.

`accounting.settings.read`

List Unified Roles`xero_unified_list_roles`

List unified roles in Xero.

`accounting.settings.read`

Get Unified Role`xero_unified_get_role`

Get a unified Xero role by ID.

`accounting.settings.read`

List Unified Users`xero_unified_list_users`

List unified users in Xero.

`accounting.settings.read`

Get Unified User`xero_unified_get_user`

Get a unified Xero user by ID.

`accounting.settings.read`

List Invoices`xero_list_invoices`

Retrieve a list of invoices with optional filtering and pagination

`accounting.invoices.read`

Get Invoice`xero_get_invoice`

Retrieve a single invoice by ID

`accounting.invoices.read`

Create Invoice`xero_create_invoice`

Create one or more invoices

`accounting.invoices`

Update Invoice`xero_update_invoice`

Update an existing invoice

`accounting.invoices`

Get Online Invoice URL`xero_get_online_invoice_url`

Retrieve the online invoice URL for a sales invoice

`accounting.invoices.read`

List Items`xero_list_items`

Retrieve a list of items (products/services)

`accounting.settings.read`

Get Item`xero_get_item`

Retrieve a single item by ID or Code

`accounting.settings.read`

Create Item`xero_create_item`

Create a new item (product/service)

`accounting.settings`

Update Item`xero_update_item`

Update an existing item

`accounting.settings`

Delete Item`xero_delete_item`

Delete an item

`accounting.settings`

List Journals`xero_list_journals`

Retrieve a list of journals

`accounting.journals.read`

Get Journal`xero_get_journal`

Retrieve a single journal by ID or number

`accounting.journals.read`

List Manual Journals`xero_list_manual_journals`

Retrieve a list of manual journals

`accounting.manualjournals.read`

Get Manual Journal`xero_get_manual_journal`

Retrieve a single manual journal by ID

`accounting.manualjournals.read`

Create Manual Journal`xero_create_manual_journal`

Create a new manual journal

`accounting.manualjournals`

Update Manual Journal`xero_update_manual_journal`

Update an existing manual journal

`accounting.manualjournals`

Get Organisation`xero_get_organisation`

Retrieve organisation details

`accounting.settings.read`

List Payments`xero_list_payments`

Retrieve a list of payments

`accounting.payments.read`

Get Payment`xero_get_payment`

Retrieve a single payment by ID

`accounting.payments.read`

Create Payment`xero_create_payment`

Create a payment for an invoice, credit note, prepayment, or overpayment

`accounting.payments`

Delete Payment`xero_delete_payment`

Delete (reverse) a payment

`accounting.payments`

List Purchase Orders`xero_list_purchase_orders`

Retrieve a list of purchase orders

`accounting.invoices.read`

Get Purchase Order`xero_get_purchase_order`

Retrieve a single purchase order by ID or number

`accounting.invoices.read`

Create Purchase Order`xero_create_purchase_order`

Create a new purchase order

`accounting.invoices`

Update Purchase Order`xero_update_purchase_order`

Update an existing purchase order

`accounting.invoices`

List Quotes`xero_list_quotes`

Retrieve a list of quotes

`accounting.invoices.read`

Get Quote`xero_get_quote`

Retrieve a single quote by ID

`accounting.invoices.read`

Create Quote`xero_create_quote`

Create a new quote

`accounting.invoices`

Update Quote`xero_update_quote`

Update an existing quote

`accounting.invoices`

Get Balance Sheet`xero_get_balance_sheet`

Retrieve the Balance Sheet report

`accounting.reports.balancesheet.read`

Get Profit And Loss`xero_get_profit_and_loss`

Retrieve the Profit and Loss report

`accounting.reports.profitandloss.read`

Get Trial Balance`xero_get_trial_balance`

Retrieve the Trial Balance report

`accounting.reports.trialbalance.read`

Get Aged Receivables`xero_get_aged_receivables`

Retrieve the Aged Receivables by Contact report

`accounting.reports.aged.read`

Get Aged Payables`xero_get_aged_payables`

Retrieve the Aged Payables by Contact report

`accounting.reports.aged.read`

Get Bank Summary`xero_get_bank_summary`

Retrieve the Bank Summary report

`accounting.reports.banksummary.read`

Get Budget Summary`xero_get_budget_summary`

Retrieve the Budget Summary report

`accounting.reports.budgetsummary.read`

Get Executive Summary`xero_get_executive_summary`

Retrieve the Executive Summary report

`accounting.reports.executivesummary.read`

List Tax Rates`xero_list_tax_rates`

Retrieve a list of tax rates

`accounting.settings.read`

Get Tax Rate`xero_get_tax_rate`

Retrieve a tax rate by tax type

`accounting.settings.read`

List Tracking Categories`xero_list_tracking_categories`

Retrieve a list of tracking categories

`accounting.settings.read`

Get Tracking Category`xero_get_tracking_category`

Retrieve a single tracking category by ID

`accounting.settings.read`

Create Tracking Category`xero_create_tracking_category`

Create a new tracking category

`accounting.settings`

Create Tracking Option`xero_create_tracking_option`

Create a new tracking option within a category

`accounting.settings`

Update Tracking Category`xero_update_tracking_category`

Update an existing tracking category

`accounting.settings`

Update Tracking Option`xero_update_tracking_option`

Update an existing tracking option

`accounting.settings`

Delete Tracking Category`xero_delete_tracking_category`

Delete a tracking category

`accounting.settings`

Delete Tracking Option`xero_delete_tracking_option`

Delete a tracking option

`accounting.settings`

List Users`xero_list_users`

Retrieve a list of users

`accounting.settings.read`

Get User`xero_get_user`

Retrieve a single user by ID

`accounting.settings.read`

## Events

Tags

Select all
|
Clear

Contacts

Credit Notes

Invoices

Overpayments

Prepayments

Webhooks

No tags found

12 events

EventDescriptionTags

Intent to Receive`xero_intent_to_receive`

Answers Xero's Intent to receive check so Xero enables webhook delivery.

Webhooks

Unmapped Event`xero_unmapped_event`

Acknowledges Xero events this connector does not map.

Webhooks

Contact Created`xero_webhook_contact_created`

Fires when a contact is created in Xero.

ContactsWebhooks

Contact Updated`xero_webhook_contact_updated`

Fires when a contact is updated in Xero.

ContactsWebhooks

Invoice Created`xero_webhook_invoice_created`

Fires when a invoice (sales invoice or bill) is created in Xero.

InvoicesWebhooks

Invoice Updated`xero_webhook_invoice_updated`

Fires when a invoice (sales invoice or bill) is updated in Xero.

InvoicesWebhooks

Credit Note Created`xero_webhook_credit_note_created`

Fires when a credit note is created in Xero.

Credit NotesWebhooks

Credit Note Updated`xero_webhook_credit_note_updated`

Fires when a credit note is updated in Xero.

Credit NotesWebhooks

Prepayment Created`xero_webhook_prepayment_created`

Fires when a prepayment is created in Xero.

PrepaymentsWebhooks

Prepayment Updated`xero_webhook_prepayment_updated`

Fires when a prepayment is updated in Xero.

PrepaymentsWebhooks

Overpayment Created`xero_webhook_overpayment_created`

Fires when a overpayment is created in Xero.

OverpaymentsWebhooks

Overpayment Updated`xero_webhook_overpayment_updated`

Fires when a overpayment is updated in Xero.

OverpaymentsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.