Skip to main content
Xero logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 74
  • Triggers: 0
  • Slug: XERO
  • Version: 20261101_00

Frequently Asked Questions

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.

Tools

Slug: XERO_ALLOCATE_OVERPAYMENTAllocate part of an existing Xero overpayment to an invoice. The overpayment and invoice must belong to the same contact.

Input Parameters

string
required
Allocation date in YYYY-MM-DD format.
number
required
Positive amount of the overpayment to allocate to the invoice.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
required
Unique identifier of the invoice receiving the allocation.
string
required
Unique identifier of the overpayment to allocate.
string
Optional key used by Xero to make retries idempotent.
boolean
Whether Xero should summarize validation errors for the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_BULK_CREATE_BANK_TRANSACTIONSCreate multiple Xero bank transactions with item-level validation results.

Input Parameters

integer
Decimal precision to use for unit amounts, such as 4.
string
Xero tenant ID. If omitted, uses the first connected tenant.
string
Key used by Xero to make retries idempotent.
array
required
One or more bank transactions to create.
boolean
Whether Xero should summarize errors instead of returning per-item results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_BULK_CREATE_INVOICESCreate multiple Xero invoices or bills. With summarize_errors false (the default), return each success and validation outcome.

Input Parameters

integer
Number of decimal places used for line-item unit amounts.
array
required
Invoices and bills to create. Xero returns one outcome per entry when summarize_errors is false.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
Idempotency key used to safely retry this request. Sent as the Idempotency-Key header.
boolean
Whether tracked inventory may be sold when insufficient stock is available.
boolean
When false, return validation outcomes for every invoice instead of stopping at the first error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_BANK_TRANSACTIONCreate a bank transaction in Xero. Use SPEND for payments out or RECEIVE for money received.

Input Parameters

string
Transaction date in YYYY-MM-DD format.
string
required
Transaction type: SPEND (payment out) or RECEIVE (money in).
string
Transaction status: AUTHORISED or DELETED.
string
required
Xero Contact ID for the transaction.
array
required
List of line items for the bank transaction.
string
Reference or transaction description.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Currency code (e.g., USD, EUR).
string
Bank account UUID identifier. Either bank_account_code or bank_account_id must be provided.
string
Short alphanumeric account code (e.g., ‘090’, ‘091’), not the account name. Maximum 10 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_CONTACTCreate a new contact in Xero. Contacts can be customers, suppliers, or both.

Input Parameters

string
required
Full name of the contact or organization.
string
Website URL of the contact.
string
Last name of the contact person.
string
First name of the contact person.
string
Tax number (VAT/ABN/GST number).
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
boolean
Mark as customer when true.
boolean
Mark as supplier when true.
string
Email address of the contact.
string
Primary phone number (will be added as DEFAULT phone type).
string
Account reference number for the contact.
string
Mobile phone number (will be added as MOBILE phone type).
string
Default currency code (e.g., USD, EUR).
string
Bank account details for the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_CREDIT_NOTECreate a new credit note in Xero. Credit notes are used to reduce amounts owed by customers (ACCRECCREDIT) or to suppliers (ACCPAYCREDIT).

Input Parameters

string
Credit note date in YYYY-MM-DD format.
string ("ACCRECCREDIT" | "ACCPAYCREDIT")
required
Credit note type: ACCRECCREDIT (accounts receivable credit) or ACCPAYCREDIT (accounts payable credit).
string ("DRAFT" | "SUBMITTED" | "AUTHORISED")
Credit note status.
integer
Unit decimal places (e.g., 4). You can opt in to use four decimal places for unit amounts.
string
Due date in YYYY-MM-DD format.
string
Xero Contact ID (UUID). At least one of contact_id or contact_name must be provided.
array
List of line items for the credit note.
string
Reference or additional information.
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.
string
Contact name. At least one of contact_id or contact_name must be provided.
string
Currency code (e.g., USD, EUR).
boolean
Mark the credit note as sent to contact. Only applicable to AUTHORISED credit notes.
string
Branding theme identifier (UUID).
string ("Exclusive" | "Inclusive" | "NoTax")
Tax calculation method: Exclusive (amounts exclude tax), Inclusive (amounts include tax), or NoTax.
string
Credit note number. Omit this field to let Xero auto-generate a number from organisation settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_FILE_ASSOCIATIONAssociate a Xero file with an accounting object.

