xero.com

•

One-click Login

About Xero Accounting Api

The Xero Accounting API gives third-party developers programmatic access to invoices, contacts, bank transactions, expenses, payroll, and financial reports within Xero-connected organizations. In March 2026, Xero replaced its revenue-share commercial model with a tiered subscription based on the number of connected Xero organizations and monthly data egress. It is used by accounting software vendors, practice management tools, and fintech integrators.

AI Agent Use Cases

- Full accounting data access: invoices, bills, contacts, bank feeds, payroll

- OAuth2 authentication with per-organization connections

- Webhooks for real-time change notifications

- Tiered API pricing based on connections and data egress (effective March 2026)

- Premium endpoints for Journals, Xero Practice Manager, and Bulk Connections (Advanced tier+)

- Exemptions for single-client bespoke integrations and accounting practice tools

Available Actions

These are the specific actions that AI agents can perform with this tool

Add Items to Existing Sales Invoice

3 inputs

Adds one or more line items to an existing sales invoice in Xero to update its billing details.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

invoiceId

Unique identification of the invoice

lineItems

The LineItems collection can contain any number of individual LineItem sub-elements. At least one is required to create a complete Invoice. [Refer to Tax Type](https://developer.xero.com/documentation/api/accounting/types#report-tax-types), [Refer to Line Items](https://developer.xero.com/documentation/api/accounting/invoices#creating-updating-and-deleting-line-items-when-updating-invoices)\n\n**Example:** `[{\

Bank Statements Report

4 inputs

Retrieves detailed bank statement data for a given bank account within Xero.

Inputs

tenant_id

Id of the organization tenant to use on the Xero Accounting API. See [Get Tenant Connections](https://pipedream.com/@sergio/xero-accounting-api-get-tenant-connections-p_OKCzOgn/edit) for a workflow example on how to pull this data.

bank_account_id

Xero identifier of the bank account to get bank statements of

from_date

Get the bank statements of the specified bank account from this date

to_date

Get the bank statements of the specified bank account to this date

Create Bank Transaction

15 inputs

Creates a bank transaction in Xero using either the Account Code or AccountID of the bank account.

Inputs

bank_account_code

The Account Code of the Bank Account of the transaction. If Code is not included then AccountID is required.

bank_account_id

The ID of the Bank Account transaction. If AccountID is not included then Code is required.

contact_id

Id of the contact associated to the bank transaction.

contact_name

Name of the contact associated to the bank transaction. If there is no contact matching this name, a new contact is created.

tenant_id

type

See [Bank Transaction Types](https://developer.xero.com/documentation/api/types#BankTransactionTypes)

line_items

See [LineItems](https://developer.xero.com/documentation/api/banktransactions#LineItemsPOST). The LineItems element can contain any number of individual LineItem sub-elements. At least **one** is required to create a bank transaction.

is_reonciled

Boolean to show if transaction is reconciled. Conversion related apps can set the IsReconciled flag in scenarios when a matching bank statement line is not available. [Learn more](http://help.xero.com/#Q_BankRecNoImport)

date

Date of transaction - YYYY-MM-DD

reference

Reference for the transaction. Only supported for SPEND and RECEIVE transactions.

currency_code

The currency that bank transaction has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies)). Setting currency is only supported on overpayments.

currency_rate

Exchange rate to base currency when money is spent or received. e.g. 0.7500 Only used for bank transactions in non base currency. If this isn

url

URL link to a source document - shown as \

status

See [Bank Transaction Status Codes](https://developer.xero.com/documentation/api/types#BankTransactionStatuses)

line_amount_types

Line amounts are exclusive of tax by default if you don

Create Bill

8 inputs

Creates a new accounts payable bill in Xero with specified supplier, line items, and billing details

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

invoiceNumber

Unique alpha numeric code identifying invoice

reference

ACCREC only - additional reference number

contact

Contact information

lineItems

date

Date invoice was issued - YYYY-MM-DD

dueDate

Date invoice is due - YYYY-MM-DD

currencyCode

The currency that invoice has been raised in. Refer to [object documentation](https://www.xe.com/iso4217.php)

Create Credit Note

15 inputs

Creates a new credit note in Xero to record refunds or corrections against invoices.

Inputs

contact_id

Id of the contact associated to the credit note.

contact_name

Name of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.

contact_number

Number of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.

tenant_id

type

See [Credit Note Types](https://developer.xero.com/documentation/api/types#CreditNoteTypes)

date

The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation

status

See [Credit Note Status Codes](https://developer.xero.com/documentation/api/types#CreditNoteStatuses)

line_amount_types

See [Invoice Line Amount Types](https://developer.xero.com/documentation/api/Types#LineAmountTypes)

line_items

See [Invoice Line Items](https://developer.xero.com/documentation/api/Invoices#LineItems)

currency_code

Currency used for the Credit Note

credit_note_number

[ACCRECCREDIT](https://developer.xero.com/documentation/api/types#CreditNoteTypes) - Unique alpha numeric code identifying credit note ( *when missing will auto-generate from your Organisation Invoice Settings*)\n[ACCPAYCREDIT](https://developer.xero.com/documentation/api/types#CreditNoteTypes) - non-unique alpha numeric code identifying credit note. This value will also display as Reference in the UI.

reference

ACCRECCREDIT only - additional reference number

sent_to_contact

Boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)

currency_rate

The currency rate for a multicurrency invoice. If no rate is specified, the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) is used

branding_theme_id

See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)

Create Employee

5 inputs

Creates a new employee record in the Xero accounting system with specified personal and employment details.

Inputs

tenant_id

first_name

First name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.

last_name

Last name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.

status

Current status of an employee - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)

external_link

Link to an external resource, for example, an employee record in an external system. You can specify the URL element.\nThe description of the link is auto-generated in the form \

Create History Note

4 inputs

Adds a new note to a specified accounting document to record additional information or context.

Inputs

tenant_id

endpoint

The URL component, endpoint of the document type to add the history note. See [supported document types](https://developer.xero.com/documentation/api/history-and-notes#SupportedDocs)

guid

Xero identifier of the document to add a history note to.

details

The note to be recorded against a single document. Max Length 250 characters.

Create Item

11 inputs

Creates a new inventory or service item in the Xero accounting system with specified attributes.

Inputs

tenant_id

code

User defined item code (max length = 30)

inventory_asset_account_code

The inventory asset [account](https://developer.xero.com/documentation/api/accounts/) for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item

name

The name of the item (max length = 50)

is_sold

Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled.

is_purchased

Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled.

description

The sales description of the item (max length = 4000)

purchase_description

The purchase description of the item (max length = 4000)

purchase_details

See Purchases & Sales. The [PurchaseDetails](https://developer.xero.com/documentation/api/items#PurchasesSales) element can contain a number of individual sub-elements.

sales_details

See Purchases & Sales. The [SalesDetails](https://developer.xero.com/documentation/api/items#PurchasesSales) element can contain a number of individual sub-elements.

unitdp

By default UnitPrice is returned to two decimal places.

Create Payment

15 inputs

Creates a new payment record against an invoice in Xero Accounting.

Inputs

account_id

ID of account you are using to make the payment e.g. 294b1dc5-cc47-2afc-7ec8-64990b8761b8. This account needs to be either an account of type BANK or have enable payments to this accounts switched on (see [GET Accounts](https://developer.xero.com/documentation/api/Accounts)) . See the edit account screen of your Chart of Accounts in Xero if you wish to enable payments for an account other than a bank account

account_code

Code of account you are using to make the payment e.g. 001 ( note: *not all accounts have a code value*)

invoice_id

ID of the invoice you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

credit_note_id

ID of the credit note you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

prepayment_id

ID of the prepayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

overpayment_id

ID of the overpayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

invoice_number

Number of invoice you are applying payment to e.g. INV-4003

credit_note_number

Number of credit note you are applying payment to e.g. INV-4003

tenant_id

date

Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06

currency_rate

Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500

amount

The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00

reference

An optional description for the payment e.g. Direct Debit

is_reconciled

A boolean indicating whether the payment has been reconciled.

status

The [status](https://developer.xero.com/documentation/api/types#PaymentStatusCodes) of the payment.

Create Purchase Bill

16 inputs

Creates a new purchase bill in the Xero accounting system to record expenses from suppliers.

Inputs

contact_id

Id of the contact associated to the invoice.

contact_name

Name of the contact associated to the invoice. If there is no contact matching this name, a new contact is created.

tenant_id

line_items

See [LineItems](https://developer.xero.com/documentation/api/invoices#LineItemsPOST). The LineItems collection can contain any number of individual LineItem sub-elements. At least * **one** * is required to create a complete Invoice.

date

Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation.

due_date

Date invoice is due - YYYY-MM-DD.

line_amount_type

Line amounts are exclusive of tax by default if you don

purchase_bill_number

Non-unique alpha numeric code identifying purchase bill (printable ASCII characters only). This value will also display as Reference in the UI.

reference

Additional reference number (max length = 255)

branding_theme_id

See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)

url

URL link to a source document - shown as \

currency_code

The currency that invoice has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies))

currency_rate

The currency rate for a multicurrency invoice. If no rate is specified, the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) is used. (max length = [18].[6])

status

See [Invoice Status Codes](https://developer.xero.com/documentation/api/invoices#status-codes)

sent_to_contact

Boolean to set whether the invoice in the Xero app should be marked as \

planned_payment_date

Shown on purchase bills (Accounts Payable) when this has been set

Create Sales Invoice

16 inputs

Creates a new sales invoice in Xero with specified customer, items, and billing details.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

contactId

Id of the contact associated to the invoice.

contactName

Name of the contact associated to the invoice. If there is no contact matching this name, a new contact is created.

lineItems

date

Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation.

dueDate

Date invoice is due - YYYY-MM-DD.

lineAmountType

Line amounts are exclusive of tax by default if you don

invoiceNumber

Unique alpha numeric code identifying invoice (* when missing will auto-generate from your Organisation Invoice Settings*) (max length = 255)

reference

Additional reference number (max length = 255)

brandingThemeId

See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)

url

URL link to a source document - shown as \

currencyCode

The currency that invoice has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies))

currencyRate

The currency rate for a multicurrency invoice. If no rate is specified, the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) is used. (max length = [18].[6])

status

See [Invoice Status Codes](https://developer.xero.com/documentation/api/invoices#status-codes)

sentToContact

Boolean to set whether the invoice in the Xero app should be marked as \

expectedPaymentData

Shown on the sales invoices when this has been set

Create or Update Contact

28 inputs

Creates a new contact in Xero or updates an existing contact with provided details.

Inputs

tenant_id

name

Full name of contact/organisation (max length = 255). The following is required to create a contact.

contact_id

Xero identifier.

contact_number

This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.

account_number

A user defined account number. This can be updated via the API and the [Xero UI](https://help.xero.com/ContactsAccountNumber) (max length = 50).

contact_status

Current status of a contact - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)

first_name

First name of contact person (max length = 255).

last_name

Last name of contact person (max length = 255)

email_address

Email address of contact person (umlauts not supported) (max length = 255)

skype_user_name

Skype user name of contact.

contact_persons

See [contact persons](https://developer.xero.com/documentation/api/contacts#contact-persons).

bank_account_details

Bank account number of contact

tax_number

Tax number of contact - this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)

account_receivable_tax_type

Default tax type used for contact on AP invoices

account_payable_type

Store certain address types for a contact - see address types

addresses

Store certain address types for a contact - see address types

phones

Store certain phone types for a contact - see phone types.

is_supplier

true or false Boolean that describes if a contact that has any AP invoices entered against them. Cannot be set via PUT or POST - it is automatically set when an accounts payable invoice is generated against this contact.

is_customer

true or false Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST - it is automatically set when an accounts receivable invoice is generated against this contact.

default_currency

Default currency for raising invoices against contact

xero_network_key

Store XeroNetworkKey for contacts.

sales_default_account_code

The default sales [account code](https://developer.xero.com/documentation/api/accounts) for contacts

puchases_default_account_code

The default purchases [account code](https://developer.xero.com/documentation/api/accounts) for contacts

sales_tracking_categories

The default sales [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

puechases_tracking_categories

The default purchases [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

tracking_category_name

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

tracking_option_name

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

payment_terms

The default payment terms for the contact - see Payment Terms

Create or update contact

8 inputs

Creates a new contact or updates an existing contact in Xero Accounting based on provided contact details.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

actionType

This triggers an update if UPDATE is selected

name

Full name of contact/organization.

firstName

First name of contact person .

lastName

Last name of contact person.

emailAddress

Email address of contact person.

accountNumber

User defined account number..

contactStatus

See https://developer.xero.com/documentation/api/accounting/types#contacts

Download Invoice

3 inputs

Retrieves a specified invoice from Xero Accounting and saves it as a PDF file in a temporary workflow directory.

Inputs

tenant_id

invoice_id

Xero generated unique identifier for the invoice to download.

syncDir

Email an Invoice

2 inputs

Sends a specified sales invoice to a customer via email through Xero's accounting system.

Inputs

tenant_id

invoice_id

Xero generated unique identifier for the invoice to send by email out of Xero. The invoice must be of Type ACCREC and a valid Status for sending (SUMBITTED,AUTHORISED or PAID).

Find Invoice

3 inputs

Retrieves invoice details from Xero Accounting using an invoice number or reference identifier.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

invoiceNumber

Unique alpha numeric code identifying invoice

reference

ACCREC only - additional reference number

Find contact. Optionally, create one if none are found

4 inputs

Searches for a contact in Xero by name or account number, with an option to create a new contact if none exists.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

name

Full name of contact/organization

accountNumber

Account number of Contact.

createContactIfNotFound

Create a new contact if not found?.

Find or Create Contact

3 inputs

Searches for a contact by email in Xero Accounting and creates a new contact if none exists.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

emailAddress

Email address of contact.

createContactIfNotFound

Set to `true` to create a new contact if not found.

Get Bank Summary

3 inputs

Retrieves current balances and detailed cash movement summaries for each bank account linked to the Xero organization.

Inputs

tenant_id

form_date

Get the balances and cash movements for each bank account from this date

to_date

Get the balances and cash movements for each bank account to this date

Get Contact

2 inputs

Retrieves detailed information for a specific contact within the Xero accounting system.

Inputs

tenant_id

contact_identifier

Xero identifier of the contact to get. Possible values: \n* **ContactID** - The Xero identifier for a contact e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9\n* **ContactNumber** - A custom identifier specified from another system e.g. a CRM system has a contact number of CUST100

Get History of Changes

3 inputs

Retrieves a detailed audit trail of all changes made to a specific accounting document within Xero.

Inputs

tenant_id

endpoint

The URL component, endpoint of the document type to get history changes. See [supported document types](https://developer.xero.com/documentation/api/history-and-notes#SupportedDocs)

guid

Xero identifier of the document to get history changes of.

Get Invoice

2 inputs

Retrieves comprehensive details of a specified invoice from Xero accounting records.

Inputs

tenant_id

invoice_id

Get Item

2 inputs

Retrieves detailed information about a specific inventory or service item from Xero Accounting.

Inputs

tenant_id

item_id

You can specify an individual record by appending the value to the endpoint, i.e.\n**GET https://.../Items/{identifier}**. Possible values:\n* **ItemID** - The Xero identifier for an Item e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9\n* **Code**- The user defined code of an item e.g. ITEM-001

Get Sales Invoice Online URL

2 inputs

Retrieves a URL that provides direct online access to a specific sales invoice in Xero.

Inputs

tenant_id

invoice_id

Xero generated unique identifier for the invoice to retrieve its online url.

Get Tenant Connections

Retrieves a list of Xero tenant connections the authorized user can access.

List Contacts

8 inputs

Retrieves a filtered list of contact records associated with a specified tenant in Xero Accounting.

Inputs

tenant_id

contact_identifier

A contact identifier. Possible values: \n* **ContactID** - The Xero identifier for a contact e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9\n* **ContactNumber** - A custom identifier specified from another system e.g. a CRM system has a contact number of CUST100

modified_after

ids

Filter by a comma-separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. See [details.](https://developer.xero.com/documentation/api/contacts#optimised-queryparameters)

where

Filter using the where parameter. We recommend you limit filtering to the [optimised elements](https://developer.xero.com/documentation/api/contacts#optimised-parameters) only.

order

Order by any element returned ([*see Order By.*](https://developer.xero.com/documentation/api/requests-and-responses#ordering))

page

Up to 100 contacts will be returned per call when the page parameter is used e.g. page=1.

includeArchived

e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response.

List Credit Notes

6 inputs

Retrieves a list of credit notes from a specified tenant based on provided filter criteria.

Inputs

tenant_id

credit_note_identifier

Credit note identifier of the contact to get. Possible values: \n* **CreditNoteID** - The Xero identifier for a contact note e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9\n* **CreditNoteNumber** - Identifier for Credit Note CN-8743802

modified_after

The ModifiedAfter filter is actually an HTTP header: **

where

Filter by an any element ( see [Filters](https://developer.xero.com/documentation/api/requests-and-responses#get-modified) )

order

Order by any element returned ( see [Order By](https://developer.xero.com/documentation/api/requests-and-responses#ordering) )

page

Up to 100 credit notes will be returned per call, with line items shown for each, when the page parameter is used e.g. page=1

List Invoices

11 inputs

Retrieves a list of invoices from a specified tenant based on provided filter criteria.

Inputs

tenant_id

invoice_identifier

An invoice identifier. Possible values:\n\n* **InvoiceID** - The Xero identifier for an Invoice e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9\n* **InvoiceNumber** - The InvoiceNumber e.g. INV-01514

modified_after

The ModifiedAfter filter is actually an HTTP header: **

ids

Filter by a comma-separated list of InvoicesIDs. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

invoice_numbers

Filter by a comma-separated list of InvoiceNumbers. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

contact_ids

Filter by a comma-separated list of ContactIDs. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

statuses

Filter by a comma-separated list of Statuses. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

where

Filter using the *where* parameter. We recommend you limit filtering to the [optimised elements](https://developer.xero.com/documentation/api/invoices#optimised-parameters) only.

created_by_my_app

When set to true you

order

Order by any element returned ( see [Order By](https://developer.xero.com/documentation/api/requests-and-responses#ordering) ).

page

Up to 100 invoices will be returned per call, with line items shown for each, when the page parameter is used e.g. page=1

List Manual Journals

6 inputs

Retrieves a list of manual journal entries for a specified tenant, filtered by provided parameters.

Inputs

tenant_id

manual_journal_id

You can specify an individual record by appending the ManualJournalID to the endpoint, i.e. **GET https://.../ManualJournals/{identifier}**

modified_after

The ModifiedAfter filter is actually an HTTP header: **

where

Filter by an any element (*see [Filters](https://developer.xero.com/documentation/api/requests-and-responses#get-modified)*)

order

Order by any element returned (*see [Order By](https://developer.xero.com/documentation/api/requests-and-responses#ordering)*)

page

Up to 100 manual journals will be returned per call, with journal lines shown for each, when the page parameter is used e.g. page=1

Make API Call

5 inputs

Executes a custom request to the Xero Accounting API to retrieve or manipulate accounting data as specified.

Inputs

request_method

Http method to use in the request.

relative_url

A path relative to Xero Accounting API to send the request against.

query_string

Query string of the request.

headers

Headers to send in the request. Must include header `xero-tenant-id` with Id of the organization tenant to use on the Xero Accounting API. See [Get Tenant Connections](https://pipedream.com/@sergio/xero-accounting-api-get-tenant-connections-p_OKCzOgn/edit) for a workflow example on how to pull this data.

request_body

Body of the request.

Update Contact

28 inputs

Updates the details of an existing contact in Xero Accounting using its unique identifier.

Inputs

tenant_id

contact_id

Contact identifier of the contact to update.

name

Full name of contact/organisation (max length = 255). The following is required to create a contact.

contact_number

account_number

A user defined account number. This can be updated via the API and the [Xero UI](https://help.xero.com/ContactsAccountNumber) (max length = 50).

contact_status

Current status of a contact - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)

first_name

First name of contact person (max length = 255).

last_name

Last name of contact person (max length = 255)

email_address

Email address of contact person (umlauts not supported) (max length = 255)

skype_user_name

Skype user name of contact.

contact_persons

See [contact persons](https://developer.xero.com/documentation/api/contacts#contact-persons).

bank_account_details

Bank account number of contact

tax_number

account_receivable_tax_type

Default tax type used for contact on AP invoices

account_payable_type

Store certain address types for a contact - see address types

addresses

Store certain address types for a contact - see address types

phones

Store certain phone types for a contact - see phone types.

is_supplier

is_customer

default_currency

Default currency for raising invoices against contact

xero_network_key

Store XeroNetworkKey for contacts.

sales_default_account_code

The default sales [account code](https://developer.xero.com/documentation/api/accounts) for contacts

puchases_default_account_code

The default purchases [account code](https://developer.xero.com/documentation/api/accounts) for contacts

sales_tracking_categories

The default sales [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

puechases_tracking_categories

The default purchases [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

tracking_category_name

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

tracking_option_name

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

payment_terms

The default payment terms for the contact - see Payment Terms

Upload File

5 inputs

Uploads a file attachment to a specified document within Xero Accounting, enabling document management alongside financial records.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

filePathOrUrl

The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)

documentType

Document type of where the attachment will be sent to. This is used in as part of the Xero Account API endpoint where the request is sent against.

documentId

Xero identifier of the document where the attachment will be sent to.

syncDir

About Xero Accounting Api

AI Agent Use Cases

- Full accounting data access: invoices, bills, contacts, bank feeds, payroll

- OAuth2 authentication with per-organization connections

- Webhooks for real-time change notifications

- Tiered API pricing based on connections and data egress (effective March 2026)

- Premium endpoints for Journals, Xero Practice Manager, and Bulk Connections (Advanced tier+)

- Exemptions for single-client bespoke integrations and accounting practice tools

Available Actions

These are the specific actions that AI agents can perform with this tool

Add Items to Existing Sales Invoice

3 inputs

Adds one or more line items to an existing sales invoice in Xero to update its billing details.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

invoiceId

Unique identification of the invoice

lineItems

Bank Statements Report

4 inputs

Retrieves detailed bank statement data for a given bank account within Xero.

Inputs

tenant_id

bank_account_id

Xero identifier of the bank account to get bank statements of

from_date

Get the bank statements of the specified bank account from this date

to_date

Get the bank statements of the specified bank account to this date

Create Bank Transaction

15 inputs

Creates a bank transaction in Xero using either the Account Code or AccountID of the bank account.

Inputs

bank_account_code

The Account Code of the Bank Account of the transaction. If Code is not included then AccountID is required.

bank_account_id

The ID of the Bank Account transaction. If AccountID is not included then Code is required.

contact_id

Id of the contact associated to the bank transaction.

contact_name

Name of the contact associated to the bank transaction. If there is no contact matching this name, a new contact is created.

tenant_id

type

See [Bank Transaction Types](https://developer.xero.com/documentation/api/types#BankTransactionTypes)

line_items

is_reonciled

date

Date of transaction - YYYY-MM-DD

reference

Reference for the transaction. Only supported for SPEND and RECEIVE transactions.

currency_code

The currency that bank transaction has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies)). Setting currency is only supported on overpayments.

currency_rate

Exchange rate to base currency when money is spent or received. e.g. 0.7500 Only used for bank transactions in non base currency. If this isn

url

URL link to a source document - shown as \

status

See [Bank Transaction Status Codes](https://developer.xero.com/documentation/api/types#BankTransactionStatuses)

line_amount_types

Line amounts are exclusive of tax by default if you don

Create Bill

8 inputs

Creates a new accounts payable bill in Xero with specified supplier, line items, and billing details

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

invoiceNumber

Unique alpha numeric code identifying invoice

reference

ACCREC only - additional reference number

contact

Contact information

lineItems

date

Date invoice was issued - YYYY-MM-DD

dueDate

Date invoice is due - YYYY-MM-DD

currencyCode

The currency that invoice has been raised in. Refer to [object documentation](https://www.xe.com/iso4217.php)

Create Credit Note

15 inputs

Creates a new credit note in Xero to record refunds or corrections against invoices.

Inputs

contact_id

Id of the contact associated to the credit note.

contact_name

Name of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.

contact_number

Number of the contact associated to the credit note. If there is no contact matching this name, a new contact is created.

tenant_id

type

See [Credit Note Types](https://developer.xero.com/documentation/api/types#CreditNoteTypes)

date

The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation

status

See [Credit Note Status Codes](https://developer.xero.com/documentation/api/types#CreditNoteStatuses)

line_amount_types

See [Invoice Line Amount Types](https://developer.xero.com/documentation/api/Types#LineAmountTypes)

line_items

See [Invoice Line Items](https://developer.xero.com/documentation/api/Invoices#LineItems)

currency_code

Currency used for the Credit Note

credit_note_number

reference

ACCRECCREDIT only - additional reference number

sent_to_contact

Boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)

currency_rate

The currency rate for a multicurrency invoice. If no rate is specified, the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) is used

branding_theme_id

See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)

Create Employee

5 inputs

Creates a new employee record in the Xero accounting system with specified personal and employment details.

Inputs

tenant_id

first_name

First name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.

last_name

Last name of an employee (max length = 255). If an existing employee matches your `FirstName` and `LastName` then you will receive an error.

status

Current status of an employee - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)

external_link

Link to an external resource, for example, an employee record in an external system. You can specify the URL element.\nThe description of the link is auto-generated in the form \

Create History Note

4 inputs

Adds a new note to a specified accounting document to record additional information or context.

Inputs

tenant_id

endpoint

The URL component, endpoint of the document type to add the history note. See [supported document types](https://developer.xero.com/documentation/api/history-and-notes#SupportedDocs)

guid

Xero identifier of the document to add a history note to.

details

The note to be recorded against a single document. Max Length 250 characters.

Create Item

11 inputs

Creates a new inventory or service item in the Xero accounting system with specified attributes.

Inputs

tenant_id

code

User defined item code (max length = 30)

inventory_asset_account_code

name

The name of the item (max length = 50)

is_sold

is_purchased

description

The sales description of the item (max length = 4000)

purchase_description

The purchase description of the item (max length = 4000)

purchase_details

See Purchases & Sales. The [PurchaseDetails](https://developer.xero.com/documentation/api/items#PurchasesSales) element can contain a number of individual sub-elements.

sales_details

See Purchases & Sales. The [SalesDetails](https://developer.xero.com/documentation/api/items#PurchasesSales) element can contain a number of individual sub-elements.

unitdp

By default UnitPrice is returned to two decimal places.

Create Payment

15 inputs

Creates a new payment record against an invoice in Xero Accounting.

Inputs

account_id

account_code

Code of account you are using to make the payment e.g. 001 ( note: *not all accounts have a code value*)

invoice_id

ID of the invoice you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

credit_note_id

ID of the credit note you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

prepayment_id

ID of the prepayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

overpayment_id

ID of the overpayment you are applying payment to e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

invoice_number

Number of invoice you are applying payment to e.g. INV-4003

credit_note_number

Number of credit note you are applying payment to e.g. INV-4003

tenant_id

date

Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06

currency_rate

Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500

amount

The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00

reference

An optional description for the payment e.g. Direct Debit

is_reconciled

A boolean indicating whether the payment has been reconciled.

status

The [status](https://developer.xero.com/documentation/api/types#PaymentStatusCodes) of the payment.

Create Purchase Bill

16 inputs

Creates a new purchase bill in the Xero accounting system to record expenses from suppliers.

Inputs

contact_id

Id of the contact associated to the invoice.

contact_name

Name of the contact associated to the invoice. If there is no contact matching this name, a new contact is created.

tenant_id

line_items

date

Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation.

due_date

Date invoice is due - YYYY-MM-DD.

line_amount_type

Line amounts are exclusive of tax by default if you don

purchase_bill_number

Non-unique alpha numeric code identifying purchase bill (printable ASCII characters only). This value will also display as Reference in the UI.

reference

Additional reference number (max length = 255)

branding_theme_id

See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)

url

URL link to a source document - shown as \

currency_code

The currency that invoice has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies))

currency_rate

The currency rate for a multicurrency invoice. If no rate is specified, the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) is used. (max length = [18].[6])

status

See [Invoice Status Codes](https://developer.xero.com/documentation/api/invoices#status-codes)

sent_to_contact

Boolean to set whether the invoice in the Xero app should be marked as \

planned_payment_date

Shown on purchase bills (Accounts Payable) when this has been set

Create Sales Invoice

16 inputs

Creates a new sales invoice in Xero with specified customer, items, and billing details.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

contactId

Id of the contact associated to the invoice.

contactName

Name of the contact associated to the invoice. If there is no contact matching this name, a new contact is created.

lineItems

date

Date invoice was issued - YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation.

dueDate

Date invoice is due - YYYY-MM-DD.

lineAmountType

Line amounts are exclusive of tax by default if you don

invoiceNumber

Unique alpha numeric code identifying invoice (* when missing will auto-generate from your Organisation Invoice Settings*) (max length = 255)

reference

Additional reference number (max length = 255)

brandingThemeId

See [BrandingThemes](https://developer.xero.com/documentation/api/branding-themes)

url

URL link to a source document - shown as \

currencyCode

The currency that invoice has been raised in (see [Currencies](https://developer.xero.com/documentation/api/currencies))

currencyRate

The currency rate for a multicurrency invoice. If no rate is specified, the [XE.com day rate](http://help.xero.com/#CurrencySettings$Rates) is used. (max length = [18].[6])

status

See [Invoice Status Codes](https://developer.xero.com/documentation/api/invoices#status-codes)

sentToContact

Boolean to set whether the invoice in the Xero app should be marked as \

expectedPaymentData

Shown on the sales invoices when this has been set

Create or Update Contact

28 inputs

Creates a new contact in Xero or updates an existing contact with provided details.

Inputs

tenant_id

name

Full name of contact/organisation (max length = 255). The following is required to create a contact.

contact_id

Xero identifier.

contact_number

account_number

A user defined account number. This can be updated via the API and the [Xero UI](https://help.xero.com/ContactsAccountNumber) (max length = 50).

contact_status

Current status of a contact - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)

first_name

First name of contact person (max length = 255).

last_name

Last name of contact person (max length = 255)

email_address

Email address of contact person (umlauts not supported) (max length = 255)

skype_user_name

Skype user name of contact.

contact_persons

See [contact persons](https://developer.xero.com/documentation/api/contacts#contact-persons).

bank_account_details

Bank account number of contact

tax_number

account_receivable_tax_type

Default tax type used for contact on AP invoices

account_payable_type

Store certain address types for a contact - see address types

addresses

Store certain address types for a contact - see address types

phones

Store certain phone types for a contact - see phone types.

is_supplier

is_customer

default_currency

Default currency for raising invoices against contact

xero_network_key

Store XeroNetworkKey for contacts.

sales_default_account_code

The default sales [account code](https://developer.xero.com/documentation/api/accounts) for contacts

puchases_default_account_code

The default purchases [account code](https://developer.xero.com/documentation/api/accounts) for contacts

sales_tracking_categories

The default sales [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

puechases_tracking_categories

The default purchases [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

tracking_category_name

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

tracking_option_name

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

payment_terms

The default payment terms for the contact - see Payment Terms

Create or update contact

8 inputs

Creates a new contact or updates an existing contact in Xero Accounting based on provided contact details.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

actionType

This triggers an update if UPDATE is selected

name

Full name of contact/organization.

firstName

First name of contact person .

lastName

Last name of contact person.

emailAddress

Email address of contact person.

accountNumber

User defined account number..

contactStatus

See https://developer.xero.com/documentation/api/accounting/types#contacts

Download Invoice

3 inputs

Retrieves a specified invoice from Xero Accounting and saves it as a PDF file in a temporary workflow directory.

Inputs

tenant_id

invoice_id

Xero generated unique identifier for the invoice to download.

syncDir

Email an Invoice

2 inputs

Sends a specified sales invoice to a customer via email through Xero's accounting system.

Inputs

tenant_id

invoice_id

Xero generated unique identifier for the invoice to send by email out of Xero. The invoice must be of Type ACCREC and a valid Status for sending (SUMBITTED,AUTHORISED or PAID).

Find Invoice

3 inputs

Retrieves invoice details from Xero Accounting using an invoice number or reference identifier.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

invoiceNumber

Unique alpha numeric code identifying invoice

reference

ACCREC only - additional reference number

Find contact. Optionally, create one if none are found

4 inputs

Searches for a contact in Xero by name or account number, with an option to create a new contact if none exists.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

name

Full name of contact/organization

accountNumber

Account number of Contact.

createContactIfNotFound

Create a new contact if not found?.

Find or Create Contact

3 inputs

Searches for a contact by email in Xero Accounting and creates a new contact if none exists.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

emailAddress

Email address of contact.

createContactIfNotFound

Set to `true` to create a new contact if not found.

Get Bank Summary

3 inputs

Retrieves current balances and detailed cash movement summaries for each bank account linked to the Xero organization.

Inputs

tenant_id

form_date

Get the balances and cash movements for each bank account from this date

to_date

Get the balances and cash movements for each bank account to this date

Get Contact

2 inputs

Retrieves detailed information for a specific contact within the Xero accounting system.

Inputs

tenant_id

contact_identifier

Get History of Changes

3 inputs

Retrieves a detailed audit trail of all changes made to a specific accounting document within Xero.

Inputs

tenant_id

endpoint

The URL component, endpoint of the document type to get history changes. See [supported document types](https://developer.xero.com/documentation/api/history-and-notes#SupportedDocs)

guid

Xero identifier of the document to get history changes of.

Get Invoice

2 inputs

Retrieves comprehensive details of a specified invoice from Xero accounting records.

Inputs

tenant_id

invoice_id

Get Item

2 inputs

Retrieves detailed information about a specific inventory or service item from Xero Accounting.

Inputs

tenant_id

item_id

Get Sales Invoice Online URL

2 inputs

Retrieves a URL that provides direct online access to a specific sales invoice in Xero.

Inputs

tenant_id

invoice_id

Xero generated unique identifier for the invoice to retrieve its online url.

Get Tenant Connections

Retrieves a list of Xero tenant connections the authorized user can access.

List Contacts

8 inputs

Retrieves a filtered list of contact records associated with a specified tenant in Xero Accounting.

Inputs

tenant_id

contact_identifier

modified_after

ids

where

Filter using the where parameter. We recommend you limit filtering to the [optimised elements](https://developer.xero.com/documentation/api/contacts#optimised-parameters) only.

order

Order by any element returned ([*see Order By.*](https://developer.xero.com/documentation/api/requests-and-responses#ordering))

page

Up to 100 contacts will be returned per call when the page parameter is used e.g. page=1.

includeArchived

e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response.

List Credit Notes

6 inputs

Retrieves a list of credit notes from a specified tenant based on provided filter criteria.

Inputs

tenant_id

credit_note_identifier

modified_after

The ModifiedAfter filter is actually an HTTP header: **

where

Filter by an any element ( see [Filters](https://developer.xero.com/documentation/api/requests-and-responses#get-modified) )

order

Order by any element returned ( see [Order By](https://developer.xero.com/documentation/api/requests-and-responses#ordering) )

page

Up to 100 credit notes will be returned per call, with line items shown for each, when the page parameter is used e.g. page=1

List Invoices

11 inputs

Retrieves a list of invoices from a specified tenant based on provided filter criteria.

Inputs

tenant_id

invoice_identifier

An invoice identifier. Possible values:\n\n* **InvoiceID** - The Xero identifier for an Invoice e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9\n* **InvoiceNumber** - The InvoiceNumber e.g. INV-01514

modified_after

The ModifiedAfter filter is actually an HTTP header: **

ids

Filter by a comma-separated list of InvoicesIDs. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

invoice_numbers

Filter by a comma-separated list of InvoiceNumbers. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

contact_ids

Filter by a comma-separated list of ContactIDs. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

statuses

Filter by a comma-separated list of Statuses. See [details](https://developer.xero.com/documentation/api/invoices#optimised-queryparameters).

where

Filter using the *where* parameter. We recommend you limit filtering to the [optimised elements](https://developer.xero.com/documentation/api/invoices#optimised-parameters) only.

created_by_my_app

When set to true you

order

Order by any element returned ( see [Order By](https://developer.xero.com/documentation/api/requests-and-responses#ordering) ).

page

Up to 100 invoices will be returned per call, with line items shown for each, when the page parameter is used e.g. page=1

List Manual Journals

6 inputs

Retrieves a list of manual journal entries for a specified tenant, filtered by provided parameters.

Inputs

tenant_id

manual_journal_id

You can specify an individual record by appending the ManualJournalID to the endpoint, i.e. **GET https://.../ManualJournals/{identifier}**

modified_after

The ModifiedAfter filter is actually an HTTP header: **

where

Filter by an any element (*see [Filters](https://developer.xero.com/documentation/api/requests-and-responses#get-modified)*)

order

Order by any element returned (*see [Order By](https://developer.xero.com/documentation/api/requests-and-responses#ordering)*)

page

Up to 100 manual journals will be returned per call, with journal lines shown for each, when the page parameter is used e.g. page=1

Make API Call

5 inputs

Executes a custom request to the Xero Accounting API to retrieve or manipulate accounting data as specified.

Inputs

request_method

Http method to use in the request.

relative_url

A path relative to Xero Accounting API to send the request against.

query_string

Query string of the request.

headers

request_body

Body of the request.

Update Contact

28 inputs

Updates the details of an existing contact in Xero Accounting using its unique identifier.

Inputs

tenant_id

contact_id

Contact identifier of the contact to update.

name

Full name of contact/organisation (max length = 255). The following is required to create a contact.

contact_number

account_number

A user defined account number. This can be updated via the API and the [Xero UI](https://help.xero.com/ContactsAccountNumber) (max length = 50).

contact_status

Current status of a contact - see contact status [types](https://developer.xero.com/documentation/api/types#ContactStatuses)

first_name

First name of contact person (max length = 255).

last_name

Last name of contact person (max length = 255)

email_address

Email address of contact person (umlauts not supported) (max length = 255)

skype_user_name

Skype user name of contact.

contact_persons

See [contact persons](https://developer.xero.com/documentation/api/contacts#contact-persons).

bank_account_details

Bank account number of contact

tax_number

account_receivable_tax_type

Default tax type used for contact on AP invoices

account_payable_type

Store certain address types for a contact - see address types

addresses

Store certain address types for a contact - see address types

phones

Store certain phone types for a contact - see phone types.

is_supplier

is_customer

default_currency

Default currency for raising invoices against contact

xero_network_key

Store XeroNetworkKey for contacts.

sales_default_account_code

The default sales [account code](https://developer.xero.com/documentation/api/accounts) for contacts

puchases_default_account_code

The default purchases [account code](https://developer.xero.com/documentation/api/accounts) for contacts

sales_tracking_categories

The default sales [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

puechases_tracking_categories

The default purchases [tracking categories](https://developer.xero.com/documentation/api/tracking-categories/) for contacts

tracking_category_name

The name of the Tracking Category assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

tracking_option_name

The name of the Tracking Option assigned to the contact under SalesTrackingCategories and PurchasesTrackingCategories

payment_terms

The default payment terms for the contact - see Payment Terms

Upload File

5 inputs

Uploads a file attachment to a specified document within Xero Accounting, enabling document management alongside financial records.

Inputs

tenantId

Select an organization tenant to use, or provide a tenant ID

filePathOrUrl

The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)

documentType

Document type of where the attachment will be sent to. This is used in as part of the Xero Account API endpoint where the request is sent against.

documentId

Xero identifier of the document where the attachment will be sent to.

syncDir