> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Xero

> Xero is a cloud-based accounting software for small businesses, providing invoicing, bank reconciliation, bookkeeping, and financial reporting in real time

![Xero logo](https://mintcdn.com/composio-preview/11RkPhDhzt1wdr6a/images/toolkits/xero.svg?fit=max\&auto=format\&n=11RkPhDhzt1wdr6a\&q=85\&s=2ced139823817ad0bd60547f5e177252)

* **Category:** accounting
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 74
* **Triggers:** 0
* **Slug:** `XERO`
* **Version:** 20261101\_00

## Frequently Asked Questions

> [accordion] How do I set up custom OAuth credentials for Xero?
>
> For a step-by-step guide on creating and configuring your own Xero OAuth credentials with Composio, see [How to create OAuth credentials for Xero](https://composio.dev/auth/xero).

## Tools

> [accordion] Allocate Overpayment
>
> **Slug:** `XERO_ALLOCATE_OVERPAYMENT`
>
> Allocate part of an existing Xero overpayment to an invoice. The overpayment and invoice must belong to the same contact.
>
> #### Input Parameters
>
> **date** `string` *required*
>
> Allocation date in YYYY-MM-DD format.
>
> **amount** `number` *required*
>
> Positive amount of the overpayment to allocate to the invoice.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **invoice\_id** `string` *required*
>
> Unique identifier of the invoice receiving the allocation.
>
> **overpayment\_id** `string` *required*
>
> Unique identifier of the overpayment to allocate.
>
> **idempotency\_key** `string`
>
> Optional key used by Xero to make retries idempotent.
>
> **summarize\_errors** `boolean`
>
> Whether Xero should summarize validation errors for the request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Create Bank Transactions
>
> **Slug:** `XERO_BULK_CREATE_BANK_TRANSACTIONS`
>
> Create multiple Xero bank transactions with item-level validation results.
>
> #### Input Parameters
>
> **unitdp** `integer`
>
> Decimal precision to use for unit amounts, such as 4.
>
> **tenant\_id** `string`
>
> Xero tenant ID. If omitted, uses the first connected tenant.
>
> **idempotency\_key** `string`
>
> Key used by Xero to make retries idempotent.
>
> **BankTransactions** `array` *required*
>
> One or more bank transactions to create.
>
> **summarize\_errors** `boolean`
>
> Whether Xero should summarize errors instead of returning per-item results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Create Invoices
>
> **Slug:** `XERO_BULK_CREATE_INVOICES`
>
> Create multiple Xero invoices or bills. With summarize\_errors false (the default), return each success and validation outcome.
>
> #### Input Parameters
>
> **unitdp** `integer`
>
> Number of decimal places used for line-item unit amounts.
>
> **invoices** `array` *required*
>
> Invoices and bills to create. Xero returns one outcome per entry when summarize\_errors is false.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **idempotency\_key** `string`
>
> Idempotency key used to safely retry this request. Sent as the Idempotency-Key header.
>
> **allow\_backorders** `boolean`
>
> Whether tracked inventory may be sold when insufficient stock is available.
>
> **summarize\_errors** `boolean`
>
> When false, return validation outcomes for every invoice instead of stopping at the first error.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bank Transaction
>
> **Slug:** `XERO_CREATE_BANK_TRANSACTION`
>
> Create a bank transaction in Xero. Use SPEND for payments out or RECEIVE for money received.
>
> #### Input Parameters
>
> **Date** `string`
>
> Transaction date in YYYY-MM-DD format.
>
> **Type** `string` *required*
>
> Transaction type: SPEND (payment out) or RECEIVE (money in).
>
> **Status** `string`
>
> Transaction status: AUTHORISED or DELETED.
>
> **ContactID** `string` *required*
>
> Xero Contact ID for the transaction.
>
> **LineItems** `array` *required*
>
> List of line items for the bank transaction.
>
> **Reference** `string`
>
> Reference or transaction description.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **CurrencyCode** `string`
>
> Currency code (e.g., USD, EUR).
>
> **BankAccountID** `string`
>
> Bank account UUID identifier. Either bank\_account\_code or bank\_account\_id must be provided.
>
> **BankAccountCode** `string`
>
> Short alphanumeric account code (e.g., '090', '091'), not the account name. Maximum 10 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact
>
> **Slug:** `XERO_CREATE_CONTACT`
>
> Create a new contact in Xero. Contacts can be customers, suppliers, or both.
>
> #### Input Parameters
>
> **Name** `string` *required*
>
> Full name of the contact or organization.
>
> **Website** `string`
>
> Website URL of the contact.
>
> **LastName** `string`
>
> Last name of the contact person.
>
> **FirstName** `string`
>
> First name of the contact person.
>
> **TaxNumber** `string`
>
> Tax number (VAT/ABN/GST number).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **IsCustomer** `boolean`
>
> Mark as customer when true.
>
> **IsSupplier** `boolean`
>
> Mark as supplier when true.
>
> **EmailAddress** `string`
>
> Email address of the contact.
>
> **phone\_number** `string`
>
> Primary phone number (will be added as DEFAULT phone type).
>
> **AccountNumber** `string`
>
> Account reference number for the contact.
>
> **mobile\_number** `string`
>
> Mobile phone number (will be added as MOBILE phone type).
>
> **DefaultCurrency** `string`
>
> Default currency code (e.g., USD, EUR).
>
> **BankAccountDetails** `string`
>
> Bank account details for the contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Credit Note
>
> **Slug:** `XERO_CREATE_CREDIT_NOTE`
>
> Create a new credit note in Xero. Credit notes are used to reduce amounts owed by customers (ACCRECCREDIT) or to suppliers (ACCPAYCREDIT).
>
> #### Input Parameters
>
> **Date** `string`
>
> Credit note date in YYYY-MM-DD format.
>
> **Type** `string ("ACCRECCREDIT" | "ACCPAYCREDIT")` *required*
>
> Credit note type: ACCRECCREDIT (accounts receivable credit) or ACCPAYCREDIT (accounts payable credit).
>
> **Status** `string ("DRAFT" | "SUBMITTED" | "AUTHORISED")`
>
> Credit note status.
>
> **unitdp** `integer`
>
> Unit decimal places (e.g., 4). You can opt in to use four decimal places for unit amounts.
>
> **DueDate** `string`
>
> Due date in YYYY-MM-DD format.
>
> **ContactID** `string`
>
> Xero Contact ID (UUID). At least one of contact\_id or contact\_name must be provided.
>
> **LineItems** `array`
>
> List of line items for the credit note.
>
> **Reference** `string`
>
> Reference or additional information.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, pass the same tenant\_id consistently across all Xero tool calls.
>
> **ContactName** `string`
>
> Contact name. At least one of contact\_id or contact\_name must be provided.
>
> **CurrencyCode** `string`
>
> Currency code (e.g., USD, EUR).
>
> **SentToContact** `boolean`
>
> Mark the credit note as sent to contact. Only applicable to AUTHORISED credit notes.
>
> **BrandingThemeID** `string`
>
> Branding theme identifier (UUID).
>
> **LineAmountTypes** `string ("Exclusive" | "Inclusive" | "NoTax")`
>
> Tax calculation method: Exclusive (amounts exclude tax), Inclusive (amounts include tax), or NoTax.
>
> **CreditNoteNumber** `string`
>
> Credit note number. Omit this field to let Xero auto-generate a number from organisation settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create File Association
>
> **Slug:** `XERO_CREATE_FILE_ASSOCIATION`
>
> Associate a Xero file with an accounting object.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> Internal Xero Files UUID.
>
> **object\_id** `string` *required*
>
> UUID of the Xero object to associate, such as an InvoiceID, BankTransactionID, or ContactID. For the official contact example, use the contact ID with object\_group Contact and object\_type Business.
>
> **tenant\_id** `string`
>
> Xero organisation ID. If omitted, uses the first connected tenant.
>
> **object\_type** `string ("Unknown" | "Accpay" | "AccPayCredit" | "AccPayPayment" | "AccRec" | "AccRecCredit" | "AccRecPayment" | "Adjustment" | "ApCreditPayment" | "ApOverPayment" | "ApOverPaymentPayment" | "ApOverPaymentSourcePayment" | "ApPrepayment" | "ApPrepaymentPayment" | "ApPrepaymentSourcePayment" | "ArCreditPayment" | "ArOverPayment" | "ArOverpaymentPayment" | "ArOverpaymentSourcePayment" | "ArPrepayment" | "ArPrepaymentPayment" | "ArPrepaymentSourcePayment" | "CashPaid" | "CashRec" | "ExpPayment" | "ManJournal" | "PurchaseOrder" | "Receipt" | "Transfer" | "Account" | "Contact" | "Business" | "Employee" | "Person" | "User" | "Org" | "FixedAsset" | "PayRun" | "PriceListItem" | "Bank" | "Current" | "Equity" | "Expense" | "Fixed" | "Liability" | "Prepayment" | "Revenue" | "Sales" | "Overheads" | "Depreciatn" | "OtherIncome" | "DirectCosts" | "Currliab" | "Termliab" | "NonCurrent" | "SalesQuote")`
>
> Optional Xero taxonomy; omit unless known. Business pairs with Contact in Xero's example.
>
> **object\_group** `string ("Account" | "BankTransaction" | "Contact" | "CreditNote" | "Invoice" | "Item" | "ManualJournal" | "Overpayment" | "Payment" | "Prepayment" | "Quote" | "Receipt")` *required*
>
> Required provider association group. For Xero's contact example, select Contact; Xero infers object\_type Business when it is omitted.
>
> **idempotency\_key** `string`
>
> Unique key for safely retrying the same request, up to 128 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Invoice
>
> **Slug:** `XERO_CREATE_INVOICE`
>
> Create a new invoice in Xero. Supports both sales invoices (ACCREC) and bills (ACCPAY).
>
> #### Input Parameters
>
> **Date** `string`
>
> Invoice date in YYYY-MM-DD format.
>
> **Type** `string ("ACCREC" | "ACCPAY")` *required*
>
> Invoice type: ACCREC (accounts receivable/sales) or ACCPAY (accounts payable/bills).
>
> **Status** `string ("DRAFT" | "SUBMITTED" | "AUTHORISED")`
>
> Invoice status.
>
> **DueDate** `string`
>
> Due date in YYYY-MM-DD format.
>
> **ContactID** `string`
>
> Xero Contact ID (UUID). At least one of contact\_id or contact\_name must be provided.
>
> **LineItems** `array` *required*
>
> List of line items for the invoice.
>
> **Reference** `string`
>
> Reference or purchase order number.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, pass the same tenant\_id consistently across all Xero tool calls.
>
> **ContactName** `string`
>
> Contact name. At least one of contact\_id or contact\_name must be provided.
>
> **CurrencyCode** `string`
>
> Currency code (e.g., USD, EUR).
>
> **InvoiceNumber** `string`
>
> Invoice number (auto-generated if not provided). WARNING: If this matches an existing invoice number, Xero will attempt to UPDATE that invoice instead of creating a new one. Omit this field to ensure a new invoice is created, or ensure the number is unique.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Item
>
> **Slug:** `XERO_CREATE_ITEM`
>
> Create an inventory item in Xero. Items can be tracked for sales and/or purchases.
>
> #### Input Parameters
>
> **Code** `string` *required*
>
> Unique item code (SKU).
>
> **Name** `string` *required*
>
> Item name/description.
>
> **IsSold** `boolean`
>
> Item can be sold when true.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **IsPurchased** `boolean`
>
> Item can be purchased when true.
>
> **SalesDetails.UnitPrice** `number`
>
> Unit price for sales.
>
> **SalesDetails.AccountCode** `string`
>
> Account code for sales.
>
> **PurchaseDetails.UnitPrice** `number`
>
> Unit price for purchases.
>
> **PurchaseDetails.AccountCode** `string`
>
> Account code for purchases.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Manual Journal
>
> **Slug:** `XERO_CREATE_MANUAL_JOURNAL`
>
> Create a manual journal in Xero with journal lines. Manual journals must balance (debits equal credits).
>
> #### Input Parameters
>
> **Url** `string`
>
> URL link to a source document for reference, shown as 'Go to \[appName]' in Xero
>
> **Date** `string` *required*
>
> Date journal was posted in YYYY-MM-DD format
>
> **Status** `string ("DRAFT" | "POSTED")`
>
> Manual journal status. DRAFT for unposted journals, POSTED to finalize. Defaults to DRAFT if not specified
>
> **Narration** `string` *required*
>
> Description of journal being posted. This appears as the journal description in Xero
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant
>
> **JournalLines** `array` *required*
>
> Array of journal line items. Manual journals must balance (sum of debits must equal sum of credits) or an error is returned
>
> **LineAmountTypes** `string ("Exclusive" | "Inclusive" | "NoTax")`
>
> Line amount type indicating whether amounts are inclusive or exclusive of tax. Defaults to NoTax if not specified
>
> **idempotency\_key** `string`
>
> Idempotency key to prevent duplicate journal creation. Recommended for production use. This is sent as a header, not in the body
>
> **summarize\_errors** `boolean`
>
> If true, API will return summarized validation errors. If false, detailed errors are returned. Query parameter only
>
> **ShowOnCashBasisReports** `boolean`
>
> Boolean display indicator; defaults to true if not specified
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create or Update Account
>
> **Slug:** `XERO_CREATE_OR_UPDATE_ACCOUNT`
>
> Create a Xero chart-of-account record, or update one by account ID.
>
> #### Input Parameters
>
> **code** `string`
>
> Unique customer-defined alphanumeric account code (maximum 10 characters). Required when creating a non-BANK account; optional for BANK creates and updates.
>
> **name** `string`
>
> Account name (maximum 150 characters). Required when account\_id is omitted to create an account; optional for updates.
>
> **status** `string ("ACTIVE" | "ARCHIVED" | "DELETED")`
>
> Account status. ACTIVE accounts can be updated to ARCHIVED.
>
> **tax\_type** `string`
>
> Tax type code returned by Xero tax rates, such as NONE, INPUT, or OUTPUT2.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **account\_id** `string`
>
> Existing account UUID. Omit to create an account; supply it to update that account.
>
> **description** `string`
>
> Account description. Not valid for BANK accounts.
>
> **CurrencyCode** `string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EEK" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SKK" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW" | "ZMK" | "ZWD")`
>
> Three-letter currency code documented by Xero.
>
> **account\_type** `string ("BANK" | "CURRENT" | "CURRLIAB" | "DEPRECIATN" | "DIRECTCOSTS" | "EQUITY" | "EXPENSE" | "FIXED" | "INVENTORY" | "LIABILITY" | "NONCURRENT" | "OTHERINCOME" | "OVERHEADS" | "PREPAYMENT" | "REVENUE" | "SALES" | "TERMLIAB" | "PAYG")`
>
> Xero account type classification. Required when account\_id is omitted to create an account; optional for updates.
>
> **AddToWatchlist** `boolean`
>
> Whether the account is shown in the dashboard watchlist.
>
> **BankAccountType** `string ("BANK" | "CREDITCARD" | "PAYPAL" | "NONE" | "")`
>
> Bank account type. Valid only for BANK accounts.
>
> **idempotency\_key** `string`
>
> Optional key used by Xero to make retries idempotent.
>
> **BankAccountNumber** `string`
>
> Bank account number. Valid only for BANK accounts.
>
> **ShowInExpenseClaims** `boolean`
>
> Whether the account is available for expense claims.
>
> **EnablePaymentsToAccount** `boolean`
>
> Whether payments can be applied to the account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payment
>
> **Slug:** `XERO_CREATE_PAYMENT`
>
> Create a payment in Xero to link an invoice with a bank account transaction.
>
> #### Input Parameters
>
> **Date** `string`
>
> Payment date in YYYY-MM-DD format.
>
> **Amount** `number` *required*
>
> Payment amount.
>
> **AccountID** `string` *required*
>
> Xero Account ID (bank account) for the payment.
>
> **InvoiceID** `string` *required*
>
> Xero Invoice ID that this payment is for.
>
> **Reference** `string`
>
> Payment reference or description.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **CurrencyRate** `number`
>
> Exchange rate for foreign currency payments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Purchase Order
>
> **Slug:** `XERO_CREATE_PURCHASE_ORDER`
>
> Create a purchase order in Xero to order goods/services from suppliers.
>
> #### Input Parameters
>
> **Date** `string`
>
> Purchase order date in YYYY-MM-DD format.
>
> **Status** `string`
>
> Purchase order status: DRAFT, SUBMITTED, AUTHORISED, BILLED.
>
> **ContactID** `string` *required*
>
> Xero Contact ID for the purchase order.
>
> **LineItems** `array` *required*
>
> List of line items for the purchase order.
>
> **Reference** `string`
>
> Reference or purchase order number.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **DeliveryDate** `string`
>
> Expected delivery date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Quote
>
> **Slug:** `XERO_CREATE_QUOTE`
>
> Create a new sales quote in Xero for a customer or prospect. Quotes can be sent to contacts for approval and later converted to invoices. Use this action when you need to create a formal price proposal or quotation for goods or services before issuing an invoice.
>
> #### Input Parameters
>
> **Date** `string`
>
> Quote date in YYYY-MM-DD format. Defaults to current date if not specified.
>
> **Terms** `string`
>
> Terms and conditions for the quote.
>
> **Title** `string`
>
> Title of the quote.
>
> **Status** `string ("DRAFT" | "SENT" | "ACCEPTED" | "DECLINED" | "INVOICED" | "DELETED")`
>
> Status values for a quote.
>
> **Summary** `string`
>
> Summary description of the quote.
>
> **ContactID** `string`
>
> Xero Contact ID (UUID). At least one of contact\_id or contact\_name must be provided.
>
> **LineItems** `array` *required*
>
> List of line items for the quote. At least one line item is required.
>
> **Reference** `string`
>
> Additional reference or purchase order number.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, pass the same tenant\_id consistently across all Xero tool calls.
>
> **ExpiryDate** `string`
>
> Quote expiry date in YYYY-MM-DD format.
>
> **ContactName** `string`
>
> Contact name. At least one of contact\_id or contact\_name must be provided.
>
> **QuoteNumber** `string`
>
> Unique quote number (auto-generated if not provided). Max 255 characters.
>
> **CurrencyCode** `string`
>
> Currency code (3-letter ISO 4217 code, e.g., USD, EUR, GBP).
>
> **CurrencyRate** `number`
>
> The currency rate for a multicurrency quote. If not specified, uses XE.com day rate.
>
> **BrandingThemeID** `string`
>
> Branding theme identifier (UUID).
>
> **LineAmountTypes** `string ("Exclusive" | "Inclusive" | "NoTax")`
>
> Line amount types for quotes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Tracking Option
>
> **Slug:** `XERO_CREATE_TRACKING_OPTION`
>
> Add an option to an existing Xero tracking category.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the tracking option. Maximum length is 100 characters.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **idempotency\_key** `string`
>
> Idempotency key used to safely retry this request. Sent as the Idempotency-Key header.
>
> **tracking\_category\_id** `string` *required*
>
> Xero identifier of the tracking category to add the option to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Item
>
> **Slug:** `XERO_DELETE_ITEM`
>
> Permanently delete a Xero inventory item by its internal UUID.
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> Internal Xero item UUID to permanently delete.
>
> **tenant\_id** `string`
>
> Xero organisation ID. If omitted, uses the first connected organisation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Attachment
>
> **Slug:** `XERO_DOWNLOAD_ATTACHMENT`
>
> Download an attachment from a supported Xero accounting entity.
>
> #### Input Parameters
>
> **entity\_id** `string` *required*
>
> UUID of the entity that owns the attachment.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **attachment** `string` *required*
>
> Attachment UUID or exact filename returned by Xero.
>
> **entity\_type** `string ("Accounts" | "BankTransactions" | "Contacts" | "CreditNotes" | "Invoices" | "ManualJournals" | "PurchaseOrders" | "Quotes" | "Receipts" | "RepeatingInvoices")` *required*
>
> Xero entity collection that owns the attachment.
>
> **content\_type** `string` *required*
>
> MIME type of the attachment being retrieved, such as image/jpg or application/pdf.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `XERO_GET_ACCOUNT`
>
> Retrieve a specific account from Xero's chart of accounts by its unique ID. Returns detailed account information including code, name, type (BANK, REVENUE, EXPENSE, etc.), status (ACTIVE/ARCHIVED), tax settings, bank details (for BANK accounts), and classification. Use XERO\_LIST\_ACCOUNTS to get account IDs if you don't already have one.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID (UUID format). If not provided, uses the first connected tenant.
>
> **account\_id** `string` *required*
>
> Xero Account ID (UUID format, e.g., '562555f2-8cde-4ce9-8203-0363922537a4'). Get account IDs from XERO\_LIST\_ACCOUNTS action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Asset
>
> **Slug:** `XERO_GET_ASSET`
>
> Retrieve a specific asset by ID from Xero. Returns depreciation details and book value.
>
> #### Input Parameters
>
> **asset\_id** `string` *required*
>
> Xero Asset ID to retrieve.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Balance Sheet Report
>
> **Slug:** `XERO_GET_BALANCE_SHEET_REPORT`
>
> Retrieve Balance Sheet report from Xero. Shows assets, liabilities, and equity at a specific date. Liability and credit balances appear as negative numbers in the response. Response structure is Reports → Rows → Sections; account lines are nested inside group sections and summary totals (e.g., 'Total Current Assets') appear in SummaryRows.
>
> #### Input Parameters
>
> **date** `string`
>
> Balance sheet as of this date in YYYY-MM-DD format. Should align with the organisation's financial year settings; misaligned dates may produce unexpected figures.
>
> **periods** `integer`
>
> Number of periods to compare.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org connections, omitting this returns the first tenant's data silently — always pass explicitly when multiple orgs are connected.
>
> **timeframe** `string`
>
> Timeframe period: MONTH, QUARTER, or YEAR.
>
> **paymentsOnly** `boolean`
>
> Show only cash transactions when true (cash basis).
>
> **standardLayout** `boolean`
>
> Use standard layout when true.
>
> **trackingOptionID** `string`
>
> Filter by tracking option ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bank Summary Report
>
> **Slug:** `XERO_GET_BANK_SUMMARY_REPORT`
>
> Retrieve Xero's account-level Bank Summary for an optional date range.
>
> #### Input Parameters
>
> **to\_date** `string`
>
> Report end date in YYYY-MM-DD format.
>
> **from\_date** `string`
>
> Report start date in YYYY-MM-DD format.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bank Transaction
>
> **Slug:** `XERO_GET_BANK_TRANSACTION`
>
> Retrieve a specific spent or received money transaction from Xero by its unique bank transaction ID. Returns full transaction details including line items, contact, bank account, amounts, and reconciliation status. Use this action when you need to fetch the details of a specific bank transaction that was previously created.
>
> #### Input Parameters
>
> **unitdp** `integer`
>
> Number of decimal places for unit amounts (e.g., 4 for four decimal places). Allows opt-in to use four decimal places for unit amounts.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **bank\_transaction\_id** `string` *required*
>
> Xero generated unique identifier for a bank transaction (UUID format).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Budget
>
> **Slug:** `XERO_GET_BUDGET`
>
> Retrieve a budget from Xero. Budgets track planned vs actual spending by account.
>
> #### Input Parameters
>
> **DateTo** `string`
>
> End date for budget data in YYYY-MM-DD format.
>
> **DateFrom** `string`
>
> Start date for budget data in YYYY-MM-DD format.
>
> **budget\_id** `string` *required*
>
> Xero Budget ID to retrieve.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Connections
>
> **Slug:** `XERO_GET_CONNECTIONS`
>
> Tool to list active Xero connections. Use to retrieve all current tenant connections for the authenticated user and resolve the correct tenant\_id before making data requests. When multiple tenants are returned, never assume the first connection is correct — always explicitly pass the intended tenant\_id to every subsequent call. Using a wrong or stale tenant\_id can silently return or modify data for a different organisation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact Aged Report
>
> **Slug:** `XERO_GET_CONTACT_AGED_REPORT`
>
> Retrieve aged payables or receivables rows for one Xero contact.
>
> #### Input Parameters
>
> **date** `string`
>
> Report date in YYYY-MM-DD format.
>
> **to\_date** `string`
>
> End date in YYYY-MM-DD format.
>
> **from\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **contact\_id** `string` *required*
>
> Xero contact UUID whose aged balances should be reported.
>
> **report\_type** `string ("PAYABLES" | "RECEIVABLES")` *required*
>
> Contact aging report to retrieve: PAYABLES or RECEIVABLES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact History
>
> **Slug:** `XERO_GET_CONTACT_HISTORY`
>
> Retrieve activity history records for a Xero contact.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **contact\_id** `string` *required*
>
> Unique Xero identifier of the contact whose history to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contacts
>
> **Slug:** `XERO_GET_CONTACTS`
>
> Tool to retrieve a list of contacts. Use when you need up-to-date contact information with filtering, paging, or incremental updates.
>
> #### Input Parameters
>
> **IDs** `array`
>
> Comma-separated list of ContactIDs to filter by.
>
> **page** `integer`
>
> Page number for paginated results (requires pageSize). Iterate incrementing page until an empty result is returned to exhaust all records.
>
> **order** `string`
>
> Sort by field, e.g. UpdatedDateUTC DESC.
>
> **where** `string`
>
> OData-style filter for querying contacts. Optimized fields: Name, EmailAddress, AccountNumber, TaxNumber, ContactStatus, City, Country, IsCustomer, IsSupplier. Note: On high-volume accounts, some filters (e.g., IsCustomer, IsSupplier) may be rejected by Xero. If a filter fails on high-volume accounts, use searchTerm, page/pageSize pagination, or remove the where filter.
>
> **pageSize** `integer`
>
> Number of contacts per page (requires page).
>
> **ContactID** `string`
>
> Xero ContactID. If provided, fetches a single contact at /Contacts/\{ContactID}.
>
> **searchTerm** `string`
>
> Case-insensitive search across Name, FirstName, LastName, ContactNumber, CompanyNumber, EmailAddress.
>
> **summaryOnly** `boolean`
>
> Return a lightweight summary-only response when true.
>
> **includeArchived** `boolean`
>
> Include archived contacts when true.
>
> **If-Modified-Since** `string`
>
> UTC timestamp (YYYY-MM-DDThh:mm:ss) to set as the If-Modified-Since header; returns only contacts created or modified since this timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Credit Note
>
> **Slug:** `XERO_GET_CREDIT_NOTE`
>
> Retrieve a specific credit note by ID from Xero. Returns full credit note details including line items, allocations, and status. Use this action when you need to fetch detailed information about a single credit note by its UUID identifier.
>
> #### Input Parameters
>
> **unitdp** `integer`
>
> Number of decimal places for unit amounts (default 4). You can opt in to use four decimal places for unit amounts.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, always pass explicitly to avoid querying the wrong organisation's data.
>
> **credit\_note\_id** `string` *required*
>
> Xero Credit Note ID to retrieve. Must be the internal UUID (e.g. `a1b2c3d4-...`), not the human-readable CreditNoteNumber (e.g. `CN-0001`); obtain the UUID via XERO\_LIST\_CREDIT\_NOTES first.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Invoice
>
> **Slug:** `XERO_GET_INVOICE`
>
> Retrieve a specific invoice by ID from Xero. Returns full invoice details including line items and status.
>
> #### Input Parameters
>
> **unitdp** `integer`
>
> Number of decimal places for unit amounts (default 4).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, always pass explicitly to avoid querying the wrong organisation's data.
>
> **invoice\_id** `string` *required*
>
> Xero Invoice ID to retrieve. Must be the internal UUID (e.g. `a1b2c3d4-...`), not the human-readable InvoiceNumber (e.g. `INV-0001`); obtain the UUID via XERO\_LIST\_INVOICES first.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Item
>
> **Slug:** `XERO_GET_ITEM`
>
> Retrieve a specific item by ID from Xero. Returns item code, name, pricing, and tax details.
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> Xero Item ID to retrieve.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Manual Journal
>
> **Slug:** `XERO_GET_MANUAL_JOURNAL`
>
> Retrieve a specific manual journal by ID from Xero. Returns full details including journal lines.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **manual\_journal\_id** `string` *required*
>
> Xero Manual Journal ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Online Invoice
>
> **Slug:** `XERO_GET_ONLINE_INVOICE`
>
> Retrieve the hosted online-invoice URL for an authorised Xero invoice.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero organisation ID. If omitted, uses the first connected organisation.
>
> **invoice\_id** `string` *required*
>
> Internal Xero invoice UUID. The invoice must be authorised.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organisation
>
> **Slug:** `XERO_GET_ORGANISATION`
>
> Retrieve organisation details from Xero. Returns company info, base currency, timezone, financial year settings, SalesTaxBasis, SalesTaxPeriod, etc. Response fields are nested under data.data.Organisations\[0]. Use Timezone when computing date ranges to avoid boundary errors.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-tenant setups, omitting this defaults to the first tenant which may be unintended; use XERO\_GET\_CONNECTIONS to confirm the correct tenant\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment
>
> **Slug:** `XERO_GET_PAYMENT`
>
> Retrieve a specific payment by ID from Xero. Returns full payment details including associated invoice, account, and reconciliation status. Use this action when you need to inspect a particular payment record to verify its status, amount, or linked transactions.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, always pass explicitly to avoid querying the wrong organisation's data.
>
> **payment\_id** `string` *required*
>
> Unique identifier for the Payment. Must be the internal UUID (e.g., `a1b2c3d4-...`), not a payment reference; obtain the UUID via XERO\_LIST\_PAYMENTS first.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Profit & Loss Report
>
> **Slug:** `XERO_GET_PROFIT_LOSS_REPORT`
>
> Retrieve a Xero Profit & Loss report showing income, expenses, and net profit; when both dates are supplied, their range cannot exceed 365 days. Parse labeled report rows by label rather than index; the report aggregates tax codes and is not suitable for tax compliance reporting.
>
> #### Input Parameters
>
> **toDate** `string`
>
> End date for the report in YYYY-MM-DD format. Date range between fromDate and toDate must not exceed 365 days.
>
> **periods** `integer`
>
> Number of periods to compare (e.g., for month-on-month comparison).
>
> **fromDate** `string`
>
> Start date for the report in YYYY-MM-DD format. Date range between fromDate and toDate must not exceed 365 days.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **timeframe** `string`
>
> Timeframe period: MONTH, QUARTER, or YEAR.
>
> **paymentsOnly** `boolean`
>
> Show only cash transactions when true (cash basis).
>
> **standardLayout** `boolean`
>
> Use standard layout when true.
>
> **trackingOptionID** `string`
>
> Filter by tracking option ID.
>
> **trackingOptionID2** `string`
>
> Filter by second tracking option ID.
>
> **trackingCategoryID** `string`
>
> Filter by tracking category ID.
>
> **trackingCategoryID2** `string`
>
> Filter by second tracking category ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project
>
> **Slug:** `XERO_GET_PROJECT`
>
> Retrieve a specific project by ID from Xero. Returns project details, deadlines, and status.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **project\_id** `string` *required*
>
> Xero Project ID to retrieve. Must be a valid GUID format (e.g., '550e8400-e29b-41d4-a716-446655440000'); job numbers or non-GUID strings will fail.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Purchase Order
>
> **Slug:** `XERO_GET_PURCHASE_ORDER`
>
> Retrieve a specific purchase order by ID from Xero. Returns full details including line items and status.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **purchase\_order\_id** `string` *required*
>
> Xero Purchase Order ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Quotes
>
> **Slug:** `XERO_GET_QUOTES`
>
> Tool to retrieve a list of quotes. Use when you need to list, filter, or page through sales quotes. Use after obtaining the tenant ID via connections.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results (1-based).
>
> **order** `string`
>
> Order by any element, e.g., ExpiryDate ASC.
>
> **DateTo** `string`
>
> Filter for quotes on or before this date (YYYY-MM-DD).
>
> **Status** `string`
>
> Filter for quotes of a particular status.
>
> **DateFrom** `string`
>
> Filter for quotes on or after this date (YYYY-MM-DD).
>
> **ContactID** `string`
>
> Filter for quotes belonging to a particular contact by ContactID.
>
> **tenant\_id** `string`
>
> Xero Tenant ID. Optional - will auto-fetch from connections if not provided.
>
> **QuoteNumber** `string`
>
> Filter by quote number.
>
> **ExpiryDateTo** `string`
>
> Filter for quotes expiring on or before this date (YYYY-MM-DD).
>
> **ExpiryDateFrom** `string`
>
> Filter for quotes expiring on or after this date (YYYY-MM-DD).
>
> **If-Modified-Since** `string`
>
> Only return quotes modified after this UTC timestamp in RFC3339 format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Record History
>
> **Slug:** `XERO_GET_RECORD_HISTORY`
>
> Retrieve history for a Xero bank transaction, invoice, manual journal, or payment.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero organisation ID. If omitted, uses the first connected tenant.
>
> **resource\_id** `string` *required*
>
> Internal Xero UUID of the selected record.
>
> **resource\_type** `string ("bank_transaction" | "invoice" | "manual_journal" | "payment")` *required*
>
> Type of Xero record whose history to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Repeating Invoice
>
> **Slug:** `XERO_GET_REPEATING_INVOICE`
>
> Retrieve a Xero repeating invoice template by its unique ID.
>
> #### Input Parameters
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **repeating\_invoice\_id** `string` *required*
>
> Xero-generated UUID of the repeating invoice template.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Trial Balance Report
>
> **Slug:** `XERO_GET_TRIAL_BALANCE_REPORT`
>
> Retrieve Trial Balance report from Xero. Shows all account balances (debits and credits) at a specific date. Use to verify that total debits equal total credits and to prepare financial statements. Credit balances appear as negative numbers in the response.
>
> #### Input Parameters
>
> **date** `string`
>
> The date for the Trial Balance report in YYYY-MM-DD format (e.g., 2018-03-31). If not specified, defaults to current date.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org connections, omitting this returns the first tenant's data silently — always pass explicitly when multiple orgs are connected.
>
> **paymentsOnly** `boolean`
>
> Return cash only basis for the Trial Balance report when true (cash basis accounting).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Accounts
>
> **Slug:** `XERO_LIST_ACCOUNTS`
>
> Retrieve Xero's chart of accounts, with optional filtering and ordering. AccountID uniquely identifies an account.
>
> #### Input Parameters
>
> **order** `string`
>
> Sort by field, e.g. Code ASC or Name DESC.
>
> **where** `string`
>
> OData-style filter, e.g. Status=="ACTIVE" AND Type=="EXPENSE" Invalid syntax silently returns empty or misleading results rather than an explicit error. Status-based filters (e.g., Status=="ACTIVE") exclude archived accounts; omit to retrieve full historical chart.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. Always specify when multiple organisations exist — omitting it defaults to the first tenant and may return another entity's data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Advance Payments
>
> **Slug:** `XERO_LIST_ADVANCE_PAYMENTS`
>
> List filtered Xero overpayments or prepayments.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve, starting at 1.
>
> **order** `string`
>
> Xero sort expression, for example Date DESC or Reference ASC.
>
> **where** `string`
>
> Xero filter expression, for example Status=="AUTHORISED".
>
> **unitdp** `integer`
>
> Decimal places to return for unit amounts.
>
> **page\_size** `integer`
>
> Number of records to retrieve per page.
>
> **tenant\_id** `string`
>
> Xero organisation ID. If omitted, uses the first connected organisation.
>
> **references** `array`
>
> References to include. Xero receives these as one comma-separated filter.
>
> **payment\_type** `string ("overpayment" | "prepayment")` *required*
>
> Advance-payment collection to list: overpayment or prepayment.
>
> **invoice\_numbers** `array`
>
> Invoice numbers to include. Supported only when payment\_type is prepayment.
>
> **if\_modified\_since** `string`
>
> ISO 8601 timestamp; return records created or modified since this time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Assets
>
> **Slug:** `XERO_LIST_ASSETS`
>
> Retrieve fixed assets from Xero by status, defaulting to DRAFT. Assets track depreciation and book value of capital equipment.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results. Defaults to 1.
>
> **status** `string`
>
> Required. Asset status filter. Valid values: DRAFT, REGISTERED, DISPOSED. Defaults to DRAFT.
>
> **orderBy** `string`
>
> Sort field. Valid values: AssetType, AssetName, AssetNumber, PurchaseDate, PurchasePrice. For DISPOSED status, also allows: DisposalDate, DisposalPrice.
>
> **filterBy** `string`
>
> Filter string to search assets. Matches against AssetName, AssetNumber, Description, and AssetTypeName fields.
>
> **pageSize** `integer`
>
> Number of assets per page. Defaults to 10.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **sortDirection** `string`
>
> Sort direction. Valid values: asc, desc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Attachments
>
> **Slug:** `XERO_LIST_ATTACHMENTS`
>
> List all attachments for a specific entity in Xero (invoice, contact, etc.).
>
> #### Input Parameters
>
> **entity\_id** `string` *required*
>
> ID of the entity to list attachments for.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **entity\_type** `string` *required*
>
> Entity type: Invoices, Contacts, BankTransactions, CreditNotes, PurchaseOrders, etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bank Transactions
>
> **Slug:** `XERO_LIST_BANK_TRANSACTIONS`
>
> Retrieve bank transactions from Xero. Includes SPEND, RECEIVE, and transfer types; unfiltered results include DELETED transactions that skew totals. Dates returned in /Date(milliseconds\_since\_epoch)/ format. Rate limit: \~60 requests/minute per org; heavy pagination may trigger 429 errors.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results. Returns max 100 items per page; no total count provided. Iterate by incrementing page until response returns zero results.
>
> **order** `string`
>
> Sort by field, e.g. Date DESC or UpdatedDateUTC ASC. Default ordering is unreliable; always specify explicitly (e.g., Date DESC).
>
> **where** `string`
>
> OData-style filter, e.g. Status=="AUTHORISED" AND Type=="SPEND" String values require double quotes; field names must be exact (e.g., BankAccount.AccountID, IsReconciled, Status, Type). Malformed expressions or wrong field names silently return empty results. Always filter by Status (e.g., Status=="AUTHORISED") to exclude DELETED transactions. Use IsReconciled boolean for reconciliation filtering, not Status alone.
>
> **unitdp** `integer`
>
> Decimal places for unit amounts (default 4).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, always provide explicitly to avoid targeting the wrong organisation.
>
> **If-Modified-Since** `string`
>
> UTC timestamp to return only bank transactions modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Batch Payments
>
> **Slug:** `XERO_LIST_BATCH_PAYMENTS`
>
> List Xero batch payments with documented filtering and ordering controls.
>
> #### Input Parameters
>
> **order** `string`
>
> Xero ordering expression, for example Date ASC.
>
> **where** `string`
>
> Xero filter expression, for example Status=="AUTHORISED".
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **if\_modified\_since** `string`
>
> UTC timestamp to return only batch payments modified since this time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Credit Notes
>
> **Slug:** `XERO_LIST_CREDIT_NOTES`
>
> Retrieve list of credit notes from Xero. Credit notes are issued to reduce amounts owed by customers.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results.
>
> **order** `string`
>
> Sort by field, e.g. Date DESC or CreditNoteNumber ASC.
>
> **where** `string`
>
> OData-style filter, e.g. Status=="AUTHORISED"
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **If-Modified-Since** `string`
>
> UTC timestamp to return only credit notes modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organisation Currencies
>
> **Slug:** `XERO_LIST_CURRENCIES`
>
> List currencies enabled for the connected Xero organisation.
>
> #### Input Parameters
>
> **order** `string`
>
> Sort by a currency field, for example Code ASC.
>
> **where** `string`
>
> OData-style filter, for example Code=="USD".
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List File Associations
>
> **Slug:** `XERO_LIST_FILE_ASSOCIATIONS`
>
> List Xero business objects associated with a specific file.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> Internal Xero Files UUID.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Files
>
> **Slug:** `XERO_LIST_FILES`
>
> Retrieve files from Xero Files. Lists documents stored in Xero's file management system.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results.
>
> **sort** `string`
>
> Sort field: Name, Size, CreatedDateUTC.
>
> **folderId** `string`
>
> Filter files by folder ID.
>
> **pagesize** `integer`
>
> Number of files per page (max 100).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Folders
>
> **Slug:** `XERO_LIST_FOLDERS`
>
> Retrieve folders from Xero Files. Lists document folders in Xero's file management system.
>
> #### Input Parameters
>
> **sort** `string`
>
> Sort field: Name, CreatedDateUTC.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Invoices
>
> **Slug:** `XERO_LIST_INVOICES`
>
> Retrieve a list of invoices from Xero. Results include both sales invoices (Type=ACCREC) and bills (Type=ACCPAY) by default; filter by Type in the `where` clause when only one is needed. Supports filtering by status, contact, date range, and pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results. Returns up to 100 invoices per page; increment page and check `pagination.pageCount` in the response to retrieve all records.
>
> **order** `string`
>
> Sort by field, e.g. Date DESC or InvoiceNumber ASC.
>
> **where** `string`
>
> OData-style filter, e.g. Status=="AUTHORISED" AND Total>100 Malformed expressions silently return empty results rather than an error.
>
> **Statuses** `string`
>
> Comma-separated list of invoice statuses to filter by (e.g., DRAFT, SUBMITTED, AUTHORISED, PAID).
>
> **tenantId** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. When multiple organisations are connected, always pass this explicitly to avoid querying the wrong organisation's data.
>
> **ContactIDs** `string`
>
> Comma-separated list of Contact IDs to filter invoices by contact.
>
> **InvoiceIDs** `string`
>
> Comma-separated list of Invoice IDs to filter by.
>
> **createdByMyApp** `boolean`
>
> Filter to invoices created by your app when true.
>
> **includeArchived** `boolean`
>
> Include archived invoices when true.
>
> **If-Modified-Since** `string`
>
> UTC timestamp to return only invoices modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Items
>
> **Slug:** `XERO_LIST_ITEMS`
>
> Retrieve items (inventory/products) from Xero. Items can be tracked for sales and/or purchases.
>
> #### Input Parameters
>
> **order** `string`
>
> Sort by field, e.g. Code ASC or Name DESC.
>
> **where** `string`
>
> OData-style filter, e.g. IsSold==true AND IsPurchased==true
>
> **unitdp** `integer`
>
> Number of decimal places for unit amounts (default 4).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Journals
>
> **Slug:** `XERO_LIST_JOURNALS`
>
> Retrieve journals from Xero, with optional modified-since and payment-only filters and offset pagination. Journals show accounting entries for transactions and are returned in a Journals array.
>
> #### Input Parameters
>
> **offset** `integer`
>
> Offset for pagination. Increment by 100 (the page size) across successive calls to retrieve all journals. Deduplicate results by JournalNumber to avoid gaps or duplicates.
>
> **tenantId** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **paymentsOnly** `boolean`
>
> Filter to payment journals only when true.
>
> **If-Modified-Since** `string`
>
> UTC timestamp to return only journals modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Manual Journals
>
> **Slug:** `XERO_LIST_MANUAL_JOURNALS`
>
> Retrieve manual journals from Xero. Manual journals are used for period-end adjustments and corrections.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results.
>
> **order** `string`
>
> Sort by field, e.g. Date DESC.
>
> **where** `string`
>
> OData-style filter, e.g. Status=="POSTED"
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **If-Modified-Since** `string`
>
> UTC timestamp to return only manual journals modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payments
>
> **Slug:** `XERO_LIST_PAYMENTS`
>
> Retrieve list of payments from Xero. Payments link invoices to bank transactions; invoices may have multiple partial/split payment records. Response Date fields use Xero's /Date(milliseconds)/ format requiring custom parsing.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results. Returns max 100 items per page; iterate incrementing page until response returns empty array. Xero enforces \~60 requests/minute per org (HTTP 429 if exceeded).
>
> **order** `string`
>
> Sort by field, e.g. Date DESC or Amount ASC.
>
> **where** `string`
>
> OData-style filter, e.g. Status=="AUTHORISED" Results include both ACCREC and ACCPAY types; filter by Type=="ACCREC" or Type=="ACCPAY" to isolate sales or bill payments. Avoid strict Reference matching as format variations may miss valid records.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. Wrong tenant\_id silently returns empty results; verify with XERO\_GET\_CONNECTIONS before large pulls.
>
> **If-Modified-Since** `string`
>
> UTC timestamp to return only payments modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Projects
>
> **Slug:** `XERO_LIST_PROJECTS`
>
> Retrieve projects from Xero. Projects track time and costs for client work.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results.
>
> **states** `string`
>
> Comma-separated project states: INPROGRESS, CLOSED.
>
> **pageSize** `integer`
>
> Number of projects per page (1-500, default 50).
>
> **contactID** `string`
>
> Filter projects by contact ID.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **projectIds** `string`
>
> Comma-separated list of project IDs to filter by.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Project Time Entries
>
> **Slug:** `XERO_LIST_PROJECT_TIME_ENTRIES`
>
> List and filter time entries logged against a specific Xero project.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for the paged response. Must be at least 1.
>
> **states** `array`
>
> Statuses to include, such as ACTIVE, LOCKED, or INVOICED.
>
> **task\_id** `string`
>
> Filter by the project task UUID.
>
> **user\_id** `string`
>
> Filter by the UUID of the Xero user who logged the time.
>
> **page\_size** `integer`
>
> Number of time entries per page, from 1 to 500.
>
> **tenant\_id** `string`
>
> Xero organisation ID. If omitted, uses the first connected organisation.
>
> **contact\_id** `string`
>
> Filter by the contact UUID.
>
> **invoice\_id** `string`
>
> Filter by the invoice UUID.
>
> **project\_id** `string` *required*
>
> Internal Xero project UUID.
>
> **is\_chargeable** `boolean`
>
> Filter to entries for tasks with TIME or FIXED charge types.
>
> **date\_after\_utc** `string`
>
> Include entries on or after this ISO 8601 UTC timestamp.
>
> **date\_before\_utc** `string`
>
> Include entries on or before this ISO 8601 UTC timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Purchase Orders
>
> **Slug:** `XERO_LIST_PURCHASE_ORDERS`
>
> Retrieve list of purchase orders from Xero. Purchase orders track goods/services ordered from suppliers.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results.
>
> **order** `string`
>
> Sort by field, e.g. Date DESC or PurchaseOrderNumber ASC.
>
> **DateTo** `string`
>
> Filter by date to (YYYY-MM-DD).
>
> **Status** `string`
>
> Filter by status: DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED.
>
> **DateFrom** `string`
>
> Filter by date from (YYYY-MM-DD).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **If-Modified-Since** `string`
>
> UTC timestamp to return only purchase orders modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Quotes
>
> **Slug:** `XERO_LIST_QUOTES`
>
> Retrieve a list of sales quotes from Xero with optional filtering and pagination. Supports filtering by date ranges, contact, status, and quote number. Returns up to 100 quotes per page with full line item details. Use this action when you need to query, list, or search for quotes in a Xero organization.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results. Up to 100 quotes will be returned in a single API call with line items shown for each quote.
>
> **order** `string`
>
> Order by any element. Specify field name and optionally ASC or DESC.
>
> **DateTo** `string`
>
> Filter for quotes on or before this date (YYYY-MM-DD).
>
> **Status** `string`
>
> Filter for quotes of a particular status.
>
> **DateFrom** `string`
>
> Filter for quotes on or after this date (YYYY-MM-DD).
>
> **ContactID** `string`
>
> Filter for quotes belonging to a particular contact by ContactID.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. When multiple organisations are connected, always pass this explicitly to avoid querying the wrong organisation's data.
>
> **QuoteNumber** `string`
>
> Filter by quote number.
>
> **ExpiryDateTo** `string`
>
> Filter for quotes expiring on or before this date (YYYY-MM-DD).
>
> **ExpiryDateFrom** `string`
>
> Filter for quotes expiring on or after this date (YYYY-MM-DD).
>
> **if\_modified\_since** `string`
>
> Only return quotes modified after this timestamp. Use ISO 8601 format (e.g., 2020-02-06T12:17:43.202-08:00).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tax Rates
>
> **Slug:** `XERO_LIST_TAX_RATES`
>
> Retrieve tax rates from Xero. Shows available tax codes and rates for the organization. Use returned tax codes as valid `TaxType` values in other tools — invalid values cause ValidationException errors.
>
> #### Input Parameters
>
> **order** `string`
>
> Sort by field, e.g. Name ASC.
>
> **where** `string`
>
> OData-style filter, e.g. Status=="ACTIVE"
>
> **TaxType** `string`
>
> Filter by specific tax type.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org connections, always specify to avoid retrieving tax config from the wrong organisation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tracking Categories
>
> **Slug:** `XERO_LIST_TRACKING_CATEGORIES`
>
> Retrieve tracking categories from Xero. Tracking categories are used to segment data for reporting (e.g., departments, regions).
>
> #### Input Parameters
>
> **order** `string`
>
> Sort by field, e.g. Name ASC.
>
> **where** `string`
>
> OData-style filter, e.g. Status=="ACTIVE"
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **includeArchived** `boolean`
>
> Include archived tracking categories when true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organisation Users
>
> **Slug:** `XERO_LIST_USERS`
>
> List users of the connected Xero organisation.
>
> #### Input Parameters
>
> **order** `string`
>
> Sort by a user field, e.g. LastName ASC.
>
> **where** `string`
>
> OData-style filter, e.g. OrganisationRole=="STANDARD".
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **if\_modified\_since** `string`
>
> UTC timestamp to return only users modified since this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Invoice
>
> **Slug:** `XERO_POST_INVOICE_UPDATE`
>
> Tool to update an existing invoice. Use when you need to modify the details of an invoice after it's been created.
>
> #### Input Parameters
>
> **unitdp** `integer`
>
> Number of decimal places for unit amounts.
>
> **Invoices** `array` *required*
>
> List containing invoice update definitions (one item).
>
> **InvoiceID** `string`
>
> Unique identifier (UUID) of the invoice.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **InvoiceNumber** `string`
>
> Invoice number identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Bank Transaction
>
> **Slug:** `XERO_UPDATE_BANK_TRANSACTION`
>
> Update an existing bank transaction in Xero. Use this action when you need to modify details of a previously created bank transaction such as line items, reference, date, or status. Note: Reconciled transactions cannot be updated and will return a validation error.
>
> #### Input Parameters
>
> **Date** `string`
>
> Transaction date in YYYY-MM-DD format.
>
> **Type** `string ("SPEND" | "RECEIVE")`
>
> Transaction type: SPEND (payment out) or RECEIVE (money in).
>
> **Status** `string ("AUTHORISED" | "DELETED")`
>
> Transaction status: AUTHORISED or DELETED.
>
> **unitdp** `integer`
>
> Number of decimal places for unit amounts.
>
> **ContactID** `string`
>
> Xero Contact ID for the transaction.
>
> **LineItems** `array`
>
> List of line items for the bank transaction.
>
> **Reference** `string`
>
> Reference or transaction description.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **CurrencyCode** `string`
>
> Currency code (e.g., USD, EUR).
>
> **BankAccountID** `string`
>
> Bank account UUID identifier.
>
> **BankAccountCode** `string`
>
> Short alphanumeric account code (e.g., '090', '091'), not the account name. Maximum 10 characters.
>
> **BankTransactionID** `string` *required*
>
> Xero identifier for the bank transaction to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact
>
> **Slug:** `XERO_UPDATE_CONTACT`
>
> Update an existing contact in Xero. Only provided fields will be updated.
>
> #### Input Parameters
>
> **Name** `string`
>
> Full name of the contact or organization.
>
> **LastName** `string`
>
> Last name of the contact person.
>
> **ContactID** `string` *required*
>
> Xero Contact ID to update.
>
> **FirstName** `string`
>
> First name of the contact person.
>
> **TaxNumber** `string`
>
> Tax number (VAT/ABN/GST number).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **EmailAddress** `string`
>
> Email address of the contact.
>
> **phone\_number** `string`
>
> Primary phone number (will update DEFAULT phone type).
>
> **AccountNumber** `string`
>
> Account reference number for the contact.
>
> **mobile\_number** `string`
>
> Mobile phone number (will update MOBILE phone type).
>
> **DefaultCurrency** `string`
>
> Default currency code (e.g., USD, EUR).
>
> **BankAccountDetails** `string`
>
> Bank account details for the contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Credit Note
>
> **Slug:** `XERO_UPDATE_CREDIT_NOTE`
>
> Updates a specific credit note in Xero by its unique identifier. This action allows you to modify credit note details such as status, line items, reference numbers, and other fields after the credit note has been created. Use this action when you need to change the status of a credit note (e.g., from DRAFT to AUTHORISED), update line items, modify reference information, or make other changes to an existing credit note. The credit note must already exist in Xero - use the credit\_note\_id to specify which credit note to update. Not all fields can be updated depending on the current status of the credit note.
>
> #### Input Parameters
>
> **Status** `string ("DRAFT" | "SUBMITTED" | "DELETED" | "AUTHORISED" | "PAID" | "VOIDED")`
>
> Status of the credit note. Use this action when you need to change the status, update line items, or modify other credit note details after creation.
>
> **unitdp** `integer`
>
> Unit decimal places. You can opt in to use four decimal places for unit amounts (e.g., unitdp=4).
>
> **LineItems** `array`
>
> List of line items for the credit note. Provide this to update the line items on the credit note.
>
> **Reference** `string`
>
> Additional reference number for ACCRECCREDIT credit notes.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant. In multi-org setups, pass the same tenant\_id consistently across all Xero tool calls.
>
> **CreditNoteID** `string` *required*
>
> Unique identifier for the Credit Note to update.
>
> **CurrencyCode** `string`
>
> Currency code for the credit note (e.g., USD, EUR). 3-letter ISO 4217 code.
>
> **CurrencyRate** `number`
>
> Exchange rate for multi-currency credit notes. Maximum 18 digits with 6 decimal places.
>
> **SentToContact** `boolean`
>
> Boolean to set whether the credit note should be marked as 'sent' to the contact. Only applicable to AUTHORISED credit notes.
>
> **BrandingThemeID** `string`
>
> Identifier for the branding theme to apply to the credit note.
>
> **Idempotency-Key** `string`
>
> Allows you to safely retry requests without the risk of duplicate processing. Maximum 128 characters.
>
> **LineAmountTypes** `string ("Exclusive" | "Inclusive" | "NoTax")`
>
> Line amount type specifying how tax is calculated. Exclusive: line amounts exclude tax, Inclusive: line amounts include tax, NoTax: no tax.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Item
>
> **Slug:** `XERO_UPDATE_ITEM`
>
> Update an existing Xero inventory item by its ItemID.
>
> #### Input Parameters
>
> **Code** `string` *required*
>
> Unique item code. Xero requires it when updating an item.
>
> **Name** `string`
>
> Name of the item.
>
> **IsSold** `boolean`
>
> Whether the item is available on sales transactions.
>
> **unitdp** `integer`
>
> Number of decimal places Xero uses for unit amounts in the response.
>
> **item\_id** `string` *required*
>
> Xero identifier of the item to update.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If omitted, uses the first connected tenant.
>
> **Description** `string`
>
> Description used when selling the item.
>
> **IsPurchased** `boolean`
>
> Whether the item is available on purchase transactions.
>
> **SalesDetails** `object`
>
> Sales settings for a Xero item.
>
> **PurchaseDetails** `object`
>
> Purchase settings for a Xero item.
>
> **idempotency\_key** `string`
>
> Idempotency key used to safely retry this update.
>
> **PurchaseDescription** `string`
>
> Description used when purchasing the item.
>
> **InventoryAssetAccountCode** `string`
>
> Inventory asset account code. Pair with PurchaseDetails.COGSAccountCode to configure tracked inventory.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Manual Journal
>
> **Slug:** `XERO_UPDATE_MANUAL_JOURNAL`
>
> Update an existing manual journal (journal entry) in Xero by its ID. Use this action when you need to modify the narration, date, journal lines, status, or other properties of an existing manual journal. Manual journals must balance (debits equal credits) or the update will fail. Only DRAFT manual journals can have their journal lines updated; POSTED journals can have limited fields updated.
>
> #### Input Parameters
>
> **Url** `string`
>
> URL link to a source document for reference, shown as 'Go to \[appName]' in Xero
>
> **Date** `string`
>
> Date journal was posted in YYYY-MM-DD format
>
> **Status** `string ("DRAFT" | "POSTED")`
>
> Manual journal status. DRAFT for unposted journals, POSTED to finalize
>
> **Narration** `string` *required*
>
> Description of journal being posted. This appears as the journal description in Xero
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant
>
> **JournalLines** `array`
>
> Array of journal line items. Manual journals must balance (sum of debits must equal sum of credits) or an error is returned
>
> **LineAmountTypes** `string ("Exclusive" | "Inclusive" | "NoTax")`
>
> Line amount type indicating whether amounts are inclusive or exclusive of tax
>
> **idempotency\_key** `string`
>
> Idempotency key to prevent duplicate updates. Recommended for production use. This is sent as a header, not in the body
>
> **summarize\_errors** `boolean`
>
> If true, API will return summarized validation errors. If false, detailed errors are returned. Query parameter only
>
> **manual\_journal\_id** `string` *required*
>
> Unique identifier for the ManualJournal to update
>
> **ShowOnCashBasisReports** `boolean`
>
> Boolean display indicator; defaults to true if not specified
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Purchase Order
>
> **Slug:** `XERO_UPDATE_PURCHASE_ORDER`
>
> Updates a specific purchase order in Xero by its unique identifier. Use this action when you need to modify an existing purchase order's details such as line items, delivery information, status, or other fields. Only the fields provided in the request will be updated; fields not included will remain unchanged.
>
> #### Input Parameters
>
> **Date** `string`
>
> Purchase order date in YYYY-MM-DD format.
>
> **Status** `string`
>
> Purchase order status: DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED.
>
> **ContactID** `string`
>
> Xero Contact ID for the purchase order.
>
> **LineItems** `array`
>
> List of line items for the purchase order.
>
> **Reference** `string`
>
> Reference or purchase order number.
>
> **Telephone** `string`
>
> The phone number for the person accepting the delivery.
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **AttentionTo** `string`
>
> The person that the delivery is going to.
>
> **CurrencyCode** `string`
>
> The currency that purchase order has been raised in (ISO 4217 currency code).
>
> **CurrencyRate** `number`
>
> The currency rate for a multicurrency purchase order.
>
> **DeliveryDate** `string`
>
> Expected delivery date in YYYY-MM-DD format.
>
> **SentToContact** `boolean`
>
> Boolean to set whether the purchase order should be marked as sent.
>
> **BrandingThemeID** `string`
>
> Branding theme identifier.
>
> **DeliveryAddress** `string`
>
> The address the goods are to be delivered to.
>
> **LineAmountTypes** `string`
>
> Line amounts type: Exclusive, Inclusive, NoTax.
>
> **purchase\_order\_id** `string` *required*
>
> Unique identifier for the purchase order to update.
>
> **ExpectedArrivalDate** `string`
>
> Expected arrival date in YYYY-MM-DD format.
>
> **DeliveryInstructions** `string`
>
> A free text field for instructions (500 characters max).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Quote
>
> **Slug:** `XERO_UPDATE_QUOTE`
>
> Updates a specific quote in Xero by its QuoteID. Use this action when you need to modify an existing sales quote, such as changing its status, updating line items, contact details, dates, or other quote properties. Only the fields provided in the request will be updated - unprovided fields will remain unchanged.
>
> #### Input Parameters
>
> **Date** `string`
>
> Date on which the quote occurred in ISO 8601 format (YYYY-MM-DD).
>
> **Terms** `string`
>
> Payment terms text for the quote.
>
> **Title** `string`
>
> Title of the quote.
>
> **Status** `string`
>
> Status of the quote. Possible values: DRAFT, SENT, ACCEPTED, INVOICED, DECLINED, DELETED.
>
> **Contact** `object`
>
> Contact associated with a quote.
>
> **QuoteID** `string` *required*
>
> Unique identifier for the quote to update (UUID format).
>
> **Summary** `string`
>
> Summary description of the quote.
>
> **LineItems** `array`
>
> Array of line items in the quote. Required when creating a quote but optional for updates.
>
> **Reference** `string`
>
> Reference for the quote.
>
> **tenant\_id** `string`
>
> Xero Tenant ID. Optional - will auto-fetch from connections if not provided.
>
> **DateString** `string`
>
> Date on which the quote occurred in alternative string format.
>
> **ExpiryDate** `string`
>
> Expiry date of the quote in ISO 8601 format (YYYY-MM-DD).
>
> **QuoteNumber** `string`
>
> The quote number. Read-only - cannot be updated via API.
>
> **CurrencyCode** `string`
>
> Currency code for the quote (ISO 4217 format).
>
> **CurrencyRate** `number`
>
> Exchange rate if using foreign currency.
>
> **BrandingThemeID** `string`
>
> GUID of the branding theme applied to the quote.
>
> **Idempotency-Key** `string`
>
> This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
>
> **LineAmountTypes** `string`
>
> Specifies whether line amounts are tax inclusive or exclusive. Possible values: Exclusive, Inclusive, NoTax.
>
> **ExpiryDateString** `string`
>
> Expiry date of the quote in alternative string format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Attachment
>
> **Slug:** `XERO_UPLOAD_ATTACHMENT`
>
> Upload a file attachment to a Xero entity (invoice, contact, etc.). Supports PDF, images, and documents.
>
> #### Input Parameters
>
> **filename** `string` *required*
>
> Filename for the attachment as it will appear in Xero (e.g., 'invoice-receipt.pdf'). Must include the file extension.
>
> **entity\_id** `string` *required*
>
> UUID of the entity to attach the file to (e.g., InvoiceID, ContactID, BankTransactionID).
>
> **tenant\_id** `string`
>
> Xero tenant/organization ID. If not provided, uses the first connected tenant.
>
> **entity\_type** `string` *required*
>
> Entity type to attach to. Valid values: Invoices, Contacts, BankTransactions, CreditNotes, Accounts, ManualJournals, PurchaseOrders, Quotes, Receipts, RepeatingInvoices.
>
> **file\_to\_upload** `object` *required*
>
> File to upload as attachment.
>
> **include\_online** `boolean`
>
> Set to true to include the attachment when sending online invoices to customers. Only applicable when entity\_type is 'Invoices'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Credential
>
> **Slug:** `XERO_VALIDATE_CREDENTIAL`
>
> Check Xero credentials by querying connected organisations. Returns a success status and message; success requires a nonempty connections list, while an empty list or HTTP error returns failure.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