Input Parameters

string
required
Internal Xero Files UUID.
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.
string
Xero organisation ID. If omitted, uses the first connected tenant.
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.
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.
string
Unique key for safely retrying the same request, up to 128 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_INVOICECreate a new invoice in Xero. Supports both sales invoices (ACCREC) and bills (ACCPAY).

Input Parameters

string
Invoice date in YYYY-MM-DD format.
string ("ACCREC" | "ACCPAY")
required
Invoice type: ACCREC (accounts receivable/sales) or ACCPAY (accounts payable/bills).
string ("DRAFT" | "SUBMITTED" | "AUTHORISED")
Invoice status.
string
Due date in YYYY-MM-DD format.
string
Xero Contact ID (UUID). At least one of contact_id or contact_name must be provided.
array
required
List of line items for the invoice.
string
Reference or purchase order number.
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.
string
Contact name. At least one of contact_id or contact_name must be provided.
string
Currency code (e.g., USD, EUR).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_ITEMCreate an inventory item in Xero. Items can be tracked for sales and/or purchases.

Input Parameters

string
required
Unique item code (SKU).
string
required
Item name/description.
boolean
Item can be sold when true.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
boolean
Item can be purchased when true.
number
Unit price for sales.
string
Account code for sales.
number
Unit price for purchases.
string
Account code for purchases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_MANUAL_JOURNALCreate a manual journal in Xero with journal lines. Manual journals must balance (debits equal credits).

Input Parameters

string
URL link to a source document for reference, shown as ‘Go to [appName]’ in Xero
string
required
Date journal was posted in YYYY-MM-DD format
string ("DRAFT" | "POSTED")
Manual journal status. DRAFT for unposted journals, POSTED to finalize. Defaults to DRAFT if not specified
string
required
Description of journal being posted. This appears as the journal description in Xero
string
Xero tenant/organization ID. If not provided, uses the first connected tenant
array
required
Array of journal line items. Manual journals must balance (sum of debits must equal sum of credits) or an error is returned
string ("Exclusive" | "Inclusive" | "NoTax")
Line amount type indicating whether amounts are inclusive or exclusive of tax. Defaults to NoTax if not specified
string
Idempotency key to prevent duplicate journal creation. Recommended for production use. This is sent as a header, not in the body
boolean
If true, API will return summarized validation errors. If false, detailed errors are returned. Query parameter only
boolean
Boolean display indicator; defaults to true if not specified

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_OR_UPDATE_ACCOUNTCreate a Xero chart-of-account record, or update one by account ID.

Input Parameters

string
Unique customer-defined alphanumeric account code (maximum 10 characters). Required when creating a non-BANK account; optional for BANK creates and updates.
string
Account name (maximum 150 characters). Required when account_id is omitted to create an account; optional for updates.
string ("ACTIVE" | "ARCHIVED" | "DELETED")
Account status. ACTIVE accounts can be updated to ARCHIVED.
string
Tax type code returned by Xero tax rates, such as NONE, INPUT, or OUTPUT2.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
Existing account UUID. Omit to create an account; supply it to update that account.
string
Account description. Not valid for BANK accounts.
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.
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.
boolean
Whether the account is shown in the dashboard watchlist.
string ("BANK" | "CREDITCARD" | "PAYPAL" | "NONE" | "")
Bank account type. Valid only for BANK accounts.
string
Optional key used by Xero to make retries idempotent.
string
Bank account number. Valid only for BANK accounts.
boolean
Whether the account is available for expense claims.
boolean
Whether payments can be applied to the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_PAYMENTCreate a payment in Xero to link an invoice with a bank account transaction.

Input Parameters

