Xero API
Tools that enable LLMs to interact directly with the Xero API.
2.0.0The XeroApi toolkit enables seamless interaction with the Xero API for comprehensive accounting tasks. Designed for developers, it facilitates data retrieval and management in Xero.
Capabilities
- Integrate and automate accounting functions with Xero.
- Access detailed financial reports and historical data.
- Manage contacts, invoices, expenses, and transactions.
- Record and track history for various accounting entities.
- Fetch and manipulate attachments related to invoices and transactions.
OAuth
Utilizes OAuth 2.0 authentication with scopes including accounting.attachments, accounting.contacts, and more.
Secrets
No secrets are required for this toolkit.
Available tools(153)
| Tool name | Description | Secrets | |
|---|---|---|---|
Create a new history record for a contact in Xero.
This tool allows you to add a new history entry for a specific contact in Xero. Use it to log interactions, notes, or any relevant information about the contact. | |||
Creates a history record for an expense claim.
Use this tool to add a record to the history of a specific expense claim. It should be called when there is a need to document a change or update related to an expense claim in the system. | |||
Creates a history record for a specific quote.
Use this tool to add a history record to a specific quote in the Xero application. This is useful for tracking changes or updates made to a quote over time. | |||
Creates a record in the bank transaction history.
Use this tool to create a history record for a specific bank transaction in Xero. It's useful for logging changes or updates to bank transactions. | |||
Create a history record for a bank transfer.
This tool creates a history record for a specified bank transfer within the Xero service. It is useful for tracking changes and updates to bank transfers. | |||
Creates a history record for a batch payment.
This tool is used to create a historical record for a specified batch payment in Xero. Call this tool when you want to log information or updates about a batch payment's history. | |||
Create a history record for a specific invoice.
Use this tool to log a history record for a particular invoice in Xero. Ideal for tracking changes or adding comments to an invoice's history. | |||
Creates a history record for a specific item in Xero.
This tool is used to create a history record for a specific item in Xero, allowing users to keep track of changes or updates made to an item. | |||
Creates a history record for a specific manual journal.
Use this tool to log a new history entry for a specific manual journal in Xero. | |||
Create a history record for a specific payment.
This tool is used to create a history record for a particular payment in Xero. It should be called when you want to document the history or add notes for a payment by its PaymentID. | |||
Creates a history record for a specific prepayment.
Call this tool to create a history entry for a given prepayment in Xero, specifying the prepayment ID. | |||
Create a history record for a purchase order.
Use this tool to add a historical record to a specific purchase order when tracking changes or updates is necessary. | |||
Creates a history record for a repeating invoice.
Use this tool to create a history record for a specific repeating invoice in the Xero system. This is useful for maintaining a log of actions or updates associated with the invoice. | |||
Delete a chart of accounts in Xero.
Use this tool to delete a specified chart of accounts by providing the AccountID in Xero. This tool should be called when an account needs to be permanently removed. | |||
Remove an allocation from a specific credit note.
This tool is used to delete an allocation from a specified credit note in the Xero system. It should be called when you need to remove a particular allocation detail from an existing credit note. | |||
Delete a specific item from inventory.
Use this tool to remove an item from the inventory based on its ItemID. Call this tool to manage inventory by deleting items that are no longer needed or available. | |||
Delete a specific linked transaction.
Use this tool to delete a specified linked transaction (billable expense) by providing the LinkedTransactionID. It should be called when there's a need to remove an existing linked expense from Xero. | |||
Delete an allocation from an overpayment in Xero.
This tool deletes a specific allocation from an overpayment in the Xero system. Use this when you need to remove allocations linked to overpayments. | |||
Delete an allocation from a prepayment in Xero.
Use this tool to delete a specific allocation from a prepayment in Xero. This action is irreversible and should be used when a specific allocation needs to be removed. | |||
Deletes a specific tracking category option in Xero.
Use this tool to delete a specific tracking option from a selected tracking category in Xero. Useful for managing and updating your tracking categories when certain options are no longer needed. | |||
Retrieve all contacts from a Xero organization.
Use this tool to obtain a list of all contacts within a specified Xero organization. It should be called when there's a need to access or manage contact information in Xero. | |||
Fetch a specific bank transfer attachment by ID.
Use this tool to retrieve a specific attachment related to a bank transfer using the unique attachment ID. | |||
Retrieve the history of a specific credit note.
Use this tool to access and retrieve history records of a specific credit note by providing the CreditNoteID. This can be helpful for auditing or tracking changes made to a credit note over time. | |||
Retrieve payments for invoices and credit notes in Xero.
Use this tool to fetch a list of payments associated with invoices and credit notes from Xero. It is useful for obtaining payment records for financial analysis or reconciliation purposes. | |||
Retrieve a specific attachment from a purchase order.
Use this tool to obtain a specific attachment from a purchase order using the attachment's unique ID within the Xero platform. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
XeroApi.AddContactHistoryRecord
Create a new history record for a contact in Xero. This tool allows you to add a new history entry for a specific contact in Xero. Use it to log interactions, notes, or any relevant information about the contact.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_unique_identifier | string | Required | Unique identifier for a Contact in Xero. Required to specify which contact the history record is for. |
tenant_identifier | string | Required | Xero identifier for the Tenant. Required to specify which tenant's contact history to update. |
idempotency_key | string | Optional | A unique string up to 128 characters to safely retry requests without duplicate processing. |
Requirements
Output
json— Response from the API endpoint 'createContactHistory'.XeroApi.AddExpenseClaimHistory
Creates a history record for an expense claim. Use this tool to add a record to the history of a specific expense claim. It should be called when there is a need to document a change or update related to an expense claim in the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
expense_claim_id | string | Required | Unique identifier for the specific expense claim to add a history record. |
xero_tenant_id | string | Required | The unique identifier for the Xero tenant. This is required to specify which tenant the expense claim history record is associated with. |
idempotency_key | string | Optional | A unique string (max 128 characters) to safely retry requests without duplicating processing. |
Requirements
Output
json— Response from the API endpoint 'createExpenseClaimHistory'.XeroApi.AddQuoteHistory
Creates a history record for a specific quote. Use this tool to add a history record to a specific quote in the Xero application. This is useful for tracking changes or updates made to a quote over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_identifier | string | Required | Unique identifier for a quote to which the history will be added. |
xero_tenant_id | string | Required | Xero identifier for the tenant. Required for specifying the tenant within the Xero system. |
idempotency_key | string | Optional | Unique key to safely retry requests and avoid duplicate processing (max 128 characters). |
Requirements
Output
json— Response from the API endpoint 'createQuoteHistory'.XeroApi.CreateBankTransactionHistory
Creates a record in the bank transaction history. Use this tool to create a history record for a specific bank transaction in Xero. It's useful for logging changes or updates to bank transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transaction_id | string | Required | Xero-generated unique identifier for the bank transaction to create a history record. |
tenant_id | string | Required | Xero identifier for the tenant. This is required to specify which Xero account the transaction history will be associated with. |
idempotency_key | string | Optional | A unique key to prevent duplicate processing. Maximum 128 characters. |
Requirements
Output
json— Response from the API endpoint 'createBankTransactionHistoryRecord'.XeroApi.CreateBankTransferHistory
Create a history record for a bank transfer. This tool creates a history record for a specified bank transfer within the Xero service. It is useful for tracking changes and updates to bank transfers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transfer_id | string | Required | Xero generated unique identifier for the specific bank transfer to create a history record for. |
xero_tenant_id | string | Required | The unique identifier for a Xero tenant. Required to specify which tenant's data to access. |
idempotency_key | string | Optional | A unique string to safely retry requests without risk of duplication, limited to 128 characters. |
Requirements
Output
json— Response from the API endpoint 'createBankTransferHistoryRecord'.XeroApi.CreateBatchPaymentHistoryRecord
Creates a history record for a batch payment. This tool is used to create a historical record for a specified batch payment in Xero. Call this tool when you want to log information or updates about a batch payment's history.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_payment_id | string | Required | Unique identifier for the specific batch payment in Xero. |
xero_tenant_identifier | string | Required | Xero identifier for Tenant. This is required to specify which tenant's batch payment history is being recorded. |
idempotency_key | string | Optional | A unique string to prevent duplicate processing. Maximum 128 characters. |
Requirements
Output
json— Response from the API endpoint 'createBatchPaymentHistoryRecord'.XeroApi.CreateInvoiceHistory
Create a history record for a specific invoice. Use this tool to log a history record for a particular invoice in Xero. Ideal for tracking changes or adding comments to an invoice's history.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_id | string | Required | Unique identifier for the invoice. This is required to create a history record for the specified invoice in Xero. |
tenant_identifier | string | Required | Xero identifier for the Tenant. Required for specifying which tenant the invoice history belongs to. |
idempotency_key | string | Optional | A string up to 128 characters to safely retry requests without duplicate processing. |
Requirements
Output
json— Response from the API endpoint 'createInvoiceHistory'.XeroApi.CreateItemHistory
Creates a history record for a specific item in Xero. This tool is used to create a history record for a specific item in Xero, allowing users to keep track of changes or updates made to an item.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
item_id | string | Required | Unique identifier for the item to create a history record for in Xero. |
tenant_identifier | string | Required | Xero identifier for the tenant, required to specify which tenant's item history is being updated. |
idempotency_key | string | Optional | A unique key to ensure request retrying without duplication, max 128 characters. |
Requirements
Output
json— Response from the API endpoint 'createItemHistory'.XeroApi.CreateJournalHistoryRecord
Creates a history record for a specific manual journal. Use this tool to log a new history entry for a specific manual journal in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
manual_journal_id | string | Required | Unique identifier for a specific manual journal in Xero. |
tenant_identifier | string | Required | Xero identifier for the tenant is required to specify which tenant's manual journal is being updated. |
idempotency_key | string | Optional | A unique string, up to 128 characters, to safely retry requests without duplicate processing. |
Requirements
Output
json— Response from the API endpoint 'createManualJournalHistoryRecord'.XeroApi.CreatePaymentHistoryRecord
Create a history record for a specific payment. This tool is used to create a history record for a particular payment in Xero. It should be called when you want to document the history or add notes for a payment by its PaymentID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_identifier | string | Required | Unique identifier for a specific payment in Xero. |
xero_tenant_id | string | Required | The unique identifier for the Xero tenant. This is required to specify which tenant's data the action applies to. |
idempotency_key | string | Optional | A unique key to safely retry requests and prevent duplicate processing. Maximum 128 characters. |
Requirements
Output
json— Response from the API endpoint 'createPaymentHistory'.XeroApi.CreatePrepaymentHistory
Creates a history record for a specific prepayment. Call this tool to create a history entry for a given prepayment in Xero, specifying the prepayment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
prepayment_id | string | Required | Unique identifier for the specific PrePayment to create a history record for. |
xero_tenant_id | string | Required | Xero identifier for the Tenant. This is required to specify which tenant's data the prepayment history applies to. |
idempotency_key | string | Optional | A unique string to safely retry requests without duplicate processing, up to 128 characters. |
Requirements
Output
json— Response from the API endpoint 'createPrepaymentHistory'.XeroApi.CreatePurchaseOrderHistory
Create a history record for a purchase order. Use this tool to add a historical record to a specific purchase order when tracking changes or updates is necessary.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
purchase_order_id | string | Required | Unique identifier for a Purchase Order. Pass the specific ID for which a history record will be created. |
tenant_identifier | string | Required | The unique Xero identifier for the tenant. Required for API requests. |
idempotency_key | string | Optional | A unique key to safely retry requests without duplicate processing; 128 character max. |
Requirements
Output
json— Response from the API endpoint 'createPurchaseOrderHistory'.XeroApi.CreateRepeatingInvoiceHistory
Creates a history record for a repeating invoice. Use this tool to create a history record for a specific repeating invoice in the Xero system. This is useful for maintaining a log of actions or updates associated with the invoice.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repeating_invoice_id | string | Required | Unique identifier for a Repeating Invoice to create a history record. |
tenant_identifier | string | Required | Xero identifier for the tenant, required for accessing specific tenant data. |
idempotency_key | string | Optional | A unique string, max 128 characters, to safely retry requests without duplication. |
Requirements
Output
json— Response from the API endpoint 'createRepeatingInvoiceHistory'.XeroApi.DeleteAccount
Delete a chart of accounts in Xero. Use this tool to delete a specified chart of accounts by providing the AccountID in Xero. This tool should be called when an account needs to be permanently removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier for the Account object to be deleted. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. Required to specify which tenant's account to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteAccount'.XeroApi.DeleteCreditNoteAllocation
Remove an allocation from a specific credit note. This tool is used to delete an allocation from a specified credit note in the Xero system. It should be called when you need to remove a particular allocation detail from an existing credit note.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
allocation_id | string | Required | Unique identifier for the Allocation object needing deletion from a credit note. |
credit_note_unique_id | string | Required | Unique identifier for a specific credit note to delete the allocation from. |
xero_tenant_id | string | Required | Unique Xero identifier for the Tenant. Required to specify which tenant's data is being accessed. |
Requirements
Output
json— Response from the API endpoint 'deleteCreditNoteAllocations'.XeroApi.DeleteInventoryItem
Delete a specific item from inventory. Use this tool to remove an item from the inventory based on its ItemID. Call this tool to manage inventory by deleting items that are no longer needed or available.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
item_id | string | Required | Unique identifier for the item to be deleted. |
tenant_identifier | string | Required | The unique identifier for the Xero tenant to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'deleteItem'.XeroApi.DeleteLinkedTransaction
Delete a specific linked transaction. Use this tool to delete a specified linked transaction (billable expense) by providing the LinkedTransactionID. It should be called when there's a need to remove an existing linked expense from Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
linked_transaction_id | string | Required | Unique identifier for the linked transaction to be deleted. |
xero_tenant_identifier | string | Required | Provide the unique Xero identifier for the tenant to specify the context of the deletion. |
Requirements
Output
json— Response from the API endpoint 'deleteLinkedTransaction'.XeroApi.DeleteOverpaymentAllocation
Delete an allocation from an overpayment in Xero. This tool deletes a specific allocation from an overpayment in the Xero system. Use this when you need to remove allocations linked to overpayments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
allocation_id | string | Required | Unique identifier for the Allocation object to be deleted. |
overpayment_id | string | Required | Unique identifier for a specific overpayment in Xero. |
xero_tenant_identifier | string | Required | Xero identifier for the tenant. Required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'deleteOverpaymentAllocations'.XeroApi.DeletePrepaymentAllocation
Delete an allocation from a prepayment in Xero. Use this tool to delete a specific allocation from a prepayment in Xero. This action is irreversible and should be used when a specific allocation needs to be removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
allocation_id | string | Required | Unique identifier for the Allocation object to be deleted from a prepayment. |
prepayment_id | string | Required | Unique identifier for a PrePayment. Required to specify which prepayment the allocation will be deleted from. |
xero_tenant_identifier | string | Required | Xero identifier for the tenant in which the prepayment allocation deletion will occur. |
Requirements
Output
json— Response from the API endpoint 'deletePrepaymentAllocations'.XeroApi.DeleteTrackingOption
Deletes a specific tracking category option in Xero. Use this tool to delete a specific tracking option from a selected tracking category in Xero. Useful for managing and updating your tracking categories when certain options are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tracking_category_id | string | Required | Unique identifier for the tracking category to specify which category the option will be deleted from. |
tracking_option_id | string | Required | Unique identifier for a tracking option to be deleted in Xero. |
xero_tenant_id | string | Required | The unique identifier for a Xero tenant. This specifies which tenant's data will be affected. |
Requirements
Output
json— Response from the API endpoint 'deleteTrackingOptions'.XeroApi.FetchAllXeroContacts
Retrieve all contacts from a Xero organization. Use this tool to obtain a list of all contacts within a specified Xero organization. It should be called when there's a need to access or manage contact information in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | A unique string to identify the tenant in Xero. |
contact_ids | array<string> | Optional | Comma-separated list of ContactIDs to retrieve specific contacts. Use this to filter the contacts returned by their unique IDs in a single call. |
filter_by_element | string | Optional | Specify conditions to filter contacts by any element within their data fields. |
include_archived_contacts | boolean | Optional | Set to true to include contacts with a status of ARCHIVED in the response. False will exclude them. |
modified_since_timestamp | string | Optional | Retrieve only records created or modified after the specified timestamp. Use ISO 8601 format for the timestamp. |
pagination_page_number | integer | Optional | The specific page number to retrieve when fetching contacts. Each page returns up to 100 contacts. |
records_per_page | integer | Optional | Number of contact records to retrieve per page. |
retrieve_summary_only_contacts | boolean | Optional | Set to true to retrieve only lightweight contact fields, excluding computation-heavy data for faster API responses. |
search_term | string | Optional | A case-insensitive search term for filtering contacts by Name, FirstName, LastName, ContactNumber, or EmailAddress. |
sort_order | string | Optional | Specifies the sorting order for contacts based on a specified element, such as name or date. |
Requirements
Output
json— Response from the API endpoint 'getContacts'.XeroApi.FetchBankTransferAttachment
Fetch a specific bank transfer attachment by ID. Use this tool to retrieve a specific attachment related to a bank transfer using the unique attachment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the attachment object that you want to retrieve from a specific bank transfer. |
attachment_mime_type | string | Required | The MIME type of the attachment to retrieve, e.g., image/jpg, application/pdf. |
bank_transfer_unique_id | string | Required | Xero-generated unique identifier for a bank transfer. It is required to locate the specific transfer for the attachment. |
tenant_identifier | string | Required | The Xero identifier for the tenant you want to access. |
Requirements
Output
json— Response from the API endpoint 'getBankTransferAttachmentById'.XeroApi.FetchCreditNoteHistory
Retrieve the history of a specific credit note. Use this tool to access and retrieve history records of a specific credit note by providing the CreditNoteID. This can be helpful for auditing or tracking changes made to a credit note over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_note_id | string | Required | Unique identifier for the credit note whose history you want to retrieve. |
xero_tenant_id | string | Required | Xero identifier for the tenant. Required to specify which tenant's credit note history to retrieve. |
idempotency_key | string | Optional | String to safely retry requests without creating duplicates. Max 128 characters. |
Requirements
Output
json— Response from the API endpoint 'createCreditNoteHistory'.XeroApi.FetchInvoicePayments
Retrieve payments for invoices and credit notes in Xero. Use this tool to fetch a list of payments associated with invoices and credit notes from Xero. It is useful for obtaining payment records for financial analysis or reconciliation purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. This is required to access the specific tenant's data. |
filter_condition | string | Optional | Specify the filter condition for retrieving payments, based on any element. |
modified_since_timestamp | string | Optional | Only records created or modified since this timestamp will be retrieved. Use ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ'). |
order_by | string | Optional | Specify the order of payments by any element, such as date or amount. |
page_number | integer | Optional | The page number to retrieve, starting from 1. Up to 100 payments are returned per page. |
records_per_page | integer | Optional | Specify the number of records to retrieve per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'getPayments'.XeroApi.FetchPurchaseOrderAttachment
Retrieve a specific attachment from a purchase order. Use this tool to obtain a specific attachment from a purchase order using the attachment's unique ID within the Xero platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the attachment object to be retrieved. |
attachment_mime_type | string | Required | The MIME type of the attachment file to retrieve, e.g., image/jpg, application/pdf. |
purchase_order_id | string | Required | Unique identifier for a Purchase Order to retrieve a specific attachment. |
xero_tenant_id | string | Required | Xero identifier for the Tenant. This is required to specify which organization the request is for. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrderAttachmentById'.XeroApi.GetAgedPayablesReportByContact
Retrieve aged payables report by contact. Use this tool to get a report on aged payables categorized by contact. It provides insights into outstanding payables over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | Unique identifier for the contact to retrieve the aged payables report. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. Required to specify which tenant's data is being accessed. |
report_date | string | Optional | The specific date for the Aged Payables By Contact report in YYYY-MM-DD format. |
report_end_date | string | Optional | Filter the report by specifying the end date, formatted as YYYY-MM-DD (e.g., 2021-02-28). |
report_from_date | string | Optional | Specify the start date for filtering the report, in YYYY-MM-DD format (e.g. 2021-02-01). |
Requirements
Output
json— Response from the API endpoint 'getReportAgedPayablesByContact'.XeroApi.GetAgedReceivablesReportByContact
Retrieve aged receivables report by contact. Use this tool to get a detailed report of aged receivables, organized by contact, which helps in assessing outstanding debts for each contact.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | Unique identifier for a Contact to retrieve their aged receivables report. |
tenant_identifier | string | Required | Unique Xero identifier for the Tenant. Required to specify which tenant's data to retrieve. |
filter_by_to_date | string | Optional | Specify the end date for filtering the aged receivables report, e.g., '2021-02-28'. |
report_date | string | Optional | The specific date for which the aged receivables report by contact is generated. |
start_date_filter | string | Optional | Filter the report starting from this date (YYYY-MM-DD). |
Requirements
Output
json— Response from the API endpoint 'getReportAgedReceivablesByContact'.XeroApi.GetBalanceSheetReport
Retrieve the balance sheet report from Xero. Fetches the balance sheet report, detailing financial positions. Useful for obtaining up-to-date financial summaries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. Used to specify which organization's data to retrieve in Xero. |
balance_sheet_tracking_option_id_1 | string | Optional | The first tracking option ID for generating the Balance Sheet report in Xero. |
comparison_timeframe | string | Optional | The period size for comparison, e.g., MONTH, QUARTER, or YEAR. |
number_of_periods | integer | Optional | The number of periods to include in the Balance Sheet report. |
report_date | string | Optional | The specific date for which to retrieve the Balance Sheet report. Format as YYYY-MM-DD. |
return_cash_basis | boolean | Optional | Set to True to return the Balance Sheet report using a cash basis. |
tracking_option_id_2 | string | Optional | The tracking option ID for secondary categorization in the Balance Sheet report. This allows for filtering or segmentation based on a second tracking category within Xero. |
use_standard_layout | boolean | Optional | Set to true to use the standard layout for the Balance Sheet report in Xero. |
Requirements
Output
json— Response from the API endpoint 'getReportBalanceSheet'.XeroApi.GetBankSummaryReport
Retrieve bank summary reports from Xero. This tool fetches a bank summary report, providing a detailed overview of bank transactions and balances. Use it when you need to review financial summaries from Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | Unique identifier for the Xero tenant. Required for accessing the relevant account data. |
end_date_filter | string | Optional | Filter the report by the end date, formatted as YYYY-MM-DD, e.g., 2021-02-28. |
start_date_filter | string | Optional | Filter the report by the starting date, formatted as YYYY-MM-DD. For example, 2021-02-01. |
Requirements
Output
json— Response from the API endpoint 'getReportBankSummary'.XeroApi.GetBankTransactionAttachment
Retrieve an attachment from a bank transaction by filename. Use this tool to get a specific attachment from a bank transaction using the filename. Ideal for cases where attachments need to be reviewed or downloaded based on their association with bank transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_filename | string | Required | Name of the attachment to retrieve from the bank transaction. |
attachment_mime_type | string | Required | The MIME type of the attachment file to retrieve, such as image/jpg or application/pdf. |
bank_transaction_id | string | Required | Xero generated unique identifier for a bank transaction. Required to retrieve the correct attachment. |
xero_tenant_identifier | string | Required | The unique identifier for the Xero tenant associated with the bank transaction. |
Requirements
Output
json— Response from the API endpoint 'getBankTransactionAttachmentByFileName'.XeroApi.GetBankTransactionHistory
Retrieve history of a specific bank transaction by ID. This tool fetches the historical details of a particular bank transaction using its unique ID. It should be called when users need to view past records or changes related to a specific transaction.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transaction_id | string | Required | The unique identifier for a bank transaction generated by Xero. Use this ID to retrieve specific transaction history. |
tenant_identifier | string | Required | Xero unique identifier for the tenant. Required to access tenant-specific data. |
Requirements
Output
json— Response from the API endpoint 'getBankTransactionsHistory'.XeroApi.GetBankTransferHistory
Retrieve specific bank transfer history by ID. This tool is used to get the history of a specific bank transfer using its unique ID. It should be called when detailed transaction records or changes related to a particular bank transfer are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transfer_id | string | Required | Unique identifier for the Xero bank transfer needed to retrieve its history. |
tenant_identifier | string | Required | Xero identifier for the tenant. Required to specify which tenant's bank transfer history to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getBankTransferHistory'.XeroApi.GetBatchPaymentDetails
Retrieve details of a specific batch payment by ID. Use this tool to get information about a specific batch payment by providing its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_payment_id | string | Required | Unique identifier for the batch payment to retrieve details. |
xero_tenant_id | string | Required | The unique Xero identifier for the tenant, necessary for accessing tenant-specific data. |
Requirements
Output
json— Response from the API endpoint 'getBatchPayment'.XeroApi.GetBrandingThemes
Retrieve all branding themes from Xero. This tool calls the Xero API to fetch all available branding themes. It should be used when needing a comprehensive list of branding themes for the account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | The unique identifier for the Xero tenant to retrieve branding themes. |
Requirements
Output
json— Response from the API endpoint 'getBrandingThemes'.XeroApi.GetBudgetSummaryReport
Retrieves the budget summary report from Xero. This tool calls the Xero endpoint to obtain a detailed budget summary report. Use this when a financial summary of budget allocations is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | The unique Xero identifier for the tenant, required for authentication and data retrieval. |
comparison_timeframe | integer | Optional | Specify the period size for comparison: 1 for month, 3 for quarter, or 12 for year. |
number_of_periods_to_compare | integer | Optional | The number of periods for comparison, must be an integer between 1 and 12. |
report_date | string | Optional | The specific date for the budget summary report in YYYY-MM-DD format, e.g., 2018-03-31. |
Requirements
Output
json— Response from the API endpoint 'getReportBudgetSummary'.XeroApi.GetCisSettings
Retrieve CIS settings for a Xero organisation. Use this tool to get the Construction Industry Scheme (CIS) settings for a specific organisation in Xero. Useful for managing or reviewing CIS compliance within the organisation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organisation_id | string | Required | The unique Xero identifier for the organisation to retrieve CIS settings for. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. Required to specify which tenant's CIS settings to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getOrganisationCISSettings'.XeroApi.GetContactAttachment
Retrieve a contact's attachment by file name. Fetches a specific attachment associated with a contact using the file name in Xero. Use when you need to access a particular contact's attachment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_name | string | Required | Specify the name of the attachment to retrieve from the contact. |
attachment_mime_type | string | Required | The MIME type of the attachment file, such as image/jpg or application/pdf. |
contact_identifier | string | Required | Unique identifier for a contact in Xero to retrieve its specific attachment. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. This is required to specify which tenant's data should be accessed. |
Requirements
Output
json— Response from the API endpoint 'getContactAttachmentByFileName'.XeroApi.GetContactAttachments
Retrieve attachments for a Xero contact. This tool retrieves all attachments associated with a specific contact within a Xero organisation. Call this tool when you need to access files linked to a contact in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | Unique identifier for a contact in Xero. |
xero_tenant_identifier | string | Required | The unique Xero tenant identifier for the organisation. |
Requirements
Output
json— Response from the API endpoint 'getContactAttachments'.XeroApi.GetContactCisSettings
Retrieve CIS settings for a Xero contact. Use this tool to obtain the CIS (Construction Industry Scheme) settings for a specific contact within a Xero organization. This is useful for businesses managing construction-related compliance and financial data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | Unique identifier for a specific contact in Xero. |
tenant_identifier | string | Required | Xero identifier for the tenant. Required for accessing the correct organization within Xero. |
Requirements
Output
json— Response from the API endpoint 'getContactCISSettings'.XeroApi.GetContactHistory
Retrieve history records for a specific contact. Use this tool to obtain historical interaction records for a specific contact, which can provide insights into past communications and actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | Unique identifier for a contact to retrieve their history records. |
tenant_identifier | string | Required | The unique Xero identifier for the tenant. Required to access specific tenant data. |
Requirements
Output
json— Response from the API endpoint 'getContactHistory'.XeroApi.GetCreditNoteAttachment
Retrieve specific attachment from a credit note by ID. Use this tool to get an attachment from a credit note using the unique attachment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the attachment object to be retrieved. |
attachment_mime_type | string | Required | The MIME type of the attachment file to retrieve, such as image/jpg or application/pdf. |
credit_note_id | string | Required | Unique identifier for the credit note you want to retrieve an attachment from. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. It's required to specify which organization to access. |
Requirements
Output
json— Response from the API endpoint 'getCreditNoteAttachmentById'.XeroApi.GetCreditNoteAttachments
Fetch attachments for a specific credit note from Xero. Use this tool to retrieve attachments associated with a specific credit note in Xero. Call this tool when you need details or files attached to a credit note.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_note_id | string | Required | Unique identifier for a specific Credit Note in Xero to fetch attachments. |
tenant_identifier | string | Required | Xero identifier for the tenant. Required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getCreditNoteAttachments'.XeroApi.GetCreditNoteHistory
Retrieve history records of a specific credit note. Use this tool to obtain detailed history records for a specific credit note by providing its ID. It helps in tracking changes and updates made to the credit note over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_note_id | string | Required | Unique identifier for a specific credit note. Required to retrieve its history records. |
xero_tenant_id | string | Required | The unique identifier for a Xero tenant. Required to access tenant-specific data. |
Requirements
Output
json— Response from the API endpoint 'getCreditNoteHistory'.XeroApi.GetCreditNotePdf
Retrieve a credit note as a PDF file. Use this tool to fetch a specific credit note in PDF format using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_note_id | string | Required | Unique identifier for the credit note to retrieve as a PDF. |
tenant_identifier | string | Required | Xero identifier for the tenant to retrieve the specific credit note PDF. |
Requirements
Output
json— Response from the API endpoint 'getCreditNoteAsPdf'.XeroApi.GetCreditNotes
Retrieve credit notes from the Xero service. Use this tool to obtain credit notes from Xero. Ideal for financial checks or reconciliations requiring credit note information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The unique identifier for the Xero tenant. Required to specify which tenant's credit notes to retrieve. |
filter_by_element | string | Optional | A string to filter credit notes by specific criteria using any element. |
modified_since_timestamp | string | Optional | Only retrieve records created or modified after this timestamp (in ISO 8601 format). |
number_of_records_per_page | integer | Optional | Defines the number of credit notes to retrieve per page from the Xero service. This helps control the size of each result set. |
page_number | integer | Optional | The page number to retrieve. Each page returns up to 100 credit notes with line items. |
sort_credit_notes | string | Optional | Specifies the order to retrieve credit notes, e.g., by date or amount. |
unit_decimal_places | integer | Optional | Specify the number of decimal places for unit amounts. For example, use 4 for four decimal places. |
Requirements
Output
json— Response from the API endpoint 'getCreditNotes'.XeroApi.GetDraftExpenseReceipts
Retrieve draft expense claim receipts from Xero. This tool retrieves draft expense receipts for any user from Xero. It should be called when you need to access draft expense claims.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | The unique identifier for a Xero tenant. Used to specify which tenant's data to retrieve. |
filter_condition | string | Optional | A string to filter draft expense receipts based on specified criteria. |
modified_since_timestamp | string | Optional | A timestamp to filter records updated or created since this date. Format should be in ISO 8601, e.g., '2023-10-10T00:00:00Z'. |
order_receipts_by | string | Optional | Specify the attribute by which to order the receipts. For example, by date or amount. |
unit_decimal_places | integer | Optional | Specifies the number of decimal places for unit amounts. For example, set to 4 for four decimal places. |
Requirements
Output
json— Response from the API endpoint 'getReceipts'.XeroApi.GetExpenseReceiptAttachment
Retrieve an attachment from a receipt by file name. This tool retrieves a specific attachment from an expense claim receipt using the file name. It should be called when you need to access a specific attachment associated with a receipt in the Xero platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_name | string | Required | The name of the attachment to retrieve from the expense claim receipt. |
attachment_mime_type | string | Required | The MIME type of the attachment file, such as image/jpg or application/pdf, that you are retrieving from the receipt. |
receipt_id | string | Required | The unique identifier for a specific expense receipt. This is used to locate the correct receipt attachment. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. Required to specify the organization context in Xero from which to retrieve the attachment. |
Requirements
Output
json— Response from the API endpoint 'getReceiptAttachmentByFileName'.XeroApi.GetFinancialJournals
Retrieve financial journal entries from Xero. Use this tool to access financial journal entries recorded in Xero. It should be called when detailed accounting journal information is needed for financial analysis or record-keeping.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The unique Xero identifier for the tenant. Required to specify which tenant's journals are retrieved. |
journal_number_offset | integer | Optional | Specify the journal number offset. Journals with a number greater than this will be returned. |
modified_since_timestamp | string | Optional | Return records created or modified since this timestamp. Use a string format like 'YYYY-MM-DDTHH:MM:SSZ'. |
retrieve_cash_basis_journals | boolean | Optional | Set to true to retrieve journals on a cash basis. Defaults to false for accrual basis. |
Requirements
Output
json— Response from the API endpoint 'getJournals'.XeroApi.GetInvoiceAttachment
Retrieve an attachment from an invoice by filename. Use this tool to obtain a specific attachment from an invoice or purchase bill by specifying the filename.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_name | string | Required | Specify the exact name of the attachment to retrieve from the invoice or purchase bill. |
attachment_mime_type | string | Required | The MIME type of the attachment file being retrieved, such as image/jpg or application/pdf. |
invoice_id | string | Required | Unique identifier for the invoice from which to retrieve the attachment. |
tenant_identifier | string | Required | Xero identifier for the Tenant to specify which organization's data to access. |
Requirements
Output
json— Response from the API endpoint 'getInvoiceAttachmentByFileName'.XeroApi.GetInvoiceDetails
Retrieve a specific invoice using its unique ID. Use this tool to get detailed information about a specific sales invoice or purchase bill by providing its unique invoice ID. This can be helpful when checking invoice details in the Xero accounting system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_identifier | string | Required | Unique identifier for the invoice to be retrieved. |
xero_tenant_id | string | Required | Xero identifier for the Tenant. Used to specify which tenant's invoice is retrieved. |
unit_decimal_places | integer | Optional | Specify the number of decimal places to use for unit amounts, e.g., 4 for four decimal places. |
Requirements
Output
json— Response from the API endpoint 'getInvoice'.XeroApi.GetInvoiceReminderSettings
Retrieve invoice reminder settings from Xero. This tool retrieves the current settings for invoice reminders from Xero. It should be called when you need to check or manage how invoice reminders are configured.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | The unique identifier for the Xero tenant. This is required to access specific tenant data. |
Requirements
Output
json— Response from the API endpoint 'getInvoiceReminders'.XeroApi.GetItemHistory
Retrieve history for a specific item from Xero. This tool retrieves the historical details of a specific item using its ItemID. Use it to access the change history or modifications made to an item within the Xero platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
item_id | string | Required | Unique identifier for the item whose history you want to retrieve in Xero. |
xero_tenant_id | string | Required | Provide the unique Xero identifier associated with the Tenant to access its data. |
Requirements
Output
json— Response from the API endpoint 'getItemHistory'.XeroApi.GetItems
Retrieve items from Xero. This tool fetches a list of items from the Xero service, typically used for inventory or sales purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | The unique identifier for a Xero tenant. Required to specify which tenant's data to retrieve. |
filter_criteria | string | Optional | Filter items by specific criteria using any element such as field names or conditions. |
modified_since_timestamp | string | Optional | Fetch records created or modified since the provided timestamp (e.g., '2023-01-01T00:00:00Z'). |
order_by_element | string | Optional | Specify the sorting order of items by any element, such as name or price. |
unit_decimal_places | integer | Optional | Defines the number of decimal places for unit amounts, e.g., 4 for four decimal places. |
Requirements
Output
json— Response from the API endpoint 'getItems'.XeroApi.GetJournalAttachmentByFilename
Retrieve a manual journal attachment by file name. Use this tool to get a specific attachment from a manual journal using its file name. It requires the manual journal ID and the file name to retrieve the attachment data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_mime_type | string | Required | The MIME type of the attachment file, such as image/jpeg or application/pdf. |
attachment_file_name | string | Required | The name of the attachment file to retrieve from the manual journal. |
manual_journal_id | string | Required | Unique identifier for the manual journal. Required to retrieve the specific attachment. |
xero_tenant_identifier | string | Required | The unique identifier for the Xero tenant, used to specify the particular organization's data to access. |
Requirements
Output
json— Response from the API endpoint 'getManualJournalAttachmentByFileName'.XeroApi.GetLinkedTransaction
Retrieve specific linked transaction details by ID. Use this tool to get detailed information about a specific linked transaction, such as billable expenses, using a unique transaction ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
linked_transaction_id | string | Required | Unique identifier for the linked transaction to be retrieved. |
tenant_id | string | Required | Xero tenant identifier for accessing the correct organization. |
Requirements
Output
json— Response from the API endpoint 'getLinkedTransaction'.XeroApi.GetManualJournalHistory
Retrieve history for a specific manual journal. This tool fetches the historical details related to a specific manual journal by its ID from Xero, providing insights into past changes and actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
manual_journal_id | string | Required | Unique identifier for the manual journal. Used to retrieve its historical details from Xero. |
xero_tenant_id | string | Required | Xero identifier for a specific tenant. This is required to identify which tenant's data to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getManualJournalsHistory'.XeroApi.GetOverpaymentHistory
Retrieve history records for a specific overpayment in Xero. Use this tool to obtain detailed history records related to a specific overpayment, identified by the Overpayment ID, within the Xero platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
overpayment_id | string | Required | Unique identifier for a specific overpayment in Xero. |
xero_tenant_id | string | Required | Unique identifier for the tenant in Xero. Used to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getOverpaymentHistory'.XeroApi.GetPaymentServicesForBrandingTheme
Retrieve payment services for a specific branding theme. This tool retrieves the payment services linked to a given branding theme by its ID. Call this tool when you need to access payment service information tied to particular branding configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branding_theme_id | string | Required | Unique identifier for a Branding Theme to retrieve associated payment services. |
xero_tenant_id | string | Required | Xero identifier for the Tenant. This unique ID is required to specify which tenant's data is being accessed. |
Requirements
Output
json— Response from the API endpoint 'getBrandingThemePaymentServices'.XeroApi.GetPrepaymentDetails
Retrieve details of a specified prepayment from Xero. Use this tool to obtain information on a specific prepayment by providing the PrepaymentID. Ideal for checking prepayment details within the Xero accounting system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
prepayment_id | string | Required | The unique identifier for the prepayment you want to retrieve. |
xero_tenant_id | string | Required | The unique Xero identifier for the tenant. Required to retrieve specific prepayment data. |
Requirements
Output
json— Response from the API endpoint 'getPrepayment'.XeroApi.GetPrepaymentHistory
Retrieve history for a specific prepayment. Use this tool to obtain the historical records associated with a specific prepayment in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
prepayment_id | string | Required | Unique identifier for the prepayment to retrieve its history. |
xero_tenant_id | string | Required | Unique identifier for the Xero tenant, required to access its data. |
Requirements
Output
json— Response from the API endpoint 'getPrepaymentHistory'.XeroApi.GetProfitAndLossReport
Retrieve profit and loss report from Xero. Call this tool to obtain detailed profit and loss reports for financial analysis.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The Xero identifier for the tenant. Required to specify which tenant's data to access. |
comparison_timeframe | string | Optional | The period size to compare to for the report. Options are MONTH, QUARTER, or YEAR. |
end_date | string | Optional | Filter by the end date of the report in YYYY-MM-DD format, e.g., 2021-02-28. |
from_date | string | Optional | Filter the report by the starting date in YYYY-MM-DD format, e.g., 2021-02-01. |
number_of_comparison_periods | integer | Optional | The number of periods to compare, must be an integer between 1 and 12. |
return_cash_basis_only | boolean | Optional | Specify true to return the Profit and Loss report on a cash only basis. |
return_standard_layout | boolean | Optional | Set to true to return the Profit and Loss report in the standard layout. |
secondary_tracking_category_id | string | Optional | The ID of the second tracking category for the Profit and Loss report. |
tracking_category_id | string | Optional | The first tracking category ID for the Profit and Loss report filter. Expect a string representing the tracking category identifier. |
tracking_option_1_id | string | Optional | The identifier for the first tracking option in the Profit and Loss report. |
tracking_option_id_2 | string | Optional | The second tracking option identifier for filtering the Profit and Loss report. |
Requirements
Output
json— Response from the API endpoint 'getReportProfitAndLoss'.XeroApi.GetPurchaseOrderPdf
Retrieve a purchase order as a PDF using its ID. Use this tool to obtain a specific purchase order in PDF format by providing its unique ID. Useful for accessing purchase order details in a document format.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
purchase_order_id | string | Required | Unique identifier for a purchase order to retrieve it as a PDF. |
tenant_identifier | string | Required | The Xero identifier for the Tenant. Required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrderAsPdf'.XeroApi.GetQuoteAttachment
Retrieve a specific attachment from a quote by ID. Use this tool to retrieve a specific attachment from a quote by providing the unique Quote ID and Attachment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_content_type | string | Required | The MIME type of the attachment file to retrieve, such as image/jpeg or application/pdf. |
attachment_id | string | Required | Unique identifier for the attachment object you wish to retrieve. |
quote_id | string | Required | Unique identifier for a quote. Used to specify which quote the attachment belongs to. |
xero_tenant_identifier | string | Required | The unique Xero identifier for the tenant required to access the attachment. |
Requirements
Output
json— Response from the API endpoint 'getQuoteAttachmentById'.XeroApi.GetReceiptAttachments
Retrieve attachments for a specific expense claim receipt. Use this tool to obtain all attachments related to a specific expense claim receipt by providing the receipt ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
receipt_id | string | Required | Unique identifier for the expense claim receipt to retrieve attachments. |
tenant_identifier | string | Required | The unique Xero identifier for the tenant. Required to access tenant-specific data. |
Requirements
Output
json— Response from the API endpoint 'getReceiptAttachments'.XeroApi.GetRepeatingInvoice
Retrieve a specific repeating invoice using its unique ID. Use this tool to retrieve detailed information about a specific repeating invoice by providing its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repeating_invoice_id | string | Required | Unique identifier for the specific repeating invoice to retrieve. |
tenant_id | string | Required | Xero tenant identifier required to access a specific tenant's data. |
Requirements
Output
json— Response from the API endpoint 'getRepeatingInvoice'.XeroApi.GetRepeatingInvoiceHistory
Retrieve history record for a specific repeating invoice. Use this tool to access the historical details of a specified repeating invoice. Ideal for understanding past changes, updates, or notes associated with the invoice in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repeating_invoice_id | string | Required | Unique identifier for the specific repeating invoice to retrieve history for. |
xero_tenant_id | string | Required | The unique identifier for the Xero tenant associated with the repeating invoice. |
Requirements
Output
json— Response from the API endpoint 'getRepeatingInvoiceHistory'.XeroApi.GetRepeatingInvoices
Retrieve repeating invoices from Xero. Use this tool to get a list of repeating invoices from the Xero platform. It is helpful for managing and reviewing recurring billing information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The unique identifier for the tenant in Xero. Required to retrieve specific tenant data. |
filter_by_element | string | Optional | Filter invoices using a specific element condition. Use Xero's query language for filtering expressions. |
order_by_element | string | Optional | Specify the element to order the repeating invoices by. It accepts a string indicating the element to sort by. |
Requirements
Output
json— Response from the API endpoint 'getRepeatingInvoices'.XeroApi.GetTaxRateByTaxType
Retrieve a specific tax rate using a TaxType code. Use this tool to obtain a particular tax rate by providing a specific TaxType code. It is useful for retrieving tax rates in financial calculations or reports.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_type_code | string | Required | A valid TaxType code used to retrieve the specific tax rate. |
xero_tenant_identifier | string | Required | Xero identifier for the tenant. Required to specify which tenant's data is being accessed. |
Requirements
Output
json— Response from the API endpoint 'getTaxRateByTaxType'.XeroApi.GetTrackingCategories
Retrieve tracking categories and options from Xero. Use this tool to get tracking categories and their options from Xero. Useful for financial tracking and categorization tasks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | Unique identifier for the Xero tenant. Required to specify the tenant from which tracking categories should be retrieved. |
filter_conditions | string | Optional | String to filter tracking categories by specific conditions. |
include_archived_categories | boolean | Optional | Set to true to include categories and options with a status of ARCHIVED in the response. |
order_by_element | string | Optional | Specify the element to order the tracking categories and options by. |
Requirements
Output
json— Response from the API endpoint 'getTrackingCategories'.XeroApi.GetTrackingCategory
Retrieve tracking category details using its unique ID. Use this tool to obtain specific details about a tracking category and its options by providing a unique tracking category ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tracking_category_id | string | Required | Unique identifier for the tracking category to retrieve details for. |
xero_tenant_id | string | Required | A string representing the Xero identifier for the tenant. Required to access tenant-specific data. |
Requirements
Output
json— Response from the API endpoint 'getTrackingCategory'.XeroApi.GetTrialBalanceReport
Fetches the trial balance report from Xero. Use this tool to retrieve the trial balance report, which provides detailed financial information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The unique identifier for the Xero tenant to retrieve the trial balance report for. |
report_date | string | Optional | The specific date for the Trial Balance report in YYYY-MM-DD format. |
return_cash_basis_only | boolean | Optional | Set to true to return the trial balance report on a cash-only basis, false for accrual. |
Requirements
Output
json— Response from the API endpoint 'getReportTrialBalance'.XeroApi.GetXeroContactByNumber
Retrieve a contact from Xero by contact number. This tool retrieves details of a specific contact in a Xero organization using their contact number. It should be called when you need to access contact information by specifying the unique contact number.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_number | string | Required | The unique contact number to identify a Xero contact; max length 50 characters. |
xero_tenant_identifier | string | Required | Xero identifier for the tenant. It is required to specify which organization's data to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getContactByContactNumber'.XeroApi.GetXeroCurrencies
Retrieve currencies from your Xero organization. Use this tool to get a list of all currencies associated with your Xero organization. It is useful for financial tasks, reporting, or currency conversion needs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | Xero identifier for the tenant. Required to access organization-specific data. |
filter_criteria | string | Optional | A string to filter the currencies based on specific criteria, such as currency code or name. |
order_by | string | Optional | Specify the element to order the currencies by. Accepts a string corresponding to an element in the currency data. |
Requirements
Output
json— Response from the API endpoint 'getCurrencies'.XeroApi.GetXeroOrganisationDetails
Retrieves Xero organisation details. Use this tool to obtain detailed information about organisations in Xero. Ideal for accessing organisation data when required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | The unique identifier for the Xero tenant. This ID is required to specify which organisation's details to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getOrganisations'.XeroApi.RecordOverpaymentHistory
Creates a history record for a specific overpayment. Use this tool to add a history record to an existing overpayment in Xero. It helps in tracking changes or notes related to overpayments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
overpayment_id | string | Required | Unique identifier for an overpayment that you want to create a history record for. |
xero_tenant_id | string | Required | The unique identifier for the Xero tenant. Required to specify which tenant to apply the overpayment history record to. |
idempotency_key | string | Optional | A unique string (max 128 characters) for safely retrying requests without duplicate processing. |
Requirements
Output
json— Response from the API endpoint 'createOverpaymentHistory'.XeroApi.RecordReceiptHistory
Creates a history record for a specific receipt.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
receipt_id | string | Required | Unique identifier for a receipt used to create a history record. |
tenant_identifier | string | Required | Xero tenant identifier required for creating the receipt history. |
idempotency_key | string | Optional | String up to 128 characters to safely retry requests without risk of duplication. |
Requirements
Output
json— Response from the API endpoint 'createReceiptHistory'.XeroApi.RemoveContactFromGroup
Delete a specific contact from a contact group. This tool removes a specified contact from a contact group using unique identifiers for both the contact and the group. It should be called when there is a need to manage and update contact groups by removing contacts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_group_id | string | Required | Unique identifier for a contact group to specify which group the contact should be removed from. |
contact_identifier | string | Required | Unique identifier for a contact to be removed from the group. |
tenant_identifier | string | Required | Xero identifier for the tenant. Required for specifying the target tenant in requests. |
Requirements
Output
json— Response from the API endpoint 'deleteContactGroupContact'.XeroApi.RemoveContactsFromGroup
Removes all contacts from a specified contact group in Xero. Use this tool to delete all contacts from a specific contact group in Xero. Ideal for cleaning or reorganizing contact groups.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_group_id | string | Required | Unique identifier for the contact group to remove contacts from. |
xero_tenant_identifier | string | Required | Xero identifier for the specific tenant required to access its data. |
Requirements
Output
json— Response from the API endpoint 'deleteContactGroupContacts'.XeroApi.RemoveTrackingCategory
Deletes a specific tracking category from Xero. Use this tool to delete a particular tracking category identified by its ID in the Xero accounting system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tracking_category_id | string | Required | Unique identifier for the tracking category to be deleted in Xero. |
xero_tenant_identifier | string | Required | Xero identifier for the tenant. Required to specify which tenant's tracking category to delete. |
Requirements
Output
json— Response from the API endpoint 'deleteTrackingCategory'.XeroApi.Retrieve1099Reports
Retrieves 1099 tax reports. Use this tool to obtain 1099 tax reports from the Xero accounting service. It provides necessary financial data related to 1099 forms.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | The unique identifier for the tenant in Xero. Required to access the specific tenant's 1099 report data. |
report_year | string | Optional | The year for which the 1099 report should be retrieved, in YYYY format. |
Requirements
Output
json— Response from the API endpoint 'getReportTenNinetyNine'.XeroApi.RetrieveAccountAttachment
Retrieve a specific account attachment by ID. Use this tool to retrieve an attachment from a specific account by providing the unique attachment ID. It is useful when you need to access detailed information or content of an attachment associated with a particular account in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_unique_identifier | string | Required | Unique identifier for the Account object to retrieve the attachment from. |
attachment_id | string | Required | Unique identifier for the attachment you want to retrieve from an account. This ID is necessary to specify the exact attachment you need. |
mime_type_of_attachment | string | Required | The MIME type of the attachment file, such as image/jpg or application/pdf. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. Required to specify which tenant's account attachment you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getAccountAttachmentById'.XeroApi.RetrieveAccountAttachmentByFilename
Retrieve an attachment for a specific account by filename. This tool retrieves an attachment file from a specific account in Xero using the filename. It should be called when a user needs to access a specific account's attachment by providing the account ID and filename.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | Unique identifier for the Account object in Xero. |
attachment_file_name | string | Required | The name of the attachment to retrieve for a specific account. |
mime_type_of_attachment | string | Required | The MIME type of the attachment file to retrieve, such as image/jpg or application/pdf. |
tenant_identifier | string | Required | The unique Xero identifier for the Tenant. Required to access the specific tenant's attachments. |
Requirements
Output
json— Response from the API endpoint 'getAccountAttachmentByFileName'.XeroApi.RetrieveAccountAttachments
Retrieve attachments for a specified account. This tool is used to get attachments associated with a specific account by providing the account's unique ID. Useful for accessing documents or files linked to financial accounts in the Xero platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | Unique identifier for the account object to retrieve attachments from. |
tenant_identifier | string | Required | Xero identifier for the Tenant, used to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getAccountAttachments'.XeroApi.RetrieveAccountDetails
Retrieve chart of accounts using a unique account ID. Use this tool to fetch details of a specific account from the chart of accounts by providing a unique account ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | Unique identifier for the Account object to retrieve specific account details. |
xero_tenant_identifier | string | Required | Xero identifier for the tenant to retrieve the account details from. |
Requirements
Output
json— Response from the API endpoint 'getAccount'.XeroApi.RetrieveBankTransaction
Retrieve bank transaction details by ID. Use this tool to get details of a specific spent or received bank transaction by providing its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transaction_id | string | Required | Unique identifier for a specific bank transaction in Xero. |
xero_tenant_id | string | Required | The Xero identifier for the tenant (organization). Required to access the specific tenant's data. |
use_four_decimal_places | integer | Optional | Option to use four decimal places for unit amounts. Specify '4' to enable. |
Requirements
Output
json— Response from the API endpoint 'getBankTransaction'.XeroApi.RetrieveBankTransactionAttachment
Retrieve a specific attachment from a bank transaction. Use this tool to obtain specific attachments from a bank transaction by providing the unique BankTransaction ID and Attachment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the Attachment object. |
attachment_mime_type | string | Required | The mime type of the attachment file to retrieve, such as image/jpeg or application/pdf. |
bank_transaction_id | string | Required | Xero generated unique identifier for a bank transaction. |
xero_tenant_identifier | string | Required | Xero unique identifier for the Tenant. This is required to specify which organization data is to be accessed. |
Requirements
Output
json— Response from the API endpoint 'getBankTransactionAttachmentById'.XeroApi.RetrieveBankTransactionAttachments
Retrieve attachments from a specific bank transaction. Use this tool to obtain any attachments linked to a specific bank transaction. It accesses the attachments related to a given transaction ID within the Xero platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transaction_id | string | Required | Xero generated unique identifier for a bank transaction, used to retrieve corresponding attachments. |
xero_tenant_id | string | Required | The unique identifier for a Xero tenant, required to access specific tenant data. |
Requirements
Output
json— Response from the API endpoint 'getBankTransactionAttachments'.XeroApi.RetrieveBankTransactions
Retrieve spent or received money transactions from Xero. Use this tool to get a list of transactions where money was spent or received. This is useful for financial tracking and reporting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | Xero identifier for the Tenant, required to specify which account to access. |
filter_by_element | string | Optional | Specify criteria to filter transactions by any element. Use valid filter expressions based on transaction fields. |
modified_since_timestamp | string | Optional | Return records created or modified since this UTC timestamp (ISO 8601 format). |
order_transactions_by | string | Optional | Specify the element by which to order the transactions, such as date or amount. |
records_per_page | integer | Optional | Specify the number of records to retrieve per page. This controls the pagination size. |
transaction_page_number | integer | Optional | Specifies which page of up to 100 bank transactions to retrieve. |
use_four_decimal_places | integer | Optional | Indicate if unit amounts should use four decimal places (e.g., 4). |
Requirements
Output
json— Response from the API endpoint 'getBankTransactions'.XeroApi.RetrieveBankTransfer
Retrieve details of a specific bank transfer using its ID. This tool retrieves information about a specific bank transfer by using its unique bank transfer ID. It should be called when you need detailed information about a particular bank transfer within the Xero service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transfer_id | string | Required | The unique identifier for a bank transfer generated by Xero. |
tenant_id | string | Required | Xero identifier for the tenant. This is required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getBankTransfer'.XeroApi.RetrieveBankTransferAttachment
Retrieve a bank transfer attachment by file name. Use this tool to obtain a specific attachment related to a bank transfer by providing the file name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_name | string | Required | The name of the attachment file to retrieve from the bank transfer. |
attachment_mime_type | string | Required | The MIME type of the attachment file, such as 'image/jpg' or 'application/pdf'. |
bank_transfer_id | string | Required | Xero-generated unique identifier for a bank transfer. Required to specify which bank transfer's attachment is being retrieved. |
xero_tenant_identifier | string | Required | The unique identifier for the Xero tenant associated with the bank transfer. |
Requirements
Output
json— Response from the API endpoint 'getBankTransferAttachmentByFileName'.XeroApi.RetrieveBankTransferAttachments
Retrieve attachments from a specific bank transfer in Xero. Use this tool to get a list of attachments related to a particular bank transfer in Xero by providing the BankTransferID. Ideal for when you need access to documents associated with bank transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
bank_transfer_id | string | Required | Xero-generated unique identifier for a bank transfer. Required to retrieve associated attachments. |
tenant_identifier | string | Required | The unique Xero identifier for your tenant. This ID specifies which tenant the bank transfer belongs to. |
Requirements
Output
json— Response from the API endpoint 'getBankTransferAttachments'.XeroApi.RetrieveBankTransfers
Retrieve all bank transfers from Xero. Use this tool to access all bank transfer records from Xero. It helps in obtaining comprehensive transfer data for financial review or auditing purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | A unique string identifier for the Xero tenant to retrieve bank transfers from. |
filter_bank_transfers | string | Optional | String to filter bank transfer records by a specific element, such as status or date range. |
modified_since_timestamp | string | Optional | Filter records to only include those created or modified since this timestamp. Use ISO 8601 format (e.g., '2023-10-01T00:00:00Z'). |
order_by_element | string | Optional | Specify the field to order the bank transfer records by. Use the field names available in the Xero bank transfer dataset. |
Requirements
Output
json— Response from the API endpoint 'getBankTransfers'.XeroApi.RetrieveBatchPaymentHistory
Retrieve the history of a specific batch payment. Use this tool to access detailed history for a specific batch payment in Xero. Call this tool when needing to understand past actions, updates, or changes made to a batch payment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
batch_payment_id | string | Required | Unique identifier for the batch payment to retrieve its history. |
xero_tenant_id | string | Required | The unique identifier for the Xero tenant. Required to access specific tenant data. |
Requirements
Output
json— Response from the API endpoint 'getBatchPaymentHistory'.XeroApi.RetrieveBatchPayments
Retrieve batch payments for invoices. Use this tool to retrieve information about one or many batch payments associated with invoices. Useful for accessing payment details and histories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | Xero identifier for the Tenant required to access its specific batch payment data. |
filter_by_element | string | Optional | Apply a filter to the batch payments using any specified element. |
modified_since_timestamp | string | Optional | Timestamp to filter records modified or created since then. Format: ISO 8601 date and time. |
order_by_element | string | Optional | Specify the element to sort the batch payments by. The value should be a string representing the element. |
Requirements
Output
json— Response from the API endpoint 'getBatchPayments'.XeroApi.RetrieveBrandingTheme
Retrieve details of a specific branding theme. This tool retrieves information about a specific branding theme by using its unique ID. It is useful for accessing and displaying branding theme details in accounting or financial software.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branding_theme_id | string | Required | Unique identifier for a branding theme to retrieve its details. |
tenant_identifier | string | Required | The Xero identifier for the Tenant. This is required to specify which tenant's branding theme to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getBrandingTheme'.XeroApi.RetrieveBudgetDetails
Retrieve detailed information about a budget including lines. Use this tool to get information about a specified budget by its ID, including all associated budget lines.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
budget_identifier | string | Required | Unique identifier for budgets. Required to retrieve specific budget details including budget lines. |
tenant_identifier | string | Required | Xero identifier for the Tenant to specify which tenant's budget to retrieve. |
filter_end_date | string | Optional | Specifies the end date to filter the budget data. Use the format YYYY-MM-DD. |
filter_start_date | string | Optional | The start date from which to filter the budget details. Format must be YYYY-MM-DD. |
Requirements
Output
json— Response from the API endpoint 'getBudget'.XeroApi.RetrieveBudgets
Retrieve a list of budgets from Xero. Use this tool to obtain detailed budgeting information from the Xero platform, helping manage and analyze budget data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The unique Xero identifier for the tenant. Required for accessing specific tenant data. |
filter_by_budget_id | string | Optional | Filter to retrieve a specific budget by its BudgetID. |
filter_by_end_date | string | Optional | Specify the end date to filter the budgets. Use the format YYYY-MM-DD. |
filter_start_date | string | Optional | The start date to filter budgets until. Expected format is YYYY-MM-DD. |
Requirements
Output
json— Response from the API endpoint 'getBudgets'.XeroApi.RetrieveContactAttachment
Retrieve a specific contact attachment by ID. Use this tool to get a specific attachment from a contact by providing the unique attachment ID. Useful for accessing detailed attachment data linked to a contact in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the Attachment object from a contact in Xero. |
attachment_mime_type | string | Required | The MIME type of the attachment file (e.g., image/jpeg, application/pdf). |
contact_id | string | Required | Unique identifier for a Contact in Xero to retrieve a specific attachment. |
tenant_identifier | string | Required | The unique identifier for the tenant in Xero to access specific data connected to a tenant account. |
Requirements
Output
json— Response from the API endpoint 'getContactAttachmentById'.XeroApi.RetrieveContactGroup
Retrieve a specific contact group by ID. Call this tool to get details of a particular contact group using its unique ID on Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_group_id | string | Required | Unique identifier for a Contact Group in Xero. Use this to retrieve specific group details. |
xero_tenant_id | string | Required | Identifier for the Xero tenant needed to access specific tenant data. |
Requirements
Output
json— Response from the API endpoint 'getContactGroup'.XeroApi.RetrieveContactGroups
Retrieve contact group IDs and names from Xero. Use this tool to get a list of contact groups from Xero, including each group's ID and name. Ideal for identifying specific contact groups and managing contacts effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | Xero identifier for the Tenant. Required to access the correct tenant's contact groups. |
filter_criteria | string | Optional | A string to filter contact groups based on specified criteria, using any element. |
order_by | string | Optional | Specify the criteria to order the contact groups by. It can be any element to sort the results accordingly. |
Requirements
Output
json— Response from the API endpoint 'getContactGroups'.XeroApi.RetrieveCreditNote
Retrieve a credit note using its unique ID. Use this tool to get detailed information about a specific credit note by providing its unique ID. Ideal for obtaining precise credit note data from your Xero account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_note_id | string | Required | Unique identifier for the credit note to retrieve details from Xero. |
tenant_identifier | string | Required | The unique Xero identifier for the tenant associated with the credit note. It is required to specify which tenant's data to access. |
use_four_decimal_places | integer | Optional | Specify if four decimal places should be used for unit amounts. Default is false. |
Requirements
Output
json— Response from the API endpoint 'getCreditNote'.XeroApi.RetrieveCreditNoteAttachment
Retrieve a specific credit note attachment by file name. Use this tool to get a particular attachment from a specific credit note using the file name as a reference. It is helpful when you need to access or verify document details associated with a credit note.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_name | string | Required | The name of the attachment to be retrieved from the credit note (e.g., invoice.pdf). |
attachment_mime_type | string | Required | The MIME type of the attachment file to retrieve, such as 'image/jpg' or 'application/pdf'. |
credit_note_id | string | Required | Unique identifier for a Credit Note. Use this ID to specify which credit note's attachment you want to retrieve. |
xero_tenant_identifier | string | Required | Unique identifier for the Xero Tenant. Required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getCreditNoteAttachmentByFileName'.XeroApi.RetrieveDraftExpenseClaimReceipt
Retrieve a draft expense claim receipt using its ID. Use this tool to retrieve detailed information about a specific draft expense claim receipt by providing its unique receipt ID. Useful for reviewing or processing draft receipts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
receipt_id | string | Required | The unique identifier for the draft expense claim receipt to retrieve. |
tenant_identifier | string | Required | The unique Xero identifier for the tenant. Required to specify which organization's data is being accessed. |
use_four_decimal_places | integer | Optional | Set to true to use four decimal places for unit amounts, false for standard. |
Requirements
Output
json— Response from the API endpoint 'getReceipt'.XeroApi.RetrieveExecutiveSummaryReport
Retrieve an executive summary report for financial insights. Use this tool to get an executive summary report, which provides financial insights and key metrics for business decision-making.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | The Xero identifier for the tenant. Required to specify which tenant's data should be retrieved. |
report_date | string | Optional | The date for the Bank Summary report in the format YYYY-MM-DD (e.g., 2018-03-31). |
Requirements
Output
json— Response from the API endpoint 'getReportExecutiveSummary'.XeroApi.RetrieveExpenseClaim
Retrieve details of a specific expense claim by ID. Use this tool to obtain details about a specific expense claim using its unique ID. This is useful for reviewing or verifying expense claims in your records.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
expense_claim_id | string | Required | Unique identifier for an expense claim to retrieve its details. |
xero_tenant_id | string | Required | Xero tenant identifier for the specific business or organization you are retrieving the expense claim from. |
Requirements
Output
json— Response from the API endpoint 'getExpenseClaim'.XeroApi.RetrieveExpenseClaimHistory
Retrieve the history of a specific expense claim. Use this tool to obtain history records for a specific expense claim using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
expense_claim_id | string | Required | Unique identifier for retrieving the specific expense claim history. |
xero_tenant_id | string | Required | Xero identifier for the tenant. This is required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getExpenseClaimHistory'.XeroApi.RetrieveExpenseClaims
Fetches expense claims from Xero. This tool should be called to retrieve detailed expense claims data from Xero. It can be used to review or analyze expenses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | The unique identifier for the Xero tenant required to specify which organization's data to retrieve. |
filter_by_element | string | Optional | Apply a filter based on specific elements in the expense claims. |
modified_since_timestamp | string | Optional | Retrieve records created or modified since this timestamp in ISO 8601 format (e.g., '2023-10-04T00:00:00Z'). |
order_by | string | Optional | Specify the element by which to order the expense claims, such as date or amount. |
Requirements
Output
json— Response from the API endpoint 'getExpenseClaims'.XeroApi.RetrieveFullChartOfAccounts
Retrieves the full chart of accounts from Xero. Use this tool to obtain the complete chart of accounts from Xero, which includes all accounting categories and their details. It is useful for analyzing financial structures within the Xero platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | Unique identifier for the Xero tenant to retrieve its accounts. |
filter_by_attribute | string | Optional | Filter accounts by specific attributes or conditions using string syntax. |
only_modified_since_timestamp | string | Optional | Specify a timestamp to return only records created or modified since that time. The timestamp should be in ISO 8601 format. |
order_by_element | string | Optional | Specify a field to order the returned accounts (e.g., 'Name' or 'AccountType'). |
Requirements
Output
json— Response from the API endpoint 'getAccounts'.XeroApi.RetrieveInvoiceAttachmentById
Retrieve a specific invoice attachment by ID. Use this tool to obtain a specific attachment from an invoice or purchase bill using its unique attachment ID in Xero. Call this tool when you need to access or review an attachment related to an invoice.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the attachment object in Xero. |
attachment_mime_type | string | Required | The MIME type of the attachment file, e.g., image/jpg or application/pdf. |
invoice_id | string | Required | The unique identifier for the invoice to retrieve the attachment from. |
tenant_identifier | string | Required | Xero identifier for the tenant. Required to specify the tenant from which the attachment is being retrieved. |
Requirements
Output
json— Response from the API endpoint 'getInvoiceAttachmentById'.XeroApi.RetrieveInvoiceAttachments
Retrieve attachments for a specific invoice or bill. This tool is used to obtain attachments related to a particular invoice or purchase bill from Xero. Call this tool when you need to access documents or files attached to a specific invoice.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_id | string | Required | Unique identifier for the invoice to retrieve attachments from. |
tenant_identifier | string | Required | Xero identifier for the Tenant that owns the invoice. |
Requirements
Output
json— Response from the API endpoint 'getInvoiceAttachments'.XeroApi.RetrieveInvoiceHistory
Retrieve history of a specific invoice. Retrieves history records for a specific invoice using its Invoice ID. This tool is useful for tracking changes and updates made to an invoice over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_id | string | Required | Unique identifier for the invoice to retrieve its history. |
tenant_identifier | string | Required | Xero identifier for the tenant. This is required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getInvoiceHistory'.XeroApi.RetrieveInvoicePayment
Retrieve specific payment details using a payment ID. This tool retrieves details of a specific payment associated with invoices and credit notes using a unique payment ID. It should be called when there is a need to access information about a particular payment in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_id | string | Required | Unique identifier for the payment, used to retrieve specific payment details in Xero. |
xero_tenant_id | string | Required | Xero identifier for the tenant. This is required to specify which organization's data to access. |
Requirements
Output
json— Response from the API endpoint 'getPayment'.XeroApi.RetrieveInvoicePdf
Retrieve an invoice or purchase bill as a PDF. This tool retrieves an invoice or purchase bill in PDF format using the invoice ID. It is useful when you need a downloadable version of an invoice from Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_id | string | Required | Unique identifier for the invoice to retrieve as a PDF from Xero. |
tenant_identifier | string | Required | The unique Xero identifier for the tenant. This is required to specify the account from which to retrieve the invoice PDF. |
Requirements
Output
json— Response from the API endpoint 'getInvoiceAsPdf'.XeroApi.RetrieveInvoices
Retrieve sales invoices or purchase bills from Xero. Use this tool to retrieve detailed information about sales invoices or purchase bills from Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | Unique identifier for a Xero tenant to retrieve invoices specific to that tenant. |
filter_by_condition | string | Optional | Filter using a condition expression defined on any element, similar to a SQL WHERE clause. |
filter_by_created_by_my_app | boolean | Optional | Set to true to retrieve only invoices created by your app. |
filter_by_invoice_numbers | array<string> | Optional | Filter results by providing a list of invoice numbers. Each item should be a string representing one invoice number. |
filter_by_statuses | array<string> | Optional | Filter invoices by a list of statuses for improved response times. Use explicit parameters instead of OR conditions. |
filter_contact_ids | array<string> | Optional | Comma-separated list of ContactIDs to filter invoices. |
include_archived_invoices | boolean | Optional | Set to true to include invoices with a status of ARCHIVED in the response. |
invoice_ids | array<string> | Optional | Comma-separated list of Invoice IDs to filter results. |
modified_since_timestamp | string | Optional | Return only records created or modified since this timestamp. Use the format 'YYYY-MM-DDTHH:MM:SS'. |
order_by | string | Optional | Specify the criteria for ordering invoices, such as date or amount. |
page_number | integer | Optional | Specify the page number to retrieve. Up to 100 invoices per page can be returned. |
records_per_page | integer | Optional | Specify the number of invoice records to retrieve per page. |
retrieve_summary_only | boolean | Optional | Set to true to retrieve a smaller, lightweight version of the response for quicker API calls, excluding computation-heavy fields. |
search_term | string | Optional | A case-insensitive search parameter for fields like InvoiceNumber and Reference. |
unit_decimal_places | integer | Optional | Specify the number of decimal places for unit amounts, e.g., 4 for four decimal places. |
Requirements
Output
json— Response from the API endpoint 'getInvoices'.XeroApi.RetrieveJournalAttachment
Retrieve a specific attachment from a manual journal using its ID. Use this tool to obtain a particular attachment linked to a specific manual journal by providing the unique attachment ID. Ideal for accessing relevant documents or files associated with journal entries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Provide the unique identifier for the attachment object to retrieve it from a manual journal. |
attachment_mime_type | string | Required | Specify the mime type of the attachment (e.g., image/jpg, application/pdf) to retrieve. |
manual_journal_id | string | Required | Unique identifier for the manual journal from which to retrieve the attachment. |
xero_tenant_id | string | Required | The unique Xero identifier for the tenant. Required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getManualJournalAttachmentById'.XeroApi.RetrieveJournalAttachments
Retrieve attachments for a specific manual journal. Use this tool to retrieve attachments associated with a given manual journal in Xero. Ideal for accessing or reviewing documents linked to journal entries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
manual_journal_id | string | Required | The unique identifier for a specific manual journal to retrieve its attachments. |
tenant_id | string | Required | The unique Xero identifier for the tenant to access the manual journal attachments. |
Requirements
Output
json— Response from the API endpoint 'getManualJournalAttachments'.XeroApi.RetrieveJournalByNumber
Retrieve a specific journal by its unique number. Use this tool to obtain detailed information about a particular journal entry using its unique journal number.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
journal_number | integer | Required | The unique number identifying the journal entry to retrieve. |
tenant_identifier | string | Required | The unique identifier for a Xero tenant to specify the context for the journal retrieval. |
Requirements
Output
json— Response from the API endpoint 'getJournalByNumber'.XeroApi.RetrieveLinkedTransactions
Retrieve linked transactions from Xero. Use this tool to get linked transactions, such as billable expenses, from the Xero platform. Call it when you need details about expenses that are linked or billable in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The Xero identifier for a specific tenant. Required for identifying the tenant whose linked transactions are being retrieved. |
filter_by_contact_id | string | Optional | Filter results by the customer's ContactID to get linked transactions for a specific customer. |
filter_by_status | string | Optional | Filter linked transactions by status when combined with ContactID. Retrieves transactions associated with a customer based on this status. |
filter_by_target_transaction_id | string | Optional | Filter linked transactions by TargetTransactionID to get those allocated to a specific ACCREC invoice. |
linked_transaction_id | string | Optional | The Xero identifier for a Linked Transaction to retrieve specific billable expenses. |
page_number | integer | Optional | Specify the page number to retrieve in paginated results, starting from 1. |
source_transaction_id | string | Optional | Filter by SourceTransactionID to get linked transactions from a specific ACCPAY invoice. |
Requirements
Output
json— Response from the API endpoint 'getLinkedTransactions'.XeroApi.RetrieveManualJournal
Retrieve details of a specific manual journal. Use this tool to obtain information about a particular manual journal by its ID. Ideal for users needing specific journal entry details from Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
manual_journal_id | string | Required | Unique identifier for the manual journal you want to retrieve. |
xero_tenant_id | string | Required | The unique identifier for a Xero tenant. Required to access tenant-specific data. |
Requirements
Output
json— Response from the API endpoint 'getManualJournal'.XeroApi.RetrieveManualJournals
Retrieve manual journals from Xero. Use this tool to get a list of manual journals from Xero, typically when needing insights into financial entries or audits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The unique Xero identifier for the Tenant to retrieve manual journals from. |
filter_criteria | string | Optional | Filter manual journals based on specified criteria, such as date or amount. |
modified_since_timestamp | string | Optional | Retrieve records created or modified since this timestamp (ISO 8601 format). |
order_by_element | string | Optional | Specify the element to order the results by. Use field names like date, amount, etc. |
page_number | integer | Optional | The page number to retrieve, e.g., page=1. Returns up to 100 manual journals per call. |
records_per_page | integer | Optional | Specify the number of manual journal records to retrieve per page. |
Requirements
Output
json— Response from the API endpoint 'getManualJournals'.XeroApi.RetrieveOnlineInvoiceUrl
Retrieve a URL for viewing an online invoice. Use this tool to obtain a direct URL for accessing a specific online invoice based on its InvoiceID. The tool helps retrieve online invoice links for quick viewing and sharing.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_identifier | string | Required | Unique identifier for the invoice to retrieve its online URL. |
xero_tenant_id | string | Required | Xero tenant identifier needed to retrieve the correct online invoice. |
Requirements
Output
json— Response from the API endpoint 'getOnlineInvoice'.XeroApi.RetrieveOverpayments
Retrieve overpayments from the accounting system. Use this tool to access and retrieve a list of overpayments recorded in the Xero accounting system. This is useful for financial analysis and reconciliation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tenant_identifier | string | Required | The unique identifier for the Xero tenant to retrieve overpayments for. |
filter_criteria | string | Optional | Filter overpayments by a specific element or condition. Use syntax like "Property=value" for filtering. |
order_by_element | string | Optional | Specify the element by which to order the retrieved overpayments. Accepts any valid field. |
page_number | integer | Optional | The page number for retrieving overpayments. Up to 100 overpayments will be returned per page. |
records_modified_since | string | Optional | Return records created or modified after the specified timestamp in ISO 8601 format. |
records_per_page | integer | Optional | Specify the number of records to retrieve per page. Determines the page size for the results. |
unit_decimal_places | integer | Optional | The number of decimal places to use for unit amounts. Accepts up to four decimals. |
Requirements
Output
json— Response from the API endpoint 'getOverpayments'.XeroApi.RetrievePaymentHistory
Retrieve the history records of a specific payment. Use this tool to obtain historical records related to a specific payment, including updates and changes made over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_identifier | string | Required | Unique identifier for a specific payment to retrieve its history. |
tenant_identifier | string | Required | Xero identifier for the tenant. Used to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getPaymentHistory'.XeroApi.RetrievePaymentServices
Retrieve available payment services from Xero. Use this tool to obtain a list of payment services available in Xero. It should be called when you need to access or display payment service options.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | Unique identifier for the Xero tenant. Required to retrieve specific payment services for the tenant. |
Requirements
Output
json— Response from the API endpoint 'getPaymentServices'.XeroApi.RetrievePoAttachmentByFilename
Retrieve a purchase order attachment by filename. Use this tool to get a specific attachment from a purchase order in Xero by providing the filename. It's useful for accessing documents linked to purchase orders.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_name | string | Required | Name of the attachment file to be retrieved from the purchase order. |
attachment_mime_type | string | Required | The MIME type of the attachment file to retrieve, e.g., image/jpg or application/pdf. |
purchase_order_id | string | Required | Unique identifier for the purchase order you want to retrieve the attachment from. |
xero_tenant_identifier | string | Required | Xero unique identifier for the tenant organization. Required to specify which organization's data to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrderAttachmentByFileName'.XeroApi.RetrievePrepayments
Retrieve prepayment details from Xero. Use this tool to fetch prepayment information from the Xero API, providing insights into prepayment transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | The unique Xero identifier for the Tenant. Required for specifying which account's prepayments to retrieve. |
filter_condition | string | Optional | Provide a filter condition to specify which prepayments to retrieve. |
modified_since_timestamp | string | Optional | Only return records created or modified since the specified timestamp (e.g., '2023-10-01T00:00:00Z'). |
order_criteria | string | Optional | Specifies the order of elements. Use field names for custom sorting, such as 'Date ASC' or 'Amount DESC'. |
page_number | integer | Optional | Specify the page number to retrieve, up to 100 prepayments per page. |
records_per_page | integer | Optional | The number of prepayment records to retrieve per page. This controls how many results are returned in a single call. |
unit_decimal_places | integer | Optional | Specify the number of decimal places (e.g., 4) for unit amounts. Use for precise calculations. |
Requirements
Output
json— Response from the API endpoint 'getPrepayments'.XeroApi.RetrievePurchaseOrder
Retrieve details of a specific purchase order by ID. Use this tool to obtain information about a particular purchase order by specifying its unique ID. Ideal for retrieving order details when managing inventory or processing transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
purchase_order_id | string | Required | Unique identifier for a purchase order. Required to retrieve specific purchase order details. |
xero_tenant_id | string | Required | Xero identifier for the tenant. This is required to specify which tenant's purchase order to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrder'.XeroApi.RetrievePurchaseOrderAttachments
Retrieve attachments for a specific purchase order. This tool retrieves all attachments associated with a given purchase order in Xero. It should be called when you need to access or review files linked to a specific purchase order.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
purchase_order_id | string | Required | Unique identifier for a purchase order to retrieve its attachments. |
xero_tenant_id | string | Required | The unique Xero identifier for the tenant linked to the purchase order. Required to authenticate and access tenant-specific data. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrderAttachments'.XeroApi.RetrievePurchaseOrderByNumber
Fetches a purchase order using its unique number. Use this tool to retrieve detailed information about a specific purchase order by providing its unique order number.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
purchase_order_number | string | Required | Unique identifier for the purchase order to be fetched. |
xero_tenant_id | string | Required | Unique identifier for the Xero tenant. Required to specify the account from which to retrieve the purchase order. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrderByNumber'.XeroApi.RetrievePurchaseOrderHistory
Retrieve the history of a specific purchase order. Use this tool to obtain historical details for a specified purchase order by its ID. It provides insights into changes and updates made to the order over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
purchase_order_id | string | Required | Unique identifier for the purchase order to retrieve its history. |
tenant_identifier | string | Required | Xero identifier for the tenant, required to specify which organization data belongs to. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrderHistory'.XeroApi.RetrievePurchaseOrders
Retrieve purchase orders from Xero. Use this tool to obtain purchase orders from Xero. Call when you need a list of purchase orders with details such as order status, dates, and amounts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | Unique identifier for the Xero tenant to access specific organization's data. |
filter_by_end_date | string | Optional | Filter purchase orders by end date (format: YYYY-MM-DD). |
filter_by_start_date | string | Optional | Specify the start date for filtering purchase orders. Use format 'YYYY-MM-DD'. |
filter_by_status | string | Optional | Filter purchase orders by status. Accepted values are: 'DRAFT', 'SUBMITTED', 'AUTHORISED', 'BILLED', 'DELETED'. |
modified_since_timestamp | string | Optional | Timestamp to filter records created or modified since this time. Use ISO 8601 format (e.g., '2023-01-01T00:00:00Z'). |
order_by_element | string | Optional | Specifies the element by which to sort the purchase orders, such as date or status. Accepts any valid field name. |
page_number | integer | Optional | Specifies the page of results to retrieve. Increment to access subsequent pages of purchase orders. |
records_per_page | integer | Optional | Specify the number of purchase order records to retrieve per page. |
Requirements
Output
json— Response from the API endpoint 'getPurchaseOrders'.XeroApi.RetrieveQuote
Retrieve details of a specific quote by ID. Call this tool to obtain detailed information about a specific quote using its unique QuoteID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | Unique identifier for a quote to retrieve its details. |
xero_tenant_id | string | Required | Provide the Xero identifier for the tenant to specify the account context. |
Requirements
Output
json— Response from the API endpoint 'getQuote'.XeroApi.RetrieveQuoteAttachmentByFilename
Retrieve an attachment from a quote using filename. Call this tool to obtain a specific attachment from a quote by specifying the filename. Ideal for accessing quote-related documents stored in the Xero system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_filename | string | Required | Name of the attachment file to retrieve from the quote. |
attachment_mime_type | string | Required | The MIME type of the attachment file (e.g., image/jpg, application/pdf). |
quote_identifier | string | Required | Unique identifier for a Quote. Use this to specify which quote's attachment you want to retrieve. |
xero_tenant_identifier | string | Required | Xero tenant's unique identifier. Required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getQuoteAttachmentByFileName'.XeroApi.RetrieveQuoteAttachments
Retrieve attachments for a specific quote in Xero. This tool retrieves all attachments related to a specified quote in Xero. It should be called when you need to access or view the files linked to a given quote ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | Unique identifier for a quote in Xero to retrieve its attachments. |
tenant_identifier | string | Required | The unique Xero tenant identifier required to retrieve the quote attachments. |
Requirements
Output
json— Response from the API endpoint 'getQuoteAttachments'.XeroApi.RetrieveQuoteHistory
Retrieves history records of a specific quote. Use this tool to get the history records for a specific quote using its ID. Ideal for tracking changes and updates to the quote over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | Unique identifier for the quote to retrieve its history records. |
xero_tenant_identifier | string | Required | The unique identifier for the Xero tenant. Required to specify which tenant's quote history to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getQuoteHistory'.XeroApi.RetrieveQuotePdf
Retrieve a specific quote as a PDF file using the quote ID. This tool fetches a specific quote as a PDF using its unique ID. Call this when you need to obtain the PDF version of a quote for viewing, sharing, or archiving.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | A unique identifier for the quote to retrieve as a PDF. |
tenant_identifier | string | Required | The unique Xero tenant identifier required to access the specific quote. |
Requirements
Output
json— Response from the API endpoint 'getQuoteAsPdf'.XeroApi.RetrieveReceiptAttachment
Retrieve a specific attachment from an expense receipt. Use this tool to obtain a specific attachment from an expense claim receipt by providing the unique attachment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the attachment object you want to retrieve. |
attachment_mime_type | string | Required | Specify the MIME type of the attachment, e.g., 'image/jpg' or 'application/pdf'. |
receipt_id | string | Required | Unique identifier for a receipt used to retrieve its attachment. |
xero_tenant_id | string | Required | Xero identifier for the Tenant. Required to specify which tenant's data to access. |
Requirements
Output
json— Response from the API endpoint 'getReceiptAttachmentById'.XeroApi.RetrieveReceiptHistory
Retrieve detailed history for a specific receipt. This tool retrieves the history record of a specific receipt from the Xero service. It should be called when users want to review or analyze the history or changes associated with a receipt.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
receipt_id | string | Required | Unique identifier for the receipt to retrieve its history. |
tenant_identifier | string | Required | The unique Xero identifier for the tenant associated with the receipt. |
Requirements
Output
json— Response from the API endpoint 'getReceiptHistory'.XeroApi.RetrieveRepeatingInvoiceAttachment
Retrieve a repeating invoice attachment by file name. Use this tool to obtain a specific attachment from a repeating invoice using the file name. Ideal for accessing invoice-related files directly from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_file_name | string | Required | The name of the attachment file you wish to retrieve from the repeating invoice. |
attachment_mime_type | string | Required | Specify the MIME type of the attachment file to retrieve, such as image/jpg or application/pdf. |
repeating_invoice_id | string | Required | Unique identifier for a specific repeating invoice. This is necessary to locate the invoice attachment. |
xero_tenant_identifier | string | Required | Xero tenant ID needed to identify the specific organization in Xero. |
Requirements
Output
json— Response from the API endpoint 'getRepeatingInvoiceAttachmentByFileName'.XeroApi.RetrieveRepeatingInvoiceAttachmentById
Retrieve a specific attachment from a repeating invoice. Use this tool to get a particular attachment from a specific repeating invoice in Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier for the attachment object you want to retrieve from the repeating invoice. |
attachment_mime_type | string | Required | The MIME type of the attachment file, such as image/jpg or application/pdf. |
repeating_invoice_id | string | Required | Unique identifier for a Repeating Invoice in Xero system. |
xero_tenant_identifier | string | Required | Xero identifier for the tenant needed to retrieve the repeating invoice attachment. |
Requirements
Output
json— Response from the API endpoint 'getRepeatingInvoiceAttachmentById'.XeroApi.RetrieveRepeatingInvoiceAttachments
Retrieve attachments from a specified repeating invoice. This tool retrieves attachments from a specific repeating invoice in Xero. Use it to access files associated with recurring invoices.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repeating_invoice_id | string | Required | Unique identifier for a repeating invoice in Xero. Needed to retrieve the corresponding attachments. |
xero_tenant_identifier | string | Required | A unique identifier for the Xero tenant. Required to access specific tenant data. |
Requirements
Output
json— Response from the API endpoint 'getRepeatingInvoiceAttachments'.XeroApi.RetrieveSalesQuotes
Retrieve sales quotes from Xero. This tool fetches sales quotes from Xero, providing details of quotes issued. Use it to obtain current sales quotations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | Xero tenant identifier for accessing the specific account's data. |
contact_id | string | Optional | Filter the sales quotes by specifying the contact ID to which they belong. |
expiry_date_after | string | Optional | Filter to retrieve quotes expiring after the specified date. Format: YYYY-MM-DD. |
filter_date_to | string | Optional | Filter for sales quotes before a specified date in YYYY-MM-DD format. |
filter_expiry_date_before | string | Optional | Filter for quotes expiring before a specified date (YYYY-MM-DD). |
filter_start_date | string | Optional | Filter quotes issued after a specified date in YYYY-MM-DD format. |
modified_since_timestamp | string | Optional | Retrieve records created or modified after this timestamp. |
order_by_element | string | Optional | Specify the element to order the sales quotes by. |
page_number | integer | Optional | The page number to retrieve, allowing pagination through quotes. Each page returns up to 100 quotes. |
quote_number_filter | string | Optional | Filter sales quotes by specifying the quote number (e.g., QU-0001). |
quote_status | string | Optional | Filter quotes by their status (e.g., DRAFT, SENT). |
Requirements
Output
json— Response from the API endpoint 'getQuotes'.XeroApi.RetrieveSpecificJournal
Retrieve a specific journal using its unique ID. Call this tool to get detailed information about a particular journal by specifying its unique identifier. Useful for accessing specific journal entries in the Xero system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
journal_id | string | Required | Unique identifier for the journal to be retrieved. |
xero_tenant_identifier | string | Required | A unique identifier for the Xero tenant. Required to specify which tenant's journal should be accessed. |
Requirements
Output
json— Response from the API endpoint 'getJournal'.XeroApi.RetrieveSpecificOverpayment
Retrieve details of a specific overpayment by ID. Use this tool to obtain information about a specific overpayment using its unique identifier. Ideal for accessing precise overpayment records within Xero.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
overpayment_id | string | Required | Unique identifier for the overpayment to be retrieved. This ID is required to fetch the specific details of the overpayment from Xero. |
xero_tenant_identifier | string | Required | The unique identifier for the Xero tenant. Required to specify which organization's data to access. |
Requirements
Output
json— Response from the API endpoint 'getOverpayment'.XeroApi.RetrieveSpecificReport
Retrieve a specific report using a ReportID. This tool fetches a specific report from Xero using a unique ReportID. It should be called when detailed information about a particular report is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
report_id | string | Required | Unique identifier for a specific report to be retrieved. |
xero_tenant_id | string | Required | Xero identifier for the Tenant. This is required to specify which tenant's data is being accessed. |
Requirements
Output
json— Response from the API endpoint 'getReportFromId'.XeroApi.RetrieveSpecificUser
Retrieve details of a specific user from Xero. Use this tool to obtain information about a specific user by providing their UserID. It is called when user details from Xero are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | Unique identifier for a User in Xero system. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. Use this to specify which tenant the user belongs to. |
Requirements
Output
json— Response from the API endpoint 'getUser'.XeroApi.RetrieveTaxRates
Retrieve tax rates from Xero. Use this tool to obtain the current tax rates available in Xero. It should be called when you need up-to-date tax rate information for financial calculations or reporting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | A unique identifier for the Xero tenant. This is required to access tenant-specific data. |
filter_by_element | string | Optional | Apply a filter to the tax rates by specifying an element condition (e.g. 'Status=="ACTIVE"'). |
order_by_element | string | Optional | Specify the element to order the tax rates by. Provide any valid field or attribute name. |
Requirements
Output
json— Response from the API endpoint 'getTaxRates'.XeroApi.RetrieveUniqueReportsList
Retrieve a list of unique reports from Xero. Use this tool to obtain a list of an organization's unique reports from Xero, each requiring a UUID for fetching.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | The unique identifier for the Xero tenant to retrieve reports for. |
Requirements
Output
json— Response from the API endpoint 'getReportsList'.XeroApi.RetrieveXeroContact
Retrieve specific contact information from Xero. Use this tool to retrieve details of a specific contact in a Xero organization by providing a unique contact ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | Provide the unique identifier for the contact to retrieve their information from Xero. |
xero_tenant_identifier | string | Required | The unique identifier for the tenant in Xero, required to retrieve contact details. |
Requirements
Output
json— Response from the API endpoint 'getContact'.XeroApi.RetrieveXeroItem
Retrieve a specific item from Xero using its ID. Call this tool when you need to fetch details about a particular item from Xero by providing its unique item ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
item_identifier | string | Required | The unique identifier for the item in Xero. This is required to retrieve specific item details. |
xero_tenant_identifier | string | Required | Xero identifier for the Tenant. This is required to specify which tenant's data should be accessed. |
use_unit_decimal_places | integer | Optional | Specify the number of unit decimal places to use, e.g., 4 for four decimal places in unit amounts. |
Requirements
Output
json— Response from the API endpoint 'getItem'.XeroApi.RetrieveXeroOrganisationActions
Retrieve key actions allowed in Xero organisation. Use this tool to get a list of the key actions your application is allowed to perform within a connected Xero organisation. This helps in understanding the permissions available.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_id | string | Required | Xero identifier for the tenant to specify which organisation's actions to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getOrganisationActions'.XeroApi.RetrieveXeroUsers
Retrieve users from the Xero platform. Call this tool to fetch a list of users from the Xero platform when user information or management is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
xero_tenant_identifier | string | Required | Xero identifier for the specific tenant. This is required to specify the tenant for which users are to be retrieved. |
filter_by_criteria | string | Optional | A string to filter users based on specific criteria in Xero. |
modified_since_timestamp | string | Optional | Return only records created or modified since this timestamp, formatted as an ISO 8601 string. |
order_by_element | string | Optional | Specify the element to order the retrieved users by, such as name or date. |
Requirements
Output
json— Response from the API endpoint 'getUsers'.XeroApi.SetupConversionDetails
Set up chart of accounts and conversion details in Xero. Call this tool to configure the chart of accounts, conversion date, and balances in Xero. Useful for initializing financial data during setup. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
tenant_identifier | string | Optional | The unique identifier for the tenant in Xero. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
idempotency_key | string | Optional | A unique key to safely retry requests without duplicate processing. Max 128 characters. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postSetup'.