Archive the information and metadata of an account by Id

Example Account

Archive the information and metadata of a contact by Id

Example Contact

Xero has support for many different types of accounts.
When creating certain accounts they may require you to provide additional fields.
You can provide these fields with the 'Optional Values' input.
For a list of the required values for each type of account, refer to the [documentation](https://developer.xero.com/documentation/api/accounting/accounts#get-accounts) provided by Xero.


Add an attachment to an existing object. Existing attachments with that file name will be overridden.

An Example Untracked Item

Delete the information and metadata of an account by Id

Delete the information and metadata of an invoice by Id

Delete the information and metadata of an item by Id

Get the information and metadata of an account by Id

Get the information and metadata of a contact by Id

Get the information and metadata of a contact's history by Id

Get the information and metadata of an invoice by Id

Get the information and metadata of an item by Id

Get the information and metadata of an items's history by Id

Get the information and metadata of a payment by id

Get the information and metadata of a payment's history by Id

Create a new payment on an existing AP/AR invoice

Send an existing accounts receivable invoice through email

You can use the Send Invoice action to trigger the email of a sales invoice out of Xero.
The invoice must be of type `ACCREC` and a valid status for sending (`SUBMITTED`, `AUTHORIZED` or `PAID`).
The email will be sent to the primary email address of the contact on the invoice and any additional contact persons that have `IncludeInEmails` flag set to `true`.
The sender will be the user who authorized the app connection.


Update the information and metadata of an existing account by Id

Update the information and metadata of a contact by Id

Update the information and metadata of an item by Id

Void an existing approved invoice that has no payments applied to it.

**Xero** uses OAuth 2.0 to authorize requests made to the API.
In order for your integration to authenticate with your customers' Xero accounts, you will need to create a Xero OAuth 2.0 app:

-   Log on to Xero's [developer portal](https://developer.xero.com/app/manage/)
-   Click **New app**
    -   Give your app a name
    -   Select **Web app** for **Integration type**
    -   Enter _your company's_ URL for **Company or application URL**
    -   Enter `https://oauth2.prismatic.io/callback` for the **Redirect URI**
-   Next, open the **Configuration** page
    -   Click **Generate Secret** and take note of the **Client id** and **Client secret** - you'll enter those in Prismatic in a moment

When you add a Xero step to an integration, a Xero OAuth 2.0 connection config variable will be created automatically for you:

-   For **Scopes**, enter the scopes from [this list](https://developer.xero.com/documentation/guides/oauth2/scopes/) that are relevant to your integration.
    Always include the `offline_access` scope in order for authentication tokens to refresh automatically.
-   For **Client ID** and **Client Secret**, enter the values you noted above.
-   A single customer might be logged in to multiple tenants, and **Tenant Name** is unique for each customer.
    Leave that input blank, and click the gear icon next to **Tenant Name**.
    Adjust **Input Visibility** and select **Customer** to make that input visible to your customers.
    That way, your customers will be prompted for their tenant name when they enable this integration.

For additional information regarding authentication, please refer to the [Xero docs](https://developer.xero.com/documentation/guides/oauth2/auth-flow/#2-users-are-redirected-back-to-you-with-a-code).


**Xero** uses OAuth 2.0 to authorize requests made to the API.
You can use client credentials grant type to access data from a single Xero organization using Custom Connections.

Custom Connections are a premium integration option that utilize the client credentials grant type to access data from a single Xero organization.

**Setting up a Custom Connection**

1. **Create the Custom Connection**
   - Log in to [My Apps](https://developer.xero.com/app/manage) and click “New App”.
   - Give the integration a name and select “Custom connection” as the integration type.

2. **Select scopes and the authorizing user**
   - Next, select the API scopes your integration will need and who will authorize the connection.
   - That user will then be emailed a link that takes them to the authorization step.
   - Once authorization is complete you will receive an email to let you know the connection has been authorized.

3. **Authorize the connection**
   - After clicking the Connect button in the email, the authorizing user will be taken to a consent screen where they can see which scopes are being requested and select the organization to connect.
   - Note that an organization needs to have purchased a subscription with sufficient Custom Connections to be authorized and connected.
   - The only exception is the Xero Demo Company, which can be used for free for development purposes.

4. **Retrieve your client id and client secret**
   - Once the custom connection has been authorized, the client id will be available on the app details page and you can generate the client secret.
   - You'll enter those in Prismatic.

For more information, check the [documentation here](https://developer.xero.com/documentation/guides/oauth2/custom-connections/).


Manage invoices, items, accounts, payments and more objects from your Xero account.

[Xero](https://www.xero.com/us/) is a cloud-based accounting software platform for small and medium-sized businesses.
The Xero component allows you to manage your invoices, payments, items, and contacts through the Xero Rest API.


Receive and validate webhook requests from Xero for webhooks you configure.

Action Name	Action Description
List Contacts	List all contacts
List Connections	List all connections
Get Contact	Get the information and metadata of a contact by Id
Archive Contact	Archive the information and metadata of a contact by Id
Delete Account	Delete the information and metadata of an account by Id
List Accounts	List all accounts
Get Invoice	Get the information and metadata of an invoice by Id
Get Item	Get the information and metadata of an item by Id
Delete Invoice	Delete the information and metadata of an invoice by Id
List Invoices	List all invoices
Delete Item	Delete the information and metadata of an item by Id
List Items	List all items
Create Contact	Create a new contact
Get Contact History	Get the information and metadata of a contact's history by Id
Update Contact	Update the information and metadata of a contact by Id
Create Item	Create a new Item
Get Item History	Get the information and metadata of an items's history by Id
Add Note To Item	Add a note to an item's history by Id
Create Invoice	Create a new invoice
Send Invoice	Send an existing accounts receivable invoice through email
Void Invoice	Void an existing approved invoice that has no payments applied to it.
Add Notes To Invoice	Add additional notes to an invoice by Id
Create Account	Create a new account
Create Attachment	Add an attachment to an existing object. Existing attachments with that file name will be overridden.
Get Attachment	Get an attachment by ID
Get Payment	Get the information and metadata of a payment by id
Get Payment History	Get the information and metadata of a payment's history by Id
List Payments	List all payments
Pay Invoice	Create a new payment on an existing AP/AR invoice
Reverse Payment	Reverse a payment by Id
Get Account	Get the information and metadata of an account by Id
Archive Account	Archive the information and metadata of an account by Id
Update Account	Update the information and metadata of an existing account by Id
Update Item	Update the information and metadata of an item by Id
Raw Request	Send raw HTTP request to Xero

Xero Connector

Integrate with customers’ other SaaS apps, fast

About the Xero Connector

Actions

Triggers

Ready to get started?