string
Payment date in YYYY-MM-DD format.
number
required
Payment amount.
string
required
Xero Account ID (bank account) for the payment.
string
required
Xero Invoice ID that this payment is for.
string
Payment reference or description.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
number
Exchange rate for foreign currency payments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_PURCHASE_ORDERCreate a purchase order in Xero to order goods/services from suppliers.

Input Parameters

string
Purchase order date in YYYY-MM-DD format.
string
Purchase order status: DRAFT, SUBMITTED, AUTHORISED, BILLED.
string
required
Xero Contact ID for the purchase order.
array
required
List of line items for the purchase order.
string
Reference or purchase order number.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Expected delivery date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_QUOTECreate 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

string
Quote date in YYYY-MM-DD format. Defaults to current date if not specified.
string
Terms and conditions for the quote.
string
Title of the quote.
string ("DRAFT" | "SENT" | "ACCEPTED" | "DECLINED" | "INVOICED" | "DELETED")
Status values for a quote.
string
Summary description of the quote.
string
Xero Contact ID (UUID). At least one of contact_id or contact_name must be provided.
array
required
List of line items for the quote. At least one line item is required.
string
Additional reference or purchase order number.
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.
string
Quote expiry date in YYYY-MM-DD format.
string
Contact name. At least one of contact_id or contact_name must be provided.
string
Unique quote number (auto-generated if not provided). Max 255 characters.
string
Currency code (3-letter ISO 4217 code, e.g., USD, EUR, GBP).
number
The currency rate for a multicurrency quote. If not specified, uses XE.com day rate.
string
Branding theme identifier (UUID).
string ("Exclusive" | "Inclusive" | "NoTax")
Line amount types for quotes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_CREATE_TRACKING_OPTIONAdd an option to an existing Xero tracking category.

Input Parameters

string
required
Name of the tracking option. Maximum length is 100 characters.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Idempotency key used to safely retry this request. Sent as the Idempotency-Key header.
string
required
Xero identifier of the tracking category to add the option to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_DELETE_ITEMPermanently delete a Xero inventory item by its internal UUID.

Input Parameters

string
required
Internal Xero item UUID to permanently delete.
string
Xero organisation ID. If omitted, uses the first connected organisation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_DOWNLOAD_ATTACHMENTDownload an attachment from a supported Xero accounting entity.

Input Parameters

string
required
UUID of the entity that owns the attachment.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
required
Attachment UUID or exact filename returned by Xero.
string ("Accounts" | "BankTransactions" | "Contacts" | "CreditNotes" | "Invoices" | "ManualJournals" | "PurchaseOrders" | "Quotes" | "Receipts" | "RepeatingInvoices")
required
Xero entity collection that owns the attachment.
string
required
MIME type of the attachment being retrieved, such as image/jpg or application/pdf.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_ACCOUNTRetrieve 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

string
Xero tenant/organization ID (UUID format). If not provided, uses the first connected tenant.
string
required
Xero Account ID (UUID format, e.g., ‘562555f2-8cde-4ce9-8203-0363922537a4’). Get account IDs from XERO_LIST_ACCOUNTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_ASSETRetrieve a specific asset by ID from Xero. Returns depreciation details and book value.

Input Parameters

string
required
Xero Asset ID to retrieve.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_BALANCE_SHEET_REPORTRetrieve 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

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.
integer
Number of periods to compare.
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.
string
Timeframe period: MONTH, QUARTER, or YEAR.
boolean
Show only cash transactions when true (cash basis).
boolean
Use standard layout when true.
string
Filter by tracking option ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_BANK_SUMMARY_REPORTRetrieve Xero’s account-level Bank Summary for an optional date range.

Input Parameters

string
Report end date in YYYY-MM-DD format.
string
Report start date in YYYY-MM-DD format.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_BANK_TRANSACTIONRetrieve 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

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.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
required
Xero generated unique identifier for a bank transaction (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_BUDGETRetrieve a budget from Xero. Budgets track planned vs actual spending by account.

Input Parameters

string
End date for budget data in YYYY-MM-DD format.
string
Start date for budget data in YYYY-MM-DD format.
string
required
Xero Budget ID to retrieve.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_CONNECTIONSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_CONTACT_AGED_REPORTRetrieve aged payables or receivables rows for one Xero contact.

Input Parameters

string
Report date in YYYY-MM-DD format.
string
End date in YYYY-MM-DD format.
string
Start date in YYYY-MM-DD format.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
required
Xero contact UUID whose aged balances should be reported.
string ("PAYABLES" | "RECEIVABLES")
required
Contact aging report to retrieve: PAYABLES or RECEIVABLES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_CONTACT_HISTORYRetrieve activity history records for a Xero contact.

Input Parameters

string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
required
Unique Xero identifier of the contact whose history to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_CONTACTSTool to retrieve a list of contacts. Use when you need up-to-date contact information with filtering, paging, or incremental updates.

Input Parameters

array
Comma-separated list of ContactIDs to filter by.
integer
Page number for paginated results (requires pageSize). Iterate incrementing page until an empty result is returned to exhaust all records.
string
Sort by field, e.g. UpdatedDateUTC DESC.
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.
integer
Number of contacts per page (requires page).
string
Xero ContactID. If provided, fetches a single contact at /Contacts/{ContactID}.
string
Case-insensitive search across Name, FirstName, LastName, ContactNumber, CompanyNumber, EmailAddress.
boolean
Return a lightweight summary-only response when true.
boolean
Include archived contacts when true.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_CREDIT_NOTERetrieve 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

integer
Number of decimal places for unit amounts (default 4). You can opt in to use four decimal places for unit amounts.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_INVOICERetrieve a specific invoice by ID from Xero. Returns full invoice details including line items and status.

Input Parameters

integer
Number of decimal places for unit amounts (default 4).
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_ITEMRetrieve a specific item by ID from Xero. Returns item code, name, pricing, and tax details.

Input Parameters

string
required
Xero Item ID to retrieve.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_MANUAL_JOURNALRetrieve a specific manual journal by ID from Xero. Returns full details including journal lines.

Input Parameters

string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
required
Xero Manual Journal ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_ONLINE_INVOICERetrieve the hosted online-invoice URL for an authorised Xero invoice.

Input Parameters

string
Xero organisation ID. If omitted, uses the first connected organisation.
string
required
Internal Xero invoice UUID. The invoice must be authorised.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_ORGANISATIONRetrieve 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_PAYMENTRetrieve 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

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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_PROFIT_LOSS_REPORTRetrieve 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

string
End date for the report in YYYY-MM-DD format. Date range between fromDate and toDate must not exceed 365 days.
integer
Number of periods to compare (e.g., for month-on-month comparison).
string
Start date for the report in YYYY-MM-DD format. Date range between fromDate and toDate must not exceed 365 days.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Timeframe period: MONTH, QUARTER, or YEAR.
boolean
Show only cash transactions when true (cash basis).
boolean
Use standard layout when true.
string
Filter by tracking option ID.
string
Filter by second tracking option ID.
string
Filter by tracking category ID.
string
Filter by second tracking category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_PROJECTRetrieve a specific project by ID from Xero. Returns project details, deadlines, and status.

Input Parameters

string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_PURCHASE_ORDERRetrieve a specific purchase order by ID from Xero. Returns full details including line items and status.

Input Parameters

string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
required
Xero Purchase Order ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_QUOTESTool 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

integer
Page number for paginated results (1-based).
string
Order by any element, e.g., ExpiryDate ASC.
string
Filter for quotes on or before this date (YYYY-MM-DD).
string
Filter for quotes of a particular status.
string
Filter for quotes on or after this date (YYYY-MM-DD).
string
Filter for quotes belonging to a particular contact by ContactID.
string
Xero Tenant ID. Optional - will auto-fetch from connections if not provided.
string
Filter by quote number.
string
Filter for quotes expiring on or before this date (YYYY-MM-DD).
string
Filter for quotes expiring on or after this date (YYYY-MM-DD).
string
Only return quotes modified after this UTC timestamp in RFC3339 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_RECORD_HISTORYRetrieve history for a Xero bank transaction, invoice, manual journal, or payment.

Input Parameters

string
Xero organisation ID. If omitted, uses the first connected tenant.
string
required
Internal Xero UUID of the selected record.
string ("bank_transaction" | "invoice" | "manual_journal" | "payment")
required
Type of Xero record whose history to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_REPEATING_INVOICERetrieve a Xero repeating invoice template by its unique ID.

Input Parameters

string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
required
Xero-generated UUID of the repeating invoice template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_GET_TRIAL_BALANCE_REPORTRetrieve 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

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.
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.
boolean
Return cash only basis for the Trial Balance report when true (cash basis accounting).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_ACCOUNTSRetrieve Xero’s chart of accounts, with optional filtering and ordering. AccountID uniquely identifies an account.

Input Parameters

string
Sort by field, e.g. Code ASC or Name DESC.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_ADVANCE_PAYMENTSList filtered Xero overpayments or prepayments.

Input Parameters

integer
Page number to retrieve, starting at 1.
string
Xero sort expression, for example Date DESC or Reference ASC.
string
Xero filter expression, for example Status==“AUTHORISED”.
integer
Decimal places to return for unit amounts.
integer
Number of records to retrieve per page.
string
Xero organisation ID. If omitted, uses the first connected organisation.
array
References to include. Xero receives these as one comma-separated filter.
string ("overpayment" | "prepayment")
required
Advance-payment collection to list: overpayment or prepayment.
array
Invoice numbers to include. Supported only when payment_type is prepayment.
string
ISO 8601 timestamp; return records created or modified since this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_ASSETSRetrieve fixed assets from Xero by status, defaulting to DRAFT. Assets track depreciation and book value of capital equipment.

Input Parameters

integer
Page number for paginated results. Defaults to 1.
string
Required. Asset status filter. Valid values: DRAFT, REGISTERED, DISPOSED. Defaults to DRAFT.
string
Sort field. Valid values: AssetType, AssetName, AssetNumber, PurchaseDate, PurchasePrice. For DISPOSED status, also allows: DisposalDate, DisposalPrice.
string
Filter string to search assets. Matches against AssetName, AssetNumber, Description, and AssetTypeName fields.
integer
Number of assets per page. Defaults to 10.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Sort direction. Valid values: asc, desc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_ATTACHMENTSList all attachments for a specific entity in Xero (invoice, contact, etc.).

Input Parameters

string
required
ID of the entity to list attachments for.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
required
Entity type: Invoices, Contacts, BankTransactions, CreditNotes, PurchaseOrders, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_BANK_TRANSACTIONSRetrieve 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

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.
string
Sort by field, e.g. Date DESC or UpdatedDateUTC ASC. Default ordering is unreliable; always specify explicitly (e.g., Date DESC).
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.
integer
Decimal places for unit amounts (default 4).
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.
string
UTC timestamp to return only bank transactions modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_BATCH_PAYMENTSList Xero batch payments with documented filtering and ordering controls.

Input Parameters

string
Xero ordering expression, for example Date ASC.
string
Xero filter expression, for example Status==“AUTHORISED”.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
UTC timestamp to return only batch payments modified since this time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_CREDIT_NOTESRetrieve list of credit notes from Xero. Credit notes are issued to reduce amounts owed by customers.

Input Parameters

integer
Page number for paginated results.
string
Sort by field, e.g. Date DESC or CreditNoteNumber ASC.
string
OData-style filter, e.g. Status==“AUTHORISED”
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
UTC timestamp to return only credit notes modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_CURRENCIESList currencies enabled for the connected Xero organisation.

Input Parameters

string
Sort by a currency field, for example Code ASC.
string
OData-style filter, for example Code==“USD”.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_FILE_ASSOCIATIONSList Xero business objects associated with a specific file.

Input Parameters

string
required
Internal Xero Files UUID.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_FILESRetrieve files from Xero Files. Lists documents stored in Xero’s file management system.

Input Parameters

integer
Page number for paginated results.
string
Sort field: Name, Size, CreatedDateUTC.
string
Filter files by folder ID.
integer
Number of files per page (max 100).
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_FOLDERSRetrieve folders from Xero Files. Lists document folders in Xero’s file management system.

Input Parameters

string
Sort field: Name, CreatedDateUTC.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_INVOICESRetrieve 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

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.
string
Sort by field, e.g. Date DESC or InvoiceNumber ASC.
string
OData-style filter, e.g. Status==“AUTHORISED” AND Total>100 Malformed expressions silently return empty results rather than an error.
string
Comma-separated list of invoice statuses to filter by (e.g., DRAFT, SUBMITTED, AUTHORISED, PAID).
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.
string
Comma-separated list of Contact IDs to filter invoices by contact.
string
Comma-separated list of Invoice IDs to filter by.
boolean
Filter to invoices created by your app when true.
boolean
Include archived invoices when true.
string
UTC timestamp to return only invoices modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_ITEMSRetrieve items (inventory/products) from Xero. Items can be tracked for sales and/or purchases.

Input Parameters

string
Sort by field, e.g. Code ASC or Name DESC.
string
OData-style filter, e.g. IsSold==true AND IsPurchased==true
integer
Number of decimal places for unit amounts (default 4).
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_JOURNALSRetrieve 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

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.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
boolean
Filter to payment journals only when true.
string
UTC timestamp to return only journals modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_MANUAL_JOURNALSRetrieve manual journals from Xero. Manual journals are used for period-end adjustments and corrections.

Input Parameters

integer
Page number for paginated results.
string
Sort by field, e.g. Date DESC.
string
OData-style filter, e.g. Status==“POSTED”
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
UTC timestamp to return only manual journals modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_PAYMENTSRetrieve 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

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).
string
Sort by field, e.g. Date DESC or Amount ASC.
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.
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.
string
UTC timestamp to return only payments modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_PROJECTSRetrieve projects from Xero. Projects track time and costs for client work.

Input Parameters

integer
Page number for paginated results.
string
Comma-separated project states: INPROGRESS, CLOSED.
integer
Number of projects per page (1-500, default 50).
string
Filter projects by contact ID.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Comma-separated list of project IDs to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_PROJECT_TIME_ENTRIESList and filter time entries logged against a specific Xero project.

Input Parameters

integer
Page number for the paged response. Must be at least 1.
array
Statuses to include, such as ACTIVE, LOCKED, or INVOICED.
string
Filter by the project task UUID.
string
Filter by the UUID of the Xero user who logged the time.
integer
Number of time entries per page, from 1 to 500.
string
Xero organisation ID. If omitted, uses the first connected organisation.
string
Filter by the contact UUID.
string
Filter by the invoice UUID.
string
required
Internal Xero project UUID.
boolean
Filter to entries for tasks with TIME or FIXED charge types.
string
Include entries on or after this ISO 8601 UTC timestamp.
string
Include entries on or before this ISO 8601 UTC timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_PURCHASE_ORDERSRetrieve list of purchase orders from Xero. Purchase orders track goods/services ordered from suppliers.

Input Parameters

integer
Page number for paginated results.
string
Sort by field, e.g. Date DESC or PurchaseOrderNumber ASC.
string
Filter by date to (YYYY-MM-DD).
string
Filter by status: DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED.
string
Filter by date from (YYYY-MM-DD).
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
UTC timestamp to return only purchase orders modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_QUOTESRetrieve 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

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.
string
Order by any element. Specify field name and optionally ASC or DESC.
string
Filter for quotes on or before this date (YYYY-MM-DD).
string
Filter for quotes of a particular status.
string
Filter for quotes on or after this date (YYYY-MM-DD).
string
Filter for quotes belonging to a particular contact by ContactID.
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.
string
Filter by quote number.
string
Filter for quotes expiring on or before this date (YYYY-MM-DD).
string
Filter for quotes expiring on or after this date (YYYY-MM-DD).
string
Only return quotes modified after this timestamp. Use ISO 8601 format (e.g., 2020-02-06T12:17:43.202-08:00).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_TAX_RATESRetrieve 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

string
Sort by field, e.g. Name ASC.
string
OData-style filter, e.g. Status==“ACTIVE”
string
Filter by specific tax type.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_TRACKING_CATEGORIESRetrieve tracking categories from Xero. Tracking categories are used to segment data for reporting (e.g., departments, regions).

Input Parameters

string
Sort by field, e.g. Name ASC.
string
OData-style filter, e.g. Status==“ACTIVE”
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
boolean
Include archived tracking categories when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_LIST_USERSList users of the connected Xero organisation.

Input Parameters

string
Sort by a user field, e.g. LastName ASC.
string
OData-style filter, e.g. OrganisationRole==“STANDARD”.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
UTC timestamp to return only users modified since this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_POST_INVOICE_UPDATETool to update an existing invoice. Use when you need to modify the details of an invoice after it’s been created.

Input Parameters

integer
Number of decimal places for unit amounts.
array
required
List containing invoice update definitions (one item).
string
Unique identifier (UUID) of the invoice.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Invoice number identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPDATE_BANK_TRANSACTIONUpdate 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

string
Transaction date in YYYY-MM-DD format.
string ("SPEND" | "RECEIVE")
Transaction type: SPEND (payment out) or RECEIVE (money in).
string ("AUTHORISED" | "DELETED")
Transaction status: AUTHORISED or DELETED.
integer
Number of decimal places for unit amounts.
string
Xero Contact ID for the transaction.
array
List of line items for the bank transaction.
string
Reference or transaction description.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Currency code (e.g., USD, EUR).
string
Bank account UUID identifier.
string
Short alphanumeric account code (e.g., ‘090’, ‘091’), not the account name. Maximum 10 characters.
string
required
Xero identifier for the bank transaction to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPDATE_CONTACTUpdate an existing contact in Xero. Only provided fields will be updated.

Input Parameters

string
Full name of the contact or organization.
string
Last name of the contact person.
string
required
Xero Contact ID to update.
string
First name of the contact person.
string
Tax number (VAT/ABN/GST number).
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
Email address of the contact.
string
Primary phone number (will update DEFAULT phone type).
string
Account reference number for the contact.
string
Mobile phone number (will update MOBILE phone type).
string
Default currency code (e.g., USD, EUR).
string
Bank account details for the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPDATE_CREDIT_NOTEUpdates 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

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.
integer
Unit decimal places. You can opt in to use four decimal places for unit amounts (e.g., unitdp=4).
array
List of line items for the credit note. Provide this to update the line items on the credit note.
string
Additional reference number for ACCRECCREDIT credit notes.
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.
string
required
Unique identifier for the Credit Note to update.
string
Currency code for the credit note (e.g., USD, EUR). 3-letter ISO 4217 code.
number
Exchange rate for multi-currency credit notes. Maximum 18 digits with 6 decimal places.
boolean
Boolean to set whether the credit note should be marked as ‘sent’ to the contact. Only applicable to AUTHORISED credit notes.
string
Identifier for the branding theme to apply to the credit note.
string
Allows you to safely retry requests without the risk of duplicate processing. Maximum 128 characters.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPDATE_ITEMUpdate an existing Xero inventory item by its ItemID.

Input Parameters

string
required
Unique item code. Xero requires it when updating an item.
string
Name of the item.
boolean
Whether the item is available on sales transactions.
integer
Number of decimal places Xero uses for unit amounts in the response.
string
required
Xero identifier of the item to update.
string
Xero tenant/organization ID. If omitted, uses the first connected tenant.
string
Description used when selling the item.
boolean
Whether the item is available on purchase transactions.
object
Sales settings for a Xero item.
object
Purchase settings for a Xero item.
string
Idempotency key used to safely retry this update.
string
Description used when purchasing the item.
string
Inventory asset account code. Pair with PurchaseDetails.COGSAccountCode to configure tracked inventory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPDATE_MANUAL_JOURNALUpdate 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

