Xero Accounting MCP Server for Cloudflare Workers
99 tools available in the Xero MCP server. Each tool can be called by AI assistants to perform specific actions.
xero_test_connectionTest the connection to the Xero API and return the connected organisation name.
{
"type": "object",
"properties": {}
}xero_delete_invoiceDelete a draft invoice.
Args:
{
"type": "object",
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Invoice ID to delete"
}
}
}xero_list_itemsList items/products from Xero.
Args:
{
"type": "object",
"properties": {
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_itemGet details for a specific item.
Args:
{
"type": "object",
"required": [
"itemId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"itemId": {
"type": "string",
"description": "Item ID"
}
}
}xero_list_overpaymentsList overpayments from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_list_accountsList accounts from the Chart of Accounts.
Args:
{
"type": "object",
"properties": {
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"classType": {
"enum": [
"ASSET",
"EQUITY",
"EXPENSE",
"LIABILITY",
"REVENUE"
],
"type": "string",
"description": "Account class"
}
}
}xero_get_accountGet details for a specific account.
Args:
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"accountId": {
"type": "string",
"description": "Account ID"
}
}
}xero_create_accountCreate a new account in the Chart of Accounts.
Args:
{
"type": "object",
"required": [
"code",
"name"
],
"properties": {
"code": {
"type": "string",
"description": "Account code"
},
"name": {
"type": "string",
"description": "Account name"
},
"taxType": {
"type": "string",
"description": "Tax type"
},
"description": {
"type": "string",
"description": "Description"
},
"showInExpenseClaims": {
"type": "boolean",
"description": "Show in expense claims"
},
"enablePaymentsToAccount": {
"type": "boolean",
"description": "Enable payments to account"
}
}
}xero_update_accountUpdate an existing account.
Args:
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"code": {
"type": "string",
"description": "Account code"
},
"name": {
"type": "string",
"description": "Account name"
},
"status": {
"enum": [
"ACTIVE",
"ARCHIVED"
],
"type": "string",
"description": "Account status"
},
"accountId": {
"type": "string",
"description": "Account ID to update"
},
"description": {
"type": "string",
"description": "Description"
}
}
}xero_delete_accountDelete an account from the Chart of Accounts. Only accounts without transactions can be deleted.
Args:
{
"type": "object",
"required": [
"accountId"
],
"properties": {
"accountId": {
"type": "string",
"description": "Account ID to delete"
}
}
}xero_list_bank_transactionsList bank transactions (spend/receive money) from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_bank_transactionGet details for a specific bank transaction.
Args:
{
"type": "object",
"required": [
"bankTransactionId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"bankTransactionId": {
"type": "string",
"description": "Bank transaction ID"
}
}
}xero_create_bank_transactionCreate a bank transaction (spend or receive money).
Args:
{
"type": "object",
"required": [
"type",
"contactId",
"bankAccountId",
"lineItems"
],
"properties": {
"date": {
"type": "string",
"description": "Transaction date"
},
"type": {
"enum": [
"RECEIVE",
"SPEND",
"RECEIVE-OVERPAYMENT",
"SPEND-OVERPAYMENT",
"RECEIVE-PREPAYMENT",
"SPEND-PREPAYMENT"
],
"type": "string",
"description": "Transaction type"
},
"contactId": {
"type": "string",
"description": "Contact ID"
},
"lineItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line items"
},
"reference": {
"type": "string",
"description": "Reference"
},
"currencyCode": {
"type": "string",
"description": "Currency code"
},
"bankAccountId": {
"type": "string",
"description": "Bank account ID"
}
}
}xero_update_bank_transactionUpdate a bank transaction.
Args:
{
"type": "object",
"required": [
"bankTransactionId"
],
"properties": {
"date": {
"type": "string",
"description": "Transaction date"
},
"reference": {
"type": "string",
"description": "Reference"
},
"bankTransactionId": {
"type": "string",
"description": "Bank transaction ID"
}
}
}xero_list_bank_transfersList bank transfers from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_bank_transferGet details for a specific bank transfer.
Args:
{
"type": "object",
"required": [
"bankTransferId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"bankTransferId": {
"type": "string",
"description": "Bank transfer ID"
}
}
}xero_create_bank_transferCreate a bank transfer between two bank accounts.
Args:
{
"type": "object",
"required": [
"fromBankAccountId",
"toBankAccountId",
"amount"
],
"properties": {
"date": {
"type": "string",
"description": "Transfer date"
},
"amount": {
"type": "number",
"description": "Amount"
},
"toBankAccountId": {
"type": "string",
"description": "To bank account ID"
},
"fromBankAccountId": {
"type": "string",
"description": "From bank account ID"
}
}
}xero_list_contactsList contacts (customers and suppliers) from Xero.
Returns a paginated list of contacts with basic details.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"includeArchived": {
"type": "boolean",
"default": false,
"description": "Include archived contacts"
}
}
}xero_get_contactGet details for a specific contact.
Args:
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"contactId": {
"type": "string",
"description": "Contact ID"
}
}
}xero_allocate_prepaymentAllocate a prepayment to an invoice.
Args:
{
"type": "object",
"required": [
"prepaymentId",
"invoiceId",
"amount"
],
"properties": {
"date": {
"type": "string",
"description": "Allocation date"
},
"amount": {
"type": "number",
"description": "Amount"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID"
},
"prepaymentId": {
"type": "string",
"description": "Prepayment ID"
}
}
}xero_create_contactCreate a new contact in Xero.
Args:
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Contact name (required)"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"firstName": {
"type": "string",
"description": "First name"
},
"taxNumber": {
"type": "string",
"description": "Tax/VAT number"
},
"isCustomer": {
"type": "boolean",
"description": "Is customer"
},
"isSupplier": {
"type": "boolean",
"description": "Is supplier"
},
"emailAddress": {
"type": "string",
"description": "Email address"
},
"defaultCurrency": {
"type": "string",
"description": "Default currency code"
}
}
}xero_update_contactUpdate an existing contact.
Args:
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"name": {
"type": "string",
"description": "Contact name"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"contactId": {
"type": "string",
"description": "Contact ID to update"
},
"firstName": {
"type": "string",
"description": "First name"
},
"isCustomer": {
"type": "boolean",
"description": "Is customer"
},
"isSupplier": {
"type": "boolean",
"description": "Is supplier"
},
"emailAddress": {
"type": "string",
"description": "Email address"
},
"contactStatus": {
"enum": [
"ACTIVE",
"ARCHIVED"
],
"type": "string",
"description": "Contact status"
}
}
}xero_archive_contactArchive a contact.
Args:
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"contactId": {
"type": "string",
"description": "Contact ID to archive"
}
}
}xero_list_contact_groupsList all contact groups.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_create_contact_groupCreate a new contact group.
Args:
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Group name"
}
}
}xero_add_contacts_to_groupAdd contacts to a contact group.
Args:
{
"type": "object",
"required": [
"contactGroupId",
"contactIds"
],
"properties": {
"contactIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of contact IDs"
},
"contactGroupId": {
"type": "string",
"description": "Contact group ID"
}
}
}xero_list_invoicesList invoices from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"statuses": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by statuses"
}
}
}xero_get_invoiceGet details for a specific invoice.
Args:
{
"type": "object",
"required": [
"invoiceId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID"
}
}
}xero_create_invoiceCreate a new invoice in Xero.
Args:
{
"type": "object",
"required": [
"type",
"contactId",
"lineItems"
],
"properties": {
"date": {
"type": "string",
"description": "Invoice date"
},
"type": {
"enum": [
"ACCREC",
"ACCPAY"
],
"type": "string",
"description": "Invoice type"
},
"status": {
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED"
],
"type": "string",
"description": "Status"
},
"dueDate": {
"type": "string",
"description": "Due date"
},
"contactId": {
"type": "string",
"description": "Contact ID"
},
"lineItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line items"
},
"reference": {
"type": "string",
"description": "Reference"
},
"currencyCode": {
"type": "string",
"description": "Currency code"
},
"brandingThemeId": {
"type": "string",
"description": "Branding theme ID"
},
"lineAmountTypes": {
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
],
"type": "string",
"description": "Line amount types"
}
}
}xero_update_invoiceUpdate an existing invoice.
Args:
{
"type": "object",
"required": [
"invoiceId"
],
"properties": {
"date": {
"type": "string",
"description": "Invoice date"
},
"status": {
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED"
],
"type": "string",
"description": "Status"
},
"dueDate": {
"type": "string",
"description": "Due date"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID to update"
},
"reference": {
"type": "string",
"description": "Reference"
}
}
}xero_void_invoiceVoid an invoice.
Args:
{
"type": "object",
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Invoice ID to void"
}
}
}xero_create_itemCreate a new item/product.
Args:
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "Item code"
},
"name": {
"type": "string",
"description": "Item name"
},
"isSold": {
"type": "boolean",
"description": "Is sold"
},
"description": {
"type": "string",
"description": "Sales description"
},
"isPurchased": {
"type": "boolean",
"description": "Is purchased"
},
"salesTaxType": {
"type": "string",
"description": "Sales tax type"
},
"salesUnitPrice": {
"type": "number",
"description": "Sales unit price"
},
"purchaseTaxType": {
"type": "string",
"description": "Purchase tax type"
},
"salesAccountCode": {
"type": "string",
"description": "Sales account code"
},
"purchaseUnitPrice": {
"type": "number",
"description": "Purchase unit price"
},
"purchaseAccountCode": {
"type": "string",
"description": "Purchase account code"
},
"purchaseDescription": {
"type": "string",
"description": "Purchase description"
},
"isTrackedAsInventory": {
"type": "boolean",
"description": "Track as inventory"
},
"inventoryAssetAccountCode": {
"type": "string",
"description": "Inventory asset account code"
}
}
}xero_update_itemUpdate an existing item.
Args:
{
"type": "object",
"required": [
"itemId"
],
"properties": {
"code": {
"type": "string",
"description": "Item code"
},
"name": {
"type": "string",
"description": "Item name"
},
"itemId": {
"type": "string",
"description": "Item ID"
},
"description": {
"type": "string",
"description": "Sales description"
},
"purchaseDescription": {
"type": "string",
"description": "Purchase description"
}
}
}xero_delete_itemDelete an item.
Args:
{
"type": "object",
"required": [
"itemId"
],
"properties": {
"itemId": {
"type": "string",
"description": "Item ID to delete"
}
}
}xero_list_journalsList system journals from Xero. These are automatically created journals for all transactions.
Args:
{
"type": "object",
"properties": {
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"offset": {
"type": "integer",
"description": "Offset (journal number)"
}
}
}xero_get_journalGet details for a specific journal.
Args:
{
"type": "object",
"required": [
"journalId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"journalId": {
"type": "string",
"description": "Journal ID"
}
}
}xero_list_manual_journalsList manual journals from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_manual_journalGet details for a specific manual journal.
Args:
{
"type": "object",
"required": [
"manualJournalId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"manualJournalId": {
"type": "string",
"description": "Manual journal ID"
}
}
}xero_create_manual_journalCreate a manual journal entry. Journal lines must balance to zero.
Args:
{
"type": "object",
"required": [
"narration",
"journalLines"
],
"properties": {
"date": {
"type": "string",
"description": "Journal date"
},
"status": {
"enum": [
"DRAFT",
"POSTED"
],
"type": "string",
"description": "Status"
},
"narration": {
"type": "string",
"description": "Journal description"
},
"journalLines": {
"type": "array",
"items": {
"type": "string"
},
"description": "Journal lines (must balance to zero)"
},
"showOnCashBasisReports": {
"type": "boolean",
"description": "Show on cash basis reports"
}
}
}xero_update_manual_journalUpdate an existing manual journal.
Args:
{
"type": "object",
"required": [
"manualJournalId"
],
"properties": {
"date": {
"type": "string",
"description": "Journal date"
},
"status": {
"enum": [
"DRAFT",
"POSTED"
],
"type": "string",
"description": "Status"
},
"narration": {
"type": "string",
"description": "Journal description"
},
"manualJournalId": {
"type": "string",
"description": "Manual journal ID"
}
}
}xero_list_linked_transactionsList linked transactions from Xero. Linked transactions link billable expenses to sales invoices.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"contactId": {
"type": "string",
"description": "Contact ID"
},
"sourceTransactionId": {
"type": "string",
"description": "Source transaction ID"
}
}
}xero_get_linked_transactionGet details for a specific linked transaction.
Args:
{
"type": "object",
"required": [
"linkedTransactionId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"linkedTransactionId": {
"type": "string",
"description": "Linked transaction ID"
}
}
}xero_create_linked_transactionCreate a linked transaction to link a billable expense to a sales invoice.
Args:
{
"type": "object",
"required": [
"sourceTransactionId",
"sourceLineItemId",
"contactId"
],
"properties": {
"contactId": {
"type": "string",
"description": "Contact ID"
},
"sourceLineItemId": {
"type": "string",
"description": "Source line item ID"
},
"targetLineItemId": {
"type": "string",
"description": "Target line item ID"
},
"sourceTransactionId": {
"type": "string",
"description": "Source transaction ID"
},
"targetTransactionId": {
"type": "string",
"description": "Target transaction ID"
}
}
}xero_update_linked_transactionUpdate a linked transaction.
Args:
{
"type": "object",
"required": [
"linkedTransactionId"
],
"properties": {
"contactId": {
"type": "string",
"description": "Contact ID"
},
"sourceLineItemId": {
"type": "string",
"description": "Source line item ID"
},
"targetLineItemId": {
"type": "string",
"description": "Target line item ID"
},
"linkedTransactionId": {
"type": "string",
"description": "Linked transaction ID"
},
"targetTransactionId": {
"type": "string",
"description": "Target transaction ID"
}
}
}xero_delete_linked_transactionDelete a linked transaction.
Args:
{
"type": "object",
"required": [
"linkedTransactionId"
],
"properties": {
"linkedTransactionId": {
"type": "string",
"description": "Linked transaction ID to delete"
}
}
}xero_get_organisationGet details about the connected Xero organisation.
Returns organisation information including name, country, currency, and settings.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_list_paymentsList payments from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_paymentGet details for a specific payment.
Args:
{
"type": "object",
"required": [
"paymentId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"paymentId": {
"type": "string",
"description": "Payment ID"
}
}
}xero_create_paymentCreate a payment for an invoice.
Args:
{
"type": "object",
"required": [
"invoiceId",
"accountId",
"amount",
"date"
],
"properties": {
"date": {
"type": "string",
"description": "Payment date"
},
"amount": {
"type": "number",
"description": "Amount"
},
"accountId": {
"type": "string",
"description": "Bank account ID"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID"
},
"reference": {
"type": "string",
"description": "Reference"
},
"isReconciled": {
"type": "boolean",
"description": "Is reconciled"
}
}
}xero_delete_paymentDelete a payment.
Args:
{
"type": "object",
"required": [
"paymentId"
],
"properties": {
"paymentId": {
"type": "string",
"description": "Payment ID to delete"
}
}
}xero_list_credit_notesList credit notes from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_credit_noteGet details for a specific credit note.
Args:
{
"type": "object",
"required": [
"creditNoteId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"creditNoteId": {
"type": "string",
"description": "Credit note ID"
}
}
}xero_create_credit_noteCreate a credit note.
Args:
{
"type": "object",
"required": [
"type",
"contactId",
"lineItems"
],
"properties": {
"date": {
"type": "string",
"description": "Date"
},
"type": {
"enum": [
"ACCRECCREDIT",
"ACCPAYCREDIT"
],
"type": "string",
"description": "Credit note type"
},
"contactId": {
"type": "string",
"description": "Contact ID"
},
"lineItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line items"
},
"reference": {
"type": "string",
"description": "Reference"
}
}
}xero_allocate_credit_noteAllocate a credit note to an invoice.
Args:
{
"type": "object",
"required": [
"creditNoteId",
"invoiceId",
"amount"
],
"properties": {
"date": {
"type": "string",
"description": "Allocation date"
},
"amount": {
"type": "number",
"description": "Amount"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID"
},
"creditNoteId": {
"type": "string",
"description": "Credit note ID"
}
}
}xero_list_prepaymentsList prepayments from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_allocate_overpaymentAllocate an overpayment to an invoice.
Args:
{
"type": "object",
"required": [
"overpaymentId",
"invoiceId",
"amount"
],
"properties": {
"date": {
"type": "string",
"description": "Allocation date"
},
"amount": {
"type": "number",
"description": "Amount"
},
"invoiceId": {
"type": "string",
"description": "Invoice ID"
},
"overpaymentId": {
"type": "string",
"description": "Overpayment ID"
}
}
}xero_list_batch_paymentsList batch payments from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_list_purchase_ordersList purchase orders from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"status": {
"type": "string",
"description": "Status filter"
}
}
}xero_get_purchase_orderGet details for a specific purchase order.
Args:
{
"type": "object",
"required": [
"purchaseOrderId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"purchaseOrderId": {
"type": "string",
"description": "Purchase order ID"
}
}
}xero_create_purchase_orderCreate a new purchase order.
Args:
{
"type": "object",
"required": [
"contactId",
"lineItems"
],
"properties": {
"date": {
"type": "string",
"description": "Order date"
},
"status": {
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED"
],
"type": "string",
"description": "Status"
},
"contactId": {
"type": "string",
"description": "Supplier contact ID"
},
"lineItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line items"
},
"reference": {
"type": "string",
"description": "Reference"
},
"telephone": {
"type": "string",
"description": "Telephone"
},
"attentionTo": {
"type": "string",
"description": "Attention to"
},
"currencyCode": {
"type": "string",
"description": "Currency code"
},
"deliveryDate": {
"type": "string",
"description": "Delivery date"
},
"deliveryAddress": {
"type": "string",
"description": "Delivery address"
},
"deliveryInstructions": {
"type": "string",
"description": "Delivery instructions"
}
}
}xero_update_purchase_orderUpdate an existing purchase order.
Args:
{
"type": "object",
"required": [
"purchaseOrderId"
],
"properties": {
"date": {
"type": "string",
"description": "Order date"
},
"status": {
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED"
],
"type": "string",
"description": "Status"
},
"reference": {
"type": "string",
"description": "Reference"
},
"deliveryDate": {
"type": "string",
"description": "Delivery date"
},
"purchaseOrderId": {
"type": "string",
"description": "Purchase order ID"
}
}
}xero_delete_purchase_orderDelete a purchase order.
Args:
{
"type": "object",
"required": [
"purchaseOrderId"
],
"properties": {
"purchaseOrderId": {
"type": "string",
"description": "Purchase order ID to delete"
}
}
}xero_list_quotesList quotes from Xero.
Args:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"order": {
"type": "string",
"description": "Sort order"
},
"where": {
"type": "string",
"description": "Filter expression"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"status": {
"type": "string",
"description": "Status filter"
}
}
}xero_get_quoteGet details for a specific quote.
Args:
{
"type": "object",
"required": [
"quoteId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"quoteId": {
"type": "string",
"description": "Quote ID"
}
}
}xero_create_quoteCreate a new quote.
Args:
{
"type": "object",
"required": [
"contactId",
"lineItems"
],
"properties": {
"date": {
"type": "string",
"description": "Quote date"
},
"terms": {
"type": "string",
"description": "Terms and conditions"
},
"title": {
"type": "string",
"description": "Title"
},
"status": {
"enum": [
"DRAFT",
"SENT"
],
"type": "string",
"description": "Status"
},
"summary": {
"type": "string",
"description": "Summary"
},
"contactId": {
"type": "string",
"description": "Contact ID"
},
"lineItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line items"
},
"reference": {
"type": "string",
"description": "Reference"
},
"expiryDate": {
"type": "string",
"description": "Expiry date"
},
"currencyCode": {
"type": "string",
"description": "Currency code"
},
"brandingThemeId": {
"type": "string",
"description": "Branding theme ID"
}
}
}xero_update_quoteUpdate an existing quote.
Args:
{
"type": "object",
"required": [
"quoteId"
],
"properties": {
"date": {
"type": "string",
"description": "Quote date"
},
"terms": {
"type": "string",
"description": "Terms and conditions"
},
"title": {
"type": "string",
"description": "Title"
},
"status": {
"enum": [
"DRAFT",
"SENT",
"DECLINED",
"ACCEPTED"
],
"type": "string",
"description": "Status"
},
"quoteId": {
"type": "string",
"description": "Quote ID"
},
"summary": {
"type": "string",
"description": "Summary"
},
"reference": {
"type": "string",
"description": "Reference"
},
"expiryDate": {
"type": "string",
"description": "Expiry date"
}
}
}xero_delete_quoteDelete a quote.
Args:
{
"type": "object",
"required": [
"quoteId"
],
"properties": {
"quoteId": {
"type": "string",
"description": "Quote ID to delete"
}
}
}xero_list_repeating_invoicesList repeating invoices from Xero.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_repeating_invoiceGet details for a specific repeating invoice.
Args:
{
"type": "object",
"required": [
"repeatingInvoiceId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"repeatingInvoiceId": {
"type": "string",
"description": "Repeating invoice ID"
}
}
}xero_create_repeating_invoiceCreate a new repeating invoice.
Args:
{
"type": "object",
"required": [
"type",
"contactId",
"lineItems"
],
"properties": {
"type": {
"enum": [
"ACCPAY",
"ACCREC"
],
"type": "string",
"description": "Invoice type"
},
"status": {
"enum": [
"DRAFT",
"AUTHORISED"
],
"type": "string",
"description": "Status"
},
"contactId": {
"type": "string",
"description": "Contact ID"
},
"lineItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line items"
},
"reference": {
"type": "string",
"description": "Reference"
},
"currencyCode": {
"type": "string",
"description": "Currency code"
},
"brandingThemeId": {
"type": "string",
"description": "Branding theme ID"
}
}
}xero_update_repeating_invoiceUpdate an existing repeating invoice.
Args:
{
"type": "object",
"required": [
"repeatingInvoiceId"
],
"properties": {
"status": {
"enum": [
"DRAFT",
"AUTHORISED",
"DELETED"
],
"type": "string",
"description": "Status"
},
"reference": {
"type": "string",
"description": "Reference"
},
"repeatingInvoiceId": {
"type": "string",
"description": "Repeating invoice ID"
}
}
}xero_delete_repeating_invoiceDelete a repeating invoice.
Args:
{
"type": "object",
"required": [
"repeatingInvoiceId"
],
"properties": {
"repeatingInvoiceId": {
"type": "string",
"description": "Repeating invoice ID to delete"
}
}
}xero_get_balance_sheetGet the Balance Sheet report.
Args:
{
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Report date"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"periods": {
"type": "integer",
"description": "Number of periods"
},
"timeframe": {
"enum": [
"MONTH",
"QUARTER",
"YEAR"
],
"type": "string",
"description": "Timeframe"
},
"paymentsOnly": {
"type": "boolean",
"description": "Cash basis"
},
"standardLayout": {
"type": "boolean",
"description": "Standard layout"
},
"trackingOptionId1": {
"type": "string",
"description": "Tracking option ID 1"
},
"trackingOptionId2": {
"type": "string",
"description": "Tracking option ID 2"
}
}
}xero_delete_tracking_optionDelete a tracking option.
Args:
{
"type": "object",
"required": [
"trackingCategoryId",
"trackingOptionId"
],
"properties": {
"trackingOptionId": {
"type": "string",
"description": "Tracking option ID to delete"
},
"trackingCategoryId": {
"type": "string",
"description": "Tracking category ID"
}
}
}xero_list_tax_ratesList tax rates from Xero.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_profit_and_lossGet the Profit and Loss report.
Args:
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"toDate": {
"type": "string",
"description": "End date"
},
"periods": {
"type": "integer",
"description": "Number of periods"
},
"fromDate": {
"type": "string",
"description": "Start date"
},
"timeframe": {
"enum": [
"MONTH",
"QUARTER",
"YEAR"
],
"type": "string",
"description": "Timeframe"
},
"paymentsOnly": {
"type": "boolean",
"description": "Cash basis"
},
"standardLayout": {
"type": "boolean",
"description": "Standard layout"
},
"trackingOptionId": {
"type": "string",
"description": "Tracking option ID"
},
"trackingCategoryId": {
"type": "string",
"description": "Tracking category ID"
}
}
}xero_get_trial_balanceGet the Trial Balance report.
Args:
{
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Report date"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"paymentsOnly": {
"type": "boolean",
"description": "Cash basis"
}
}
}xero_get_bank_summaryGet the Bank Summary report.
Args:
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"toDate": {
"type": "string",
"description": "End date"
},
"fromDate": {
"type": "string",
"description": "Start date"
}
}
}xero_get_aged_receivables_by_contactGet the Aged Receivables by Contact report.
Args:
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"date": {
"type": "string",
"description": "Report date"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"toDate": {
"type": "string",
"description": "To date"
},
"fromDate": {
"type": "string",
"description": "From date"
},
"contactId": {
"type": "string",
"description": "Contact ID"
}
}
}xero_get_aged_payables_by_contactGet the Aged Payables by Contact report.
Args:
{
"type": "object",
"required": [
"contactId"
],
"properties": {
"date": {
"type": "string",
"description": "Report date"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"toDate": {
"type": "string",
"description": "To date"
},
"fromDate": {
"type": "string",
"description": "From date"
},
"contactId": {
"type": "string",
"description": "Contact ID"
}
}
}xero_get_budget_summaryGet the Budget Summary report.
Args:
{
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Report date"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"periods": {
"type": "integer",
"description": "Number of periods"
},
"timeframe": {
"type": "integer",
"description": "Timeframe"
}
}
}xero_get_executive_summaryGet the Executive Summary report.
Args:
{
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Report date"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_reportGet any Xero report by name with custom parameters.
Args:
{
"type": "object",
"required": [
"reportName"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"params": {
"type": "object",
"description": "Report parameters"
},
"reportName": {
"type": "string",
"description": "Report name"
}
}
}xero_list_tracking_categoriesList tracking categories from Xero.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_tracking_categoryGet details for a specific tracking category.
Args:
{
"type": "object",
"required": [
"trackingCategoryId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"trackingCategoryId": {
"type": "string",
"description": "Tracking category ID"
}
}
}xero_create_tracking_categoryCreate a new tracking category.
Args:
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Category name"
}
}
}xero_update_tracking_categoryUpdate a tracking category.
Args:
{
"type": "object",
"required": [
"trackingCategoryId",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Category name"
},
"trackingCategoryId": {
"type": "string",
"description": "Tracking category ID"
}
}
}xero_delete_tracking_categoryDelete a tracking category.
Args:
{
"type": "object",
"required": [
"trackingCategoryId"
],
"properties": {
"trackingCategoryId": {
"type": "string",
"description": "Tracking category ID to delete"
}
}
}xero_create_tracking_optionCreate a tracking option within a category.
Args:
{
"type": "object",
"required": [
"trackingCategoryId",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Option name"
},
"trackingCategoryId": {
"type": "string",
"description": "Tracking category ID"
}
}
}xero_update_tracking_optionUpdate a tracking option.
Args:
{
"type": "object",
"required": [
"trackingCategoryId",
"trackingOptionId",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Option name"
},
"trackingOptionId": {
"type": "string",
"description": "Tracking option ID"
},
"trackingCategoryId": {
"type": "string",
"description": "Tracking category ID"
}
}
}xero_get_tax_rateGet details for a specific tax rate.
Args:
{
"type": "object",
"required": [
"taxType"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"taxType": {
"type": "string",
"description": "Tax type"
}
}
}xero_create_tax_rateCreate a new tax rate.
Args:
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Tax rate name"
},
"status": {
"enum": [
"ACTIVE",
"DELETED",
"ARCHIVED"
],
"type": "string",
"description": "Status"
},
"reportTaxType": {
"enum": [
"OUTPUT",
"INPUT",
"EXEMPTOUTPUT",
"EXEMPTINPUT",
"BASEXCLUDED",
"GSTONIMPORTS",
"ECACQUISITIONS",
"CAPITALSALESOUTPUT",
"CAPITALEXPENSESINPUT",
"ECOUTPUT",
"ECOUTPUTSERVICES"
],
"type": "string",
"description": "Report tax type"
}
}
}xero_update_tax_rateUpdate a tax rate.
Args:
{
"type": "object",
"required": [
"taxType"
],
"properties": {
"name": {
"type": "string",
"description": "Tax rate name"
},
"status": {
"enum": [
"ACTIVE",
"DELETED",
"ARCHIVED"
],
"type": "string",
"description": "Status"
},
"taxType": {
"type": "string",
"description": "Tax type"
},
"reportTaxType": {
"enum": [
"OUTPUT",
"INPUT",
"EXEMPTOUTPUT",
"EXEMPTINPUT",
"BASEXCLUDED",
"GSTONIMPORTS",
"ECACQUISITIONS",
"CAPITALSALESOUTPUT",
"CAPITALEXPENSESINPUT",
"ECOUTPUT",
"ECOUTPUTSERVICES"
],
"type": "string",
"description": "Report tax type"
}
}
}xero_list_currenciesList currencies from Xero.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_create_currencyAdd a currency to the organisation.
Args:
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "Currency code"
},
"description": {
"type": "string",
"description": "Currency description"
}
}
}xero_list_branding_themesList branding themes from Xero.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_branding_themeGet details for a specific branding theme.
Args:
{
"type": "object",
"required": [
"brandingThemeId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"brandingThemeId": {
"type": "string",
"description": "Branding theme ID"
}
}
}xero_list_usersList users from Xero.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}xero_get_userGet details for a specific user.
Args:
{
"type": "object",
"required": [
"userId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"userId": {
"type": "string",
"description": "User ID"
}
}
}