string
URL link to a source document for reference, shown as ‘Go to [appName]’ in Xero
string
Date journal was posted in YYYY-MM-DD format
string ("DRAFT" | "POSTED")
Manual journal status. DRAFT for unposted journals, POSTED to finalize
string
required
Description of journal being posted. This appears as the journal description in Xero
string
Xero tenant/organization ID. If not provided, uses the first connected tenant
array
Array of journal line items. Manual journals must balance (sum of debits must equal sum of credits) or an error is returned
string ("Exclusive" | "Inclusive" | "NoTax")
Line amount type indicating whether amounts are inclusive or exclusive of tax
string
Idempotency key to prevent duplicate updates. Recommended for production use. This is sent as a header, not in the body
boolean
If true, API will return summarized validation errors. If false, detailed errors are returned. Query parameter only
string
required
Unique identifier for the ManualJournal to update
boolean
Boolean display indicator; defaults to true if not specified

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPDATE_PURCHASE_ORDERUpdates 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

string
Purchase order date in YYYY-MM-DD format.
string
Purchase order status: DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED.
string
Xero Contact ID for the purchase order.
array
List of line items for the purchase order.
string
Reference or purchase order number.
string
The phone number for the person accepting the delivery.
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
The person that the delivery is going to.
string
The currency that purchase order has been raised in (ISO 4217 currency code).
number
The currency rate for a multicurrency purchase order.
string
Expected delivery date in YYYY-MM-DD format.
boolean
Boolean to set whether the purchase order should be marked as sent.
string
Branding theme identifier.
string
The address the goods are to be delivered to.
string
Line amounts type: Exclusive, Inclusive, NoTax.
string
required
Unique identifier for the purchase order to update.
string
Expected arrival date in YYYY-MM-DD format.
string
A free text field for instructions (500 characters max).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPDATE_QUOTEUpdates 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

string
Date on which the quote occurred in ISO 8601 format (YYYY-MM-DD).
string
Payment terms text for the quote.
string
Title of the quote.
string
Status of the quote. Possible values: DRAFT, SENT, ACCEPTED, INVOICED, DECLINED, DELETED.
object
Contact associated with a quote.
string
required
Unique identifier for the quote to update (UUID format).
string
Summary description of the quote.
array
Array of line items in the quote. Required when creating a quote but optional for updates.
string
Reference for the quote.
string
Xero Tenant ID. Optional - will auto-fetch from connections if not provided.
string
Date on which the quote occurred in alternative string format.
string
Expiry date of the quote in ISO 8601 format (YYYY-MM-DD).
string
The quote number. Read-only - cannot be updated via API.
string
Currency code for the quote (ISO 4217 format).
number
Exchange rate if using foreign currency.
string
GUID of the branding theme applied to the quote.
string
This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
string
Specifies whether line amounts are tax inclusive or exclusive. Possible values: Exclusive, Inclusive, NoTax.
string
Expiry date of the quote in alternative string format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_UPLOAD_ATTACHMENTUpload a file attachment to a Xero entity (invoice, contact, etc.). Supports PDF, images, and documents.

Input Parameters

string
required
Filename for the attachment as it will appear in Xero (e.g., ‘invoice-receipt.pdf’). Must include the file extension.
string
required
UUID of the entity to attach the file to (e.g., InvoiceID, ContactID, BankTransactionID).
string
Xero tenant/organization ID. If not provided, uses the first connected tenant.
string
required
Entity type to attach to. Valid values: Invoices, Contacts, BankTransactions, CreditNotes, Accounts, ManualJournals, PurchaseOrders, Quotes, Receipts, RepeatingInvoices.
object
required
File to upload as attachment.
boolean
Set to true to include the attachment when sending online invoices to customers. Only applicable when entity_type is ‘Invoices’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: XERO_VALIDATE_CREDENTIALCheck 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not