Skip to main content
Connector guides

Connect Xero

Xero is cloud accounting. It holds an organization's contacts, invoices and bills, bank transactions, chart of accounts and reports, and in Australia, New Zealand and the United Kingdom it also runs…

Written By Christopher Scaminaci

Last updated About 3 hours ago

Xero is cloud accounting. It holds an organization's contacts, invoices and bills, bank transactions, chart of accounts and reports, and in Australia, New Zealand and the United Kingdom it also runs payroll. Many MSPs keep their own books in Xero, and an MSP that does bookkeeping for clients keeps each client's books as a separate Xero organization. StackJack talks to Xero through the same developer interface Xero publishes for integrations.

Connecting Xero to StackJack gives your AI assistant a family of xero_ MCP tools. MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

  • Answer money questions from the books: profit and loss, balance sheet, trial balance, aged receivables and payables, bank summary, budget summary and the tax reports
  • See who owes what by reading invoices, bills, credit notes, quotes, repeating invoices, payments, prepayments and overpayments, and the contacts behind them
  • Look up the reference data every entry needs: the chart of accounts, tax rates, tracking categories, currencies, items, branding themes and the organization record itself
  • Follow the cash through bank transactions, bank transfers and batch payments
  • Check purchasing and the ledger: purchase orders, expense claims, receipts and manual journals
  • Read the history and attachments of almost any record, and get a short-lived link to download an attached file or a document PDF
  • Look at fixed assets, the file library and projects with their tasks and time entries
  • Read payroll for the Australia, New Zealand and United Kingdom payroll products: employees, leave, pay runs, payslips, timesheets, pay items, super and settings

It can also make changes, on the Pro tier:

  • Raise and change the paperwork: create invoices, bills, credit notes, quotes, repeating invoices and purchase orders, and update, void or delete them
  • Record and allocate money: payments, batch payments, prepayment and overpayment allocations, credit note allocations, bank transactions, bank transfers and manual journals
  • Keep the books tidy: contacts and contact groups, accounts, tax rates, tracking categories and options, items, currencies and linked transactions
  • Attach files and add history notes to records, and upload to the file library
  • Run projects: create projects, tasks and time entries
  • Look after payroll: create and change employees, leave, pay items, timesheets and pay runs, and approve timesheets and leave

Reading is free. Every change needs the Pro tier. Anything that records money, deletes, voids, emails, replaces an attachment or changes how an employee is paid is labelled, so your AI assistant asks before running it.

Before you start: what Xero needs from you

StackJack connects to Xero through a Custom Connection, which is the way Xero offers for a connection that belongs to one organization. It is the route Xero itself recommends for AI clients. Three things have to be true first:

  • The organization is in Australia, New Zealand, the United Kingdom or the United States. Xero offers Custom Connections only in those four countries. For an organization anywhere else this connector cannot be used.
  • The organization has a Custom Connection subscription. Xero charges a small monthly fee per connection, paid by the organization. Any user with the Standard, Advisor or Administrator role and the Connected Apps permission can buy it. Xero's own Demo Company is free, which makes it a safe place to try the connection first. Check Xero's current pricing before you buy.
  • A user of that organization approves the connection by email. You name this person, the authorizing user, when you create the Custom Connection. Xero emails them, and the Client ID and Client Secret only appear once they have approved.

One Custom Connection covers exactly one organization. If you look after several organizations, create one Custom Connection for each and add each to StackJack as its own connection. A Custom Connection also cannot reach Xero Practice Manager or Xero HQ, which are separate Xero products.

How StackJack authenticates to Xero

Xero gives you a Client ID and a Client Secret for the Custom Connection, and you also choose which scopes it may use. You paste all three into StackJack.

There is no web address to enter. Xero runs one shared service for every customer, and StackJack finds your organization by asking Xero which organization the Custom Connection is authorized for. You never type an organization ID, and a tool call that needs one uses the connection's own.

Behind the scenes StackJack exchanges the Client ID and Secret for an access key that lasts about thirty minutes, and fetches a new one on its own when it runs out. There is nothing to renew or rotate on a schedule.

The Scopes box has to match what you ticked

Xero decides what a Custom Connection may do from its scopes, and it refuses to issue a token that asks for a scope the connection was not granted. So the list in the StackJack form and the list you ticked in Xero's developer portal have to agree.

The Scopes box opens pre-filled with the scopes for every area StackJack covers, payroll included. If you ticked fewer, remove the ones you did not tick before you save. This is the most common reason a first connection test fails, and the error says so.

What you want your AI to reachScopes to tick
Invoices, bills, credit notes, quotes, repeating invoices, purchase orders, items, linked transactionsaccounting.invoices
Payments, batch payments, prepayments, overpaymentsaccounting.payments
Bank transactions and bank transfersaccounting.banktransactions
Manual journalsaccounting.manualjournals
Contacts and contact groupsaccounting.contacts
The organization record, chart of accounts, tax rates, tracking categories, currencies, branding themes, invoice reminders and usersaccounting.settings
Budgetsaccounting.budgets.read
Attachments on recordsaccounting.attachments
Reportsthe accounting.reports.* scopes, one per report: aged, balance sheet, bank summary, budget summary, executive summary, profit and loss, trial balance, tax reports and 1099
Fixed assetsassets
The file libraryfiles
Projects, tasks and timeprojects
Payrollpayroll.employees, payroll.payruns, payroll.payslip, payroll.timesheets and payroll.settings

Most scopes come in two forms. The plain scope lets the connection read and change, and the form ending in .read lets it read only. To keep your AI read-only whatever tools are switched on, tick the .read forms in Xero and list the same .read scopes in StackJack.

Expense claims and receipts are not listed under any of Xero's current scopes. Xero's own scopes page lists them only under the older broad transactions scope, so whether a connection created with the newer scopes can reach them is not documented. The tools are included and report plainly if Xero refuses them.

Steps

  1. Check the organization is in Australia, New Zealand, the United Kingdom or the United States, and that it has, or will buy, a Custom Connection subscription.
  2. Create the Custom Connection. Sign in to the Xero developer portal, open My Apps, choose New App and pick Custom connection as the integration type.
  3. Tick the scopes and name the authorizing user. Use the table above. Keep a copy of the list: you paste it into StackJack.
  4. Have the authorizing user approve it. Xero emails them a link. They choose the organization and approve. You are emailed when it is done.
  5. Copy the Client ID and generate the Client Secret. Open the app's details page in the developer portal. Xero shows the secret once, so copy it straight away and treat it as a password. Generating a new one replaces the old one.
  6. Enter the details in StackJack. Open Connectors, choose Xero, paste the Client ID and Client Secret, and edit the Scopes box so it lists exactly the scopes you ticked.
  7. Run a Test Connection. If it reports a scope error, the Scopes box lists something you did not tick. If it reports a client error, the Client ID or Client Secret is wrong, or the secret was regenerated.

What to know before your AI uses this connector

Money tools act on real books

Creating or changing invoices, bills, credit notes, payments, bank transactions, manual journals, purchase orders and expense claims, and creating a pay run, can post to the ledger and change balances and reports. Your AI assistant is asked to confirm each of them.

Some payroll changes decide what staff are paid, and they are confirmed the same way: setting the bank accounts an employee is paid into, rewriting a payslip's lines, and updating a timesheet in a way that approves it. Check account details with the employee before your AI sets them. Replacing an attachment overwrites the file already stored under that name, so keep a copy first.

Reading the books changes nothing, but it does return your customers' and staff's financial detail, so grant the reads deliberately.

Emailing an invoice sends a real email. It goes to the contact's primary address and any contact people flagged to receive invoices, and it comes from the user who authorized the Custom Connection. It cannot be recalled. Xero limits how many a day each organization can send, and an organization on a trial or the Demo Company can send few or none.

An update can delete what you leave out

When Xero updates an invoice, bill, credit note, quote, purchase order, bank transaction or manual journal, any line item that is not in the request is deleted. An update to a contact deletes any contact person that is not included. Every update tool says so in its description. Ask your AI assistant to read the record first and send back everything it wants to keep.

When a record includes its contact, send only the contact's ID. Any other contact detail in the request updates the contact record itself.

Deleting is usually an update

In Xero the way to delete or void most things is to update them with a status of deleted or voided, so the label on a tool is a better guide than its name. StackJack marks a tool destructive from what it can do, not from how it is called.

Retries and duplicates

In Xero's accounting service a write can create or update, so repeating a create makes a duplicate. StackJack sends a fresh unique key with every write and never repeats a write on its own, so a transient failure cannot double-post an invoice. If a write times out, read the record to see whether it landed before you ask for it again.

Pages, dates and where filters

Lists come back one page at a time. Ask for a page (numbered from 1) to get complete records: Xero's unpaged accounting lists return a lighter summary of each record. The page size is capped at each Xero service's own limit: 1000 for most lists, 500 for projects and 100 for the file library.

Dates in Xero's answers look like /Date(1439434356790+0000)/, which is milliseconds since 1 January 1970 UTC. When you send a date, use YYYY-MM-DD.

A where filter is sent exactly as written, so write it plainly, for example Status=="AUTHORISED", and let StackJack do the encoding.

Payroll is three different products

Xero runs separate payroll products for Australia, New Zealand and the United Kingdom, and each only answers for an organization in its own country. A payroll tool says which country it belongs to, and it is refused for an organization anywhere else. Payroll data carries employee names, tax numbers, bank accounts and pay. Employee and bank detail reads are not recorded or stored by StackJack, and an oversized result is refused rather than saved. Leave the payroll scopes out of the Scopes box if you do not want an AI assistant near them.

Attachments, document PDFs and library files are not sent inline. StackJack stores the file and gives your AI a read-only download link that works for thirty minutes, together with its type, size and exact expiry. Uploads take the file as base64 or as a public https link, up to 25 MB.

Limits

Xero limits each organization to 60 calls a minute and 5 at the same moment, plus a daily total (1,000 or 5,000 depending on the app). StackJack paces itself below the per-minute limit and tells you plainly when Xero says the day's limit is used up, because retrying cannot help until it resets in UTC. Ask for larger pages and use filters rather than many small reads. If several connections point at different organizations, they share StackJack's pacing for your account, so a very wide sweep across several organizations can run slower than one organization alone.

If an organization is offline or Xero is down for maintenance, Xero answers that it is unavailable. That is not a problem with the credentials and does not count against them. Try again in about five minutes.

Plans and limits

Every read is available on the Free tier. Every change needs Pro. Business reaches the same tools as Pro and differs by monthly call quota.

See the generated Xero tool reference for the current inventory, plan assignment, input schemas, and destructive-action labels. See also Retrying a failed or timed-out write.

Several organizations

One Custom Connection covers one organization. If you look after several, add one connection per organization from the connector's card, name each after the organization, and your AI names it on each call. Omit the name and the call runs against your default connection. Pin an endpoint to one connection when an AI should never reach past a single organization.

See Several connections of one connector.

Troubleshooting

"Xero refused the scopes listed on this connection": the Scopes box lists something the Custom Connection was not granted. Open the connector's settings, remove every scope you did not tick in Xero, and save. If you later add a scope to the Custom Connection in Xero, add it here too.

"Xero did not accept the Client ID and Client Secret": check the pair on the Custom Connection's details page. If the secret was regenerated, paste the new one in. Also check the connection is still authorized: if the authorizing user never approved Xero's email, or the organization's Custom Connection subscription lapsed, Xero refuses the pair.

"Xero accepted the credentials but lists no organization for this Custom Connection": the connection is not authorized for an organization yet, or its subscription has lapsed. Ask the authorizing user to approve Xero's email and check the subscription in Xero's Connected apps settings. This is not counted as a failed credential, and it recovers on its own once Xero lists the organization.

One area is refused while the rest work: the Custom Connection was not granted the scope that area needs, or the organization's Xero plan or role does not include it. A payroll tool is also refused for an organization outside its own country. Tick the scope in Xero, then add it to the Scopes box in StackJack.

A list looks like it is missing detail: ask for a page. Xero's unpaged accounting lists return summaries.

"Xero's daily API limit for this organization has been reached": Xero allows a fixed number of calls a day for each organization and refuses every call after that until the day resets in UTC. Retrying now will not help. Ask for fewer, larger pages and narrower filters, or wait for the reset.

A write timed out: read the record first. Xero may have saved it, and repeating a create makes a duplicate.

Everything worked and then stopped: a Custom Connection can be removed or its subscription canceled in Xero at any time. Open it in the developer portal, check it is still authorized, and re-enter the Client ID and Client Secret.

Xero tools

xero_ · 450 tools · Free 235 · Pro 215

Branding themes

ToolWhat it does
xero_get_branding_theme
Free · Read-only
Gets one branding theme by its BrandingThemeID.
xero_list_branding_themes
Free · Read-only
Lists the branding themes of the organization.

Budgets

ToolWhat it does
xero_get_budget
Free · Read-only
Gets one budget with its budget lines.
xero_list_budgets
Free · Read-only
Lists the budgets of the organization.

Chart of accounts

ToolWhat it does
xero_create_account
Pro · Write
Creates one account in the chart of accounts.
xero_create_account_attachment
Pro · Write
Attaches a file to an account under the file name you give.
xero_delete_account
Pro · Destructive
DESTRUCTIVE: Deletes an account from the chart of accounts.
xero_download_account_attachment
Free · Read-only
Downloads an account attachment by its attachment id.
xero_download_account_attachment_by_file_name
Free · Read-only
Downloads an account attachment by its file name.
xero_get_account
Free · Read-only
Gets one account from the chart of accounts.
xero_list_account_attachments
Free · Read-only
Lists the attachments on an account.
xero_list_accounts
Free · Read-only
Lists the chart of accounts.
xero_update_account
Pro · Destructive
DESTRUCTIVE: Updates one account in the chart of accounts.
xero_update_account_attachment
Pro · Destructive
DESTRUCTIVE: Replaces the file of an existing account attachment, by file name.

Connections

ToolWhat it does
xero_list_connections
Free · Read-only
Lists the connections, one per Xero organization this credential can reach.

Currencies

ToolWhat it does
xero_create_currency
Pro · Write
Adds a currency to the organization.
xero_list_currencies
Free · Read-only
Lists the currencies enabled for the organization.

Invoice reminders

ToolWhat it does
xero_get_invoice_reminder_settings
Free · Read-only
Gets the invoice reminder settings of the organization.

Organization

ToolWhat it does
xero_get_organization_cis_settings
Free · Read-only
Gets the UK Construction Industry Scheme settings of the organization.
xero_list_organization_actions
Free · Read-only
Lists the key actions this connection may perform in the organization.
xero_list_organizations
Free · Read-only
Gets the details of the connected organization.

Organization setup

ToolWhat it does
xero_post_setup
Pro · Destructive
DESTRUCTIVE: Sets up the chart of accounts, conversion date and conversion balances.

Tax rates

ToolWhat it does
xero_create_tax_rate
Pro · Write
Creates one tax rate.
xero_get_tax_rate_by_tax_type
Free · Read-only
Gets one tax rate by its TaxType code.
xero_list_tax_rates
Free · Read-only
Lists the tax rates of the organization.
xero_update_tax_rate
Pro · Destructive
DESTRUCTIVE: Updates one tax rate, matched by the TaxType in the body.

Tracking categories

ToolWhat it does
xero_create_tracking_category
Pro · Write
Creates a tracking category.
xero_create_tracking_option
Pro · Write
Adds an option to a tracking category.
xero_delete_tracking_category
Pro · Destructive
DESTRUCTIVE: Deletes a tracking category.
xero_delete_tracking_option
Pro · Destructive
DESTRUCTIVE: Deletes an option from a tracking category.
xero_get_tracking_category
Free · Read-only
Gets one tracking category with its options.
xero_list_tracking_categories
Free · Read-only
Lists the tracking categories with their options.
xero_update_tracking_category
Pro · Destructive
DESTRUCTIVE: Renames a tracking category or changes its status.
xero_update_tracking_option
Pro · Destructive
DESTRUCTIVE: Renames a tracking option or changes its status.

Users

ToolWhat it does
xero_get_user
Free · Read-only
Gets one user of the organization.
xero_list_users
Free · Read-only
Lists the users of the organization.

Reports

ToolWhat it does
xero_get_report_1099
Free · Read-only
Gets the 1099 contractor report for a year.
xero_get_report_aged_payables_by_contact
Free · Read-only
Gets the aged payables report for one contact.
xero_get_report_aged_receivables_by_contact
Free · Read-only
Gets the aged receivables report for one contact.
xero_get_report_balance_sheet
Free · Read-only
Gets the balance sheet for the month of a date.
xero_get_report_bank_summary
Free · Read-only
Gets the bank summary report for a date range.
xero_get_report_budget_summary
Free · Read-only
Gets the budget summary report.
xero_get_report_by_id
Free · Read-only
Gets one published report by its ReportID.
xero_get_report_executive_summary
Free · Read-only
Gets the executive summary report for a date.
xero_get_report_profit_and_loss
Free · Read-only
Gets the profit and loss report for a date range.
xero_get_report_trial_balance
Free · Read-only
Gets the trial balance as at a date.
xero_list_reports
Free · Read-only
Lists the published BAS (Australia) or GST (New Zealand) reports.

Contact groups

ToolWhat it does
xero_add_contact_group_contacts
Pro · Write
Adds contacts to a contact group.
xero_create_contact_group
Pro · Write
Creates a contact group.
xero_get_contact_group
Free · Read-only
Gets one contact group with its member contacts.
xero_list_contact_groups
Free · Read-only
Lists the contact groups with their ids and names.
xero_remove_all_contact_group_contacts
Pro · Destructive
DESTRUCTIVE: Removes every contact from a contact group.
xero_remove_contact_group_contact
Pro · Destructive
DESTRUCTIVE: Removes one contact from a contact group.
xero_update_contact_group
Pro · Destructive
DESTRUCTIVE: Renames a contact group or changes its status.

Contacts

ToolWhat it does
xero_add_contact_history_note
Pro · Write
Adds a note to the history of a contact.
xero_create_contact_attachment
Pro · Write
Attaches a file to a contact under the file name you give.
xero_create_contacts
Pro · Write
Creates one or more contacts in one call.
xero_download_contact_attachment
Free · Read-only
Downloads a contact attachment by its attachment id.
xero_download_contact_attachment_by_file_name
Free · Read-only
Downloads a contact attachment by its file name.
xero_get_contact
Free · Read-only
Gets one contact by its ContactID.
xero_get_contact_by_contact_number
Free · Read-only
Gets one contact by its ContactNumber.
xero_get_contact_cis_settings
Free · Read-only
Gets the Construction Industry Scheme settings of a contact.
xero_list_contact_attachments
Free · Read-only
Lists the attachments on a contact.
xero_list_contact_history
Free · Read-only
Lists the history and notes of a contact.
xero_list_contacts
Free · Read-only
Lists the contacts of the organization.
xero_update_contact
Pro · Destructive
DESTRUCTIVE: Updates one contact.
xero_update_contact_attachment
Pro · Destructive
DESTRUCTIVE: Replaces the file of an existing contact attachment, by file name.
xero_upsert_contacts
Pro · Destructive
DESTRUCTIVE: Creates or updates contacts in one call.

Credit notes

ToolWhat it does
xero_add_credit_note_history_note
Pro · Write
Adds a note to the history of one credit note.
xero_create_credit_note_allocation
Pro · Destructive
DESTRUCTIVE: Applies part or all of an approved credit note to an invoice.
xero_create_credit_note_attachment
Pro · Write
Attaches a file to a credit note.
xero_create_credit_notes
Pro · Destructive
DESTRUCTIVE: Creates one or more sales or purchase credit notes.
xero_delete_credit_note_allocation
Pro · Destructive
DESTRUCTIVE: Removes one allocation from a credit note.
xero_download_credit_note_attachment
Free · Read-only
Downloads one credit note attachment by its AttachmentID.
xero_download_credit_note_attachment_by_file_name
Free · Read-only
Downloads one credit note attachment by its file name.
xero_download_credit_note_pdf
Free · Read-only
Downloads a credit note as a PDF.
xero_get_credit_note
Free · Read-only
Gets one credit note by its CreditNoteID.
xero_list_credit_note_attachments
Free · Read-only
Lists the attachments of one credit note.
xero_list_credit_note_history
Free · Read-only
Lists the history and notes of one credit note.
xero_list_credit_notes
Free · Read-only
Lists sales and purchase credit notes.
xero_update_credit_note
Pro · Destructive
DESTRUCTIVE: Updates one credit note, including its status.
xero_update_credit_note_attachment
Pro · Destructive
DESTRUCTIVE: Updates an existing credit note attachment, matched by file name.
xero_upsert_credit_notes
Pro · Destructive
DESTRUCTIVE: Creates or updates one or more credit notes.

Invoices

ToolWhat it does
xero_add_invoice_history_note
Pro · Write
Adds a note to the history of one invoice or purchase bill.
xero_create_invoice_attachment
Pro · Write
Attaches a file to an invoice or purchase bill.
xero_create_invoices
Pro · Destructive
DESTRUCTIVE: Creates one or more sales invoices or purchase bills.
xero_download_invoice_attachment
Free · Read-only
Downloads one invoice attachment by its AttachmentID.
xero_download_invoice_attachment_by_file_name
Free · Read-only
Downloads one invoice attachment by its file name.
xero_download_invoice_pdf
Free · Read-only
Downloads a sales invoice or purchase bill as a PDF.
xero_email_invoice
Pro · Destructive
DESTRUCTIVE: Emails a copy of a sales invoice to its contact.
xero_get_invoice
Free · Read-only
Gets one sales invoice or purchase bill by its InvoiceID.
xero_get_online_invoice
Free · Read-only
Gets the online invoice link of a sales invoice.
xero_list_invoice_attachments
Free · Read-only
Lists the attachments of one invoice or purchase bill.
xero_list_invoice_history
Free · Read-only
Lists the history and notes of one invoice or purchase bill.
xero_list_invoices
Free · Read-only
Lists sales invoices and purchase bills.
xero_update_invoice
Pro · Destructive
DESTRUCTIVE: Updates one sales invoice or purchase bill, including its status.
xero_update_invoice_attachment
Pro · Destructive
DESTRUCTIVE: Updates an existing invoice attachment, matched by file name.
xero_upsert_invoices
Pro · Destructive
DESTRUCTIVE: Creates or updates one or more sales invoices or purchase bills.

Items

ToolWhat it does
xero_add_item_history_note
Pro · Write
Adds a note to the history of one item.
xero_create_items
Pro · Write
Creates one or more items.
xero_delete_item
Pro · Destructive
DESTRUCTIVE: Deletes one item.
xero_get_item
Free · Read-only
Gets one item by its ItemID.
xero_list_item_history
Free · Read-only
Lists the history and notes of one item.
xero_list_items
Free · Read-only
Lists items.
xero_update_item
Pro · Write
Updates one item.
xero_upsert_items
Pro · Write
Creates or updates one or more items.

Linked transactions

ToolWhat it does
xero_create_linked_transaction
Pro · Write
Creates a linked transaction (a billable expense).
xero_delete_linked_transaction
Pro · Destructive
DESTRUCTIVE: Deletes one linked transaction (a billable expense).
xero_get_linked_transaction
Free · Read-only
Gets one linked transaction (a billable expense).
xero_list_linked_transactions
Free · Read-only
Lists linked transactions (billable expenses).
xero_update_linked_transaction
Pro · Write
Updates one linked transaction (a billable expense).

Quotes

ToolWhat it does
xero_add_quote_history_note
Pro · Write
Adds a note to the history of one quote.
xero_create_quote_attachment
Pro · Write
Attaches a file to a quote.
xero_create_quotes
Pro · Write
Creates one or more quotes.
xero_download_quote_attachment
Free · Read-only
Downloads one quote attachment by its AttachmentID.
xero_download_quote_attachment_by_file_name
Free · Read-only
Downloads one quote attachment by its file name.
xero_download_quote_pdf
Free · Read-only
Downloads a quote as a PDF.
xero_get_quote
Free · Read-only
Gets one quote by its QuoteID.
xero_list_quote_attachments
Free · Read-only
Lists the attachments of one quote.
xero_list_quote_history
Free · Read-only
Lists the history and notes of one quote.
xero_list_quotes
Free · Read-only
Lists quotes.
xero_update_quote
Pro · Destructive
DESTRUCTIVE: Updates one quote, including its status.
xero_update_quote_attachment
Pro · Destructive
DESTRUCTIVE: Updates an existing quote attachment, matched by file name.
xero_upsert_quotes
Pro · Destructive
DESTRUCTIVE: Creates or updates one or more quotes.

Repeating invoices

ToolWhat it does
xero_add_repeating_invoice_history_note
Pro · Write
Adds a note to the history of one repeating invoice template.
xero_create_repeating_invoice_attachment
Pro · Write
Attaches a file to a repeating invoice template.
xero_create_repeating_invoices
Pro · Destructive
DESTRUCTIVE: Creates one or more repeating invoice templates.
xero_download_repeating_invoice_attachment
Free · Read-only
Downloads one repeating invoice attachment by its AttachmentID.
xero_download_repeating_invoice_attachment_by_file_name
Free · Read-only
Downloads one repeating invoice attachment by its file name.
xero_get_repeating_invoice
Free · Read-only
Gets one repeating invoice template by its RepeatingInvoiceID.
xero_list_repeating_invoice_attachments
Free · Read-only
Lists the attachments of one repeating invoice template.
xero_list_repeating_invoice_history
Free · Read-only
Lists the history and notes of one repeating invoice template.
xero_list_repeating_invoices
Free · Read-only
Lists repeating invoice templates.
xero_update_repeating_invoice
Pro · Destructive
DESTRUCTIVE: Updates or deletes one repeating invoice template.
xero_update_repeating_invoice_attachment
Pro · Destructive
DESTRUCTIVE: Updates an existing repeating invoice attachment, matched by file name.
xero_upsert_repeating_invoices
Pro · Destructive
DESTRUCTIVE: Creates, updates or deletes one or more repeating invoice templates.

Batch payments

ToolWhat it does
xero_add_batch_payment_history_note
Pro · Write
Adds a note to the history of one batch payment.
xero_create_batch_payment
Pro · Destructive
DESTRUCTIVE: Creates a batch payment that pays several invoices at once.
xero_delete_batch_payment
Pro · Destructive
DESTRUCTIVE: Deletes a batch payment, identified in the body.
xero_delete_batch_payment_by_id
Pro · Destructive
DESTRUCTIVE: Deletes a batch payment, identified in the path.
xero_get_batch_payment
Free · Read-only
Gets one batch payment by its BatchPaymentID.
xero_list_batch_payment_history
Free · Read-only
Lists the history and notes of one batch payment.
xero_list_batch_payments
Free · Read-only
Lists batch payments.

Overpayments

ToolWhat it does
xero_add_overpayment_history_note
Pro · Write
Adds a note to the history of one overpayment.
xero_create_overpayment_allocation
Pro · Destructive
DESTRUCTIVE: Applies part or all of an overpayment to outstanding invoices.
xero_delete_overpayment_allocation
Pro · Destructive
DESTRUCTIVE: Removes one allocation from an overpayment.
xero_get_overpayment
Free · Read-only
Gets one overpayment by its OverpaymentID.
xero_list_overpayment_history
Free · Read-only
Lists the history and notes of one overpayment.
xero_list_overpayments
Free · Read-only
Lists overpayments.

Payments

ToolWhat it does
xero_add_payment_history_note
Pro · Write
Adds a note to the history of one payment.
xero_create_payment
Pro · Destructive
DESTRUCTIVE: Creates a single payment or refund.
xero_create_payments
Pro · Destructive
DESTRUCTIVE: Creates multiple payments or refunds.
xero_delete_payment
Pro · Destructive
DESTRUCTIVE: Deletes (reverses) a payment.
xero_get_payment
Free · Read-only
Gets one payment by its PaymentID.
xero_list_payment_history
Free · Read-only
Lists the history and notes of one payment.
xero_list_payments
Free · Read-only
Lists payments for invoices, credit notes, prepayments and overpayments.

Prepayments

ToolWhat it does
xero_add_prepayment_history_note
Pro · Write
Adds a note to the history of one prepayment.
xero_create_prepayment_allocation
Pro · Destructive
DESTRUCTIVE: Applies part or all of a prepayment to outstanding invoices.
xero_delete_prepayment_allocation
Pro · Destructive
DESTRUCTIVE: Removes one allocation from a prepayment.
xero_get_prepayment
Free · Read-only
Gets one prepayment by its PrepaymentID.
xero_list_prepayment_history
Free · Read-only
Lists the history and notes of one prepayment.
xero_list_prepayments
Free · Read-only
Lists prepayments.

Bank transactions

ToolWhat it does
xero_add_bank_transaction_history_note
Pro · Write
Adds a note to the history of one bank transaction.
xero_create_bank_transaction_attachment
Pro · Write
Attaches a file to a bank transaction.
xero_create_bank_transactions
Pro · Destructive
DESTRUCTIVE: Creates spend money, receive money, prepayment or overpayment transactions.
xero_download_bank_transaction_attachment
Free · Read-only
Downloads one bank transaction attachment by its AttachmentID.
xero_download_bank_transaction_attachment_by_file_name
Free · Read-only
Downloads one bank transaction attachment by its file name.
xero_get_bank_transaction
Free · Read-only
Gets one bank transaction by its BankTransactionID.
xero_list_bank_transaction_attachments
Free · Read-only
Lists the attachments of one bank transaction.
xero_list_bank_transaction_history
Free · Read-only
Lists the history and notes of one bank transaction.
xero_list_bank_transactions
Free · Read-only
Lists bank transactions (spend and receive money, prepayments, overpayments).
xero_update_bank_transaction
Pro · Destructive
DESTRUCTIVE: Updates one spend or receive money transaction, including its status.
xero_update_bank_transaction_attachment
Pro · Destructive
DESTRUCTIVE: Updates an existing bank transaction attachment, matched by file name.
xero_upsert_bank_transactions
Pro · Destructive
DESTRUCTIVE: Creates or updates one or more spend or receive money transactions.

Bank transfers

ToolWhat it does
xero_add_bank_transfer_history_note
Pro · Write
Adds a note to the history of one bank transfer.
xero_create_bank_transfer
Pro · Destructive
DESTRUCTIVE: Creates a bank transfer between two bank accounts.
xero_create_bank_transfer_attachment
Pro · Write
Attaches a file to a bank transfer.
xero_delete_bank_transfer
Pro · Destructive
DESTRUCTIVE: Deletes one bank transfer, identified in the path.
xero_delete_bank_transfers
Pro · Destructive
DESTRUCTIVE: Deletes one or more bank transfers, identified in the body.
xero_download_bank_transfer_attachment
Free · Read-only
Downloads one bank transfer attachment by its AttachmentID.
xero_download_bank_transfer_attachment_by_file_name
Free · Read-only
Downloads one bank transfer attachment by its file name.
xero_get_bank_transfer
Free · Read-only
Gets one bank transfer by its BankTransferID.
xero_list_bank_transfer_attachments
Free · Read-only
Lists the attachments of one bank transfer.
xero_list_bank_transfer_history
Free · Read-only
Lists the history and notes of one bank transfer.
xero_list_bank_transfers
Free · Read-only
Lists bank transfers.
xero_update_bank_transfer_attachment
Pro · Destructive
DESTRUCTIVE: Updates an existing bank transfer attachment, matched by file name.

Expense claims

ToolWhat it does
xero_add_expense_claim_history_note
Pro · Write
Adds a note to the history of an expense claim.
xero_create_expense_claims
Pro · Destructive
DESTRUCTIVE: Submits expense claims for approval.
xero_get_expense_claim
Free · Read-only
Gets one expense claim by its ExpenseClaimID.
xero_list_expense_claim_history
Free · Read-only
Lists the history and notes of an expense claim.
xero_list_expense_claims
Free · Read-only
Lists the expense claims of the organization.
xero_update_expense_claim
Pro · Destructive
DESTRUCTIVE: Changes the status of an expense claim (approve or void it).

Purchase orders

ToolWhat it does
xero_add_purchase_order_history_note
Pro · Write
Adds a note to the history of a purchase order.
xero_create_purchase_order_attachment
Pro · Write
Attaches a file to a purchase order under the file name you give.
xero_create_purchase_orders
Pro · Destructive
DESTRUCTIVE: Creates one or more purchase orders.
xero_download_purchase_order_attachment
Free · Read-only
Downloads a purchase order attachment by its attachment id.
xero_download_purchase_order_attachment_by_file_name
Free · Read-only
Downloads a purchase order attachment by its file name.
xero_download_purchase_order_pdf
Free · Read-only
Downloads a purchase order as a PDF.
xero_get_purchase_order
Free · Read-only
Gets one purchase order by its PurchaseOrderID.
xero_get_purchase_order_by_number
Free · Read-only
Gets one purchase order by its PurchaseOrderNumber.
xero_list_purchase_order_attachments
Free · Read-only
Lists the attachments on a purchase order.
xero_list_purchase_order_history
Free · Read-only
Lists the history and notes of a purchase order.
xero_list_purchase_orders
Free · Read-only
Lists purchase orders, filtered by status or date range.
xero_update_purchase_order
Pro · Destructive
DESTRUCTIVE: Updates one purchase order.
xero_update_purchase_order_attachment
Pro · Destructive
DESTRUCTIVE: Replaces the file of an existing purchase order attachment, by file name.
xero_upsert_purchase_orders
Pro · Destructive
DESTRUCTIVE: Creates or updates purchase orders in one call.

Receipts

ToolWhat it does
xero_add_receipt_history_note
Pro · Write
Adds a note to the history of a receipt.
xero_create_receipt
Pro · Destructive
DESTRUCTIVE: Creates a draft expense claim receipt for a user.
xero_create_receipt_attachment
Pro · Write
Attaches a file to a receipt under the file name you give.
xero_download_receipt_attachment
Free · Read-only
Downloads a receipt attachment by its attachment id.
xero_download_receipt_attachment_by_file_name
Free · Read-only
Downloads a receipt attachment by its file name.
xero_get_receipt
Free · Read-only
Gets one draft expense claim receipt by its ReceiptID.
xero_list_receipt_attachments
Free · Read-only
Lists the attachments on a receipt.
xero_list_receipt_history
Free · Read-only
Lists the history and notes of a receipt.
xero_list_receipts
Free · Read-only
Lists draft expense claim receipts for any user.
xero_update_receipt
Pro · Destructive
DESTRUCTIVE: Updates one draft expense claim receipt.
xero_update_receipt_attachment
Pro · Destructive
DESTRUCTIVE: Replaces the file of an existing receipt attachment, by file name.

Manual journals

ToolWhat it does
xero_add_manual_journal_history_note
Pro · Write
Adds a note to the history of one manual journal.
xero_create_manual_journal_attachment
Pro · Write
Attaches a file to a manual journal.
xero_create_manual_journals
Pro · Destructive
DESTRUCTIVE: Creates one or more manual journals.
xero_download_manual_journal_attachment
Free · Read-only
Downloads one manual journal attachment by its AttachmentID.
xero_download_manual_journal_attachment_by_file_name
Free · Read-only
Downloads one manual journal attachment by its file name.
xero_get_manual_journal
Free · Read-only
Gets one manual journal by its ManualJournalID.
xero_list_manual_journal_attachments
Free · Read-only
Lists the attachments of one manual journal.
xero_list_manual_journal_history
Free · Read-only
Lists the history and notes of one manual journal.
xero_list_manual_journals
Free · Read-only
Lists manual journals.
xero_update_manual_journal
Pro · Destructive
DESTRUCTIVE: Updates one manual journal, including its status.
xero_update_manual_journal_attachment
Pro · Destructive
DESTRUCTIVE: Updates an existing manual journal attachment, matched by file name.
xero_upsert_manual_journals
Pro · Destructive
DESTRUCTIVE: Creates or updates one or more manual journals.

Asset settings

ToolWhat it does
xero_get_asset_settings
Free · Read-only
Gets the fixed asset settings of the organization.

Asset types

ToolWhat it does
xero_create_asset_type
Pro · Write
Creates a fixed asset type.
xero_list_asset_types
Free · Read-only
Lists the fixed asset types of the organization.

Assets

ToolWhat it does
xero_create_asset
Pro · Write
Creates a fixed asset.
xero_get_asset
Free · Read-only
Gets one fixed asset by its id.
xero_list_assets
Free · Read-only
Lists the fixed assets with one status.

Associations

ToolWhat it does
xero_count_associations
Free · Read-only
Counts the files linked to each of several records.
xero_list_associations_by_object
Free · Read-only
Lists the files linked to one record.

Files

ToolWhat it does
xero_create_file_association
Pro · Write
Links an existing file to a record.
xero_delete_file
Pro · Destructive
DESTRUCTIVE: Deletes one file from the Files library.
xero_delete_file_association
Pro · Destructive
DESTRUCTIVE: Unlinks a file from a record.
xero_download_file_content
Free · Read-only
Downloads the content of one file.
xero_get_file
Free · Read-only
Gets one file by its FileId.
xero_list_file_associations
Free · Read-only
Lists the records one file is linked to.
xero_list_files
Free · Read-only
Lists the files in the organization's Files library.
xero_update_file
Pro · Write
Renames a file or moves it to another folder.
xero_upload_file
Pro · Write
Uploads a file to the Xero Files inbox.
xero_upload_file_to_folder
Pro · Write
Uploads a file to one Files folder.

Folders

ToolWhat it does
xero_create_folder
Pro · Write
Creates a Files folder.
xero_delete_folder
Pro · Destructive
DESTRUCTIVE: Deletes one Files folder.
xero_get_folder
Free · Read-only
Gets one Files folder by its id.
xero_list_folders
Free · Read-only
Lists the Files folders of the organization.
xero_update_folder
Pro · Write
Renames a Files folder.

Inbox

ToolWhat it does
xero_get_inbox_folder
Free · Read-only
Gets the Files inbox folder.

Project tasks

ToolWhat it does
xero_create_project_task
Pro · Write
Adds a task to a project.
xero_delete_project_task
Pro · Destructive
DESTRUCTIVE: Deletes a task from a project.
xero_get_project_task
Free · Read-only
Gets one task of a project.
xero_list_project_tasks
Free · Read-only
Lists the tasks of one project.
xero_update_project_task
Pro · Write
Updates one task of a project.

Project time entries

ToolWhat it does
xero_create_project_time_entry
Pro · Write
Logs a time entry against a project task.
xero_delete_project_time_entry
Pro · Destructive
DESTRUCTIVE: Deletes a time entry from a project.
xero_get_project_time_entry
Free · Read-only
Gets one time entry of a project.
xero_list_project_time_entries
Free · Read-only
Lists the time entries of one project.
xero_update_project_time_entry
Pro · Write
Updates one time entry of a project.

Projects

ToolWhat it does
xero_create_project
Pro · Write
Creates a project for a contact.
xero_get_project
Free · Read-only
Gets one project by its projectId.
xero_list_project_users
Free · Read-only
Lists the project users of the organization.
xero_list_projects
Free · Read-only
Lists the projects of the organization.
xero_patch_project
Pro · Destructive
DESTRUCTIVE: Changes the status of a project.
xero_update_project
Pro · Write
Updates a project's name, contact, estimate or deadline.

Payroll AU: Calendars

ToolWhat it does
xero_payroll_au_create_payroll_calendar
Pro · Write
Creates a payroll calendar.
xero_payroll_au_get_payroll_calendar
Free · Read-only
Gets one payroll calendar by its id.
xero_payroll_au_list_payroll_calendars
Free · Read-only
Lists the payroll calendars of the organization.

Payroll AU: Employees

ToolWhat it does
xero_payroll_au_create_employee
Pro · Write
Creates a payroll employee.
xero_payroll_au_get_employee
Free · Read-only
Gets one payroll employee by EmployeeID.
xero_payroll_au_list_employees
Free · Read-only
Lists the payroll employees of the organization.
xero_payroll_au_update_employee
Pro · Destructive
DESTRUCTIVE: Updates one payroll employee.

Payroll AU: Leave applications

ToolWhat it does
xero_payroll_au_approve_leave_application
Pro · Destructive
DESTRUCTIVE: Approves a requested leave application.
xero_payroll_au_create_leave_application
Pro · Write
Creates a leave application for an employee.
xero_payroll_au_get_leave_application
Free · Read-only
Gets one leave application by its id.
xero_payroll_au_list_leave_applications
Free · Read-only
Lists leave applications, without leave requests.
xero_payroll_au_list_leave_applications_v2
Free · Read-only
Lists leave applications, leave requests included.
xero_payroll_au_reject_leave_application
Pro · Destructive
DESTRUCTIVE: Rejects a requested leave application.
xero_payroll_au_update_leave_application
Pro · Write
Updates one leave application.

Payroll AU: Pay items

ToolWhat it does
xero_payroll_au_create_pay_item
Pro · Write
Creates earnings rates, deductions, leave or reimbursement pay items.
xero_payroll_au_list_pay_items
Free · Read-only
Lists the pay items of the organization.

Payroll AU: Pay runs

ToolWhat it does
xero_payroll_au_create_pay_run
Pro · Destructive
DESTRUCTIVE: Creates a pay run for a payroll calendar.
xero_payroll_au_get_pay_run
Free · Read-only
Gets one pay run by its PayRunID.
xero_payroll_au_list_pay_runs
Free · Read-only
Lists the pay runs of the organization.
xero_payroll_au_update_pay_run
Pro · Destructive
DESTRUCTIVE: Updates a pay run or posts it.

Payroll AU: Payslips

ToolWhat it does
xero_payroll_au_get_payslip
Free · Read-only
Gets one payslip by its PayslipID.
xero_payroll_au_update_payslip
Pro · Destructive
DESTRUCTIVE: Updates the pay lines of one payslip.

Payroll AU: Settings

ToolWhat it does
xero_payroll_au_get_settings
Free · Read-only
Gets the payroll settings of the organization.

Payroll AU: Super fund products

ToolWhat it does
xero_payroll_au_list_superfund_products
Free · Read-only
Looks up regulated super fund products by ABN or USI.

Payroll AU: Super funds

ToolWhat it does
xero_payroll_au_create_superfund
Pro · Write
Creates a superannuation fund.
xero_payroll_au_get_superfund
Free · Read-only
Gets one superannuation fund by its id.
xero_payroll_au_list_superfunds
Free · Read-only
Lists the superannuation funds of the organization.
xero_payroll_au_update_superfund
Pro · Write
Updates one superannuation fund.

Payroll AU: Timesheets

ToolWhat it does
xero_payroll_au_create_timesheet
Pro · Write
Creates a timesheet with the original 1.0 route.
xero_payroll_au_get_timesheet
Free · Read-only
Gets one timesheet by its id with the 1.0 route.
xero_payroll_au_list_timesheets
Free · Read-only
Lists timesheets with the original 1.0 route.
xero_payroll_au_update_timesheet
Pro · Destructive
DESTRUCTIVE: Updates one timesheet with the original 1.0 route.
xero_payroll_au_v2_approve_timesheet
Pro · Destructive
DESTRUCTIVE: Approves a timesheet on the 2.0 route.
xero_payroll_au_v2_create_timesheet
Pro · Write
Creates a timesheet on the 2.0 route.
xero_payroll_au_v2_create_timesheet_line
Pro · Write
Adds a line to a timesheet on the 2.0 route.
xero_payroll_au_v2_delete_timesheet
Pro · Destructive
DESTRUCTIVE: Deletes a timesheet on the 2.0 route.
xero_payroll_au_v2_delete_timesheet_line
Pro · Destructive
DESTRUCTIVE: Deletes one line of a timesheet on the 2.0 route.
xero_payroll_au_v2_get_timesheet
Free · Read-only
Gets one timesheet by its id on the 2.0 route.
xero_payroll_au_v2_list_timesheets
Free · Read-only
Lists timesheets on the 2.0 route.
xero_payroll_au_v2_revert_timesheet
Pro · Destructive
DESTRUCTIVE: Reverts a timesheet to draft on the 2.0 route.
xero_payroll_au_v2_update_timesheet_line
Pro · Write
Updates one line of a timesheet on the 2.0 route.

Payroll NZ: Deductions

ToolWhat it does
xero_payroll_nz_create_deduction
Pro · Write
Creates a deduction pay item for the organization.
xero_payroll_nz_get_deduction
Free · Read-only
Gets one deduction by its deductionId.
xero_payroll_nz_list_deductions
Free · Read-only
Lists the organization's deductions.

Payroll NZ: Earnings rates

ToolWhat it does
xero_payroll_nz_create_earnings_rate
Pro · Write
Creates an earnings rate pay item.
xero_payroll_nz_get_earnings_rate
Free · Read-only
Gets one earnings rate by its EarningsRateID.
xero_payroll_nz_list_earnings_rates
Free · Read-only
Lists the organization's earnings rates.

Payroll NZ: Employee leave

ToolWhat it does
xero_payroll_nz_create_employee_leave
Pro · Write
Creates a leave record for one employee.
xero_payroll_nz_create_employee_leave_setup
Pro · Write
Sets up leave (holiday pay, annual and sick leave) for one employee.
xero_payroll_nz_create_employee_leave_type
Pro · Write
Assigns a leave type to one employee.
xero_payroll_nz_delete_employee_leave
Pro · Destructive
DESTRUCTIVE: Deletes one leave record of an employee.
xero_payroll_nz_get_employee_leave_balances
Free · Read-only
Gets an employee's current leave balances.
xero_payroll_nz_list_employee_leave_periods
Free · Read-only
Lists an employee's leave by pay period.
xero_payroll_nz_list_employee_leave_types
Free · Read-only
Lists the leave types assigned to one employee.
xero_payroll_nz_list_employee_leaves
Free · Read-only
Lists the leave records of one employee.
xero_payroll_nz_update_employee_leave
Pro · Write
Updates one leave record of an employee.

Payroll NZ: Employee tax

ToolWhat it does
xero_payroll_nz_get_employee_tax
Free · Read-only
Gets an employee's tax details.
xero_payroll_nz_update_employee_tax
Pro · Write
Updates an employee's tax details.

Payroll NZ: Employees

ToolWhat it does
xero_payroll_nz_create_employee
Pro · Write
Creates an employee.
xero_payroll_nz_get_employee
Free · Read-only
Gets one employee by their EmployeeID.
xero_payroll_nz_list_employees
Free · Read-only
Lists employees.
xero_payroll_nz_update_employee
Pro · Write
Updates an employee's personal details.

Payroll NZ: Employment

ToolWhat it does
xero_payroll_nz_create_employment
Pro · Write
Adds employment details to an employee.

Payroll NZ: Leave types

ToolWhat it does
xero_payroll_nz_create_leave_type
Pro · Write
Creates a leave type for the organization.
xero_payroll_nz_get_leave_type
Free · Read-only
Gets one leave type by its LeaveTypeID.
xero_payroll_nz_list_leave_types
Free · Read-only
Lists the organization's leave types.

Payroll NZ: Opening balances

ToolWhat it does
xero_payroll_nz_create_employee_opening_balances
Pro · Write
Creates opening balances for one employee.
xero_payroll_nz_get_employee_opening_balances
Free · Read-only
Gets an employee's opening balances.

Payroll NZ: Pay run calendars

ToolWhat it does
xero_payroll_nz_create_pay_run_calendar
Pro · Write
Creates a pay run calendar.
xero_payroll_nz_get_pay_run_calendar
Free · Read-only
Gets one pay run calendar by its PayrollCalendarID.
xero_payroll_nz_list_pay_run_calendars
Free · Read-only
Lists the organization's pay run calendars.

Payroll NZ: Pay runs

ToolWhat it does
xero_payroll_nz_create_pay_run
Pro · Destructive
DESTRUCTIVE: Creates a pay run for a payroll calendar period.
xero_payroll_nz_get_pay_run
Free · Read-only
Gets one pay run by its PayRunID.
xero_payroll_nz_list_pay_runs
Free · Read-only
Lists pay runs.

Payroll NZ: Pay templates

ToolWhat it does
xero_payroll_nz_create_employee_earnings_template
Pro · Write
Adds one earnings line to an employee's pay template.
xero_payroll_nz_create_multiple_employee_earnings_template
Pro · Write
Adds several earnings lines to an employee's pay template.
xero_payroll_nz_delete_employee_earnings_template
Pro · Destructive
DESTRUCTIVE: Deletes one earnings line from an employee's pay template.
xero_payroll_nz_list_employee_pay_templates
Free · Read-only
Gets the pay template of one employee, with its earnings lines.
xero_payroll_nz_update_employee_earnings_template
Pro · Write
Updates one earnings line of an employee's pay template.

Payroll NZ: Payment methods

ToolWhat it does
xero_payroll_nz_create_employee_payment_method
Pro · Destructive
DESTRUCTIVE: Sets how an employee is paid and into which bank accounts.
xero_payroll_nz_get_employee_payment_method
Free · Read-only
Gets an employee's payment method and bank accounts.

Payroll NZ: Payslips

ToolWhat it does
xero_payroll_nz_get_pay_slip
Free · Read-only
Gets one payslip by its PaySlipID.
xero_payroll_nz_list_pay_slips
Free · Read-only
Lists the payslips of one pay run.
xero_payroll_nz_update_pay_slip_line_items
Pro · Destructive
DESTRUCTIVE: Updates the line items of one payslip.

Payroll NZ: Reimbursements

ToolWhat it does
xero_payroll_nz_create_reimbursement
Pro · Write
Creates a reimbursement pay item.
xero_payroll_nz_get_reimbursement
Free · Read-only
Gets one reimbursement by its ReimbursementID.
xero_payroll_nz_list_reimbursements
Free · Read-only
Lists the organization's reimbursements.

Payroll NZ: Salary and wages

ToolWhat it does
xero_payroll_nz_create_employee_salary_and_wage
Pro · Write
Creates a salary or wage record for an employee.
xero_payroll_nz_delete_employee_salary_and_wage
Pro · Destructive
DESTRUCTIVE: Deletes one salary and wages record of an employee.
xero_payroll_nz_get_employee_salary_and_wage
Free · Read-only
Gets one salary and wages record by its SalaryAndWagesID.
xero_payroll_nz_list_employee_salary_and_wages
Free · Read-only
Lists the salary and wages records of one employee.
xero_payroll_nz_update_employee_salary_and_wage
Pro · Write
Updates one salary and wages record of an employee.

Payroll NZ: Settings

ToolWhat it does
xero_payroll_nz_get_settings
Free · Read-only
Gets the payroll settings.
xero_payroll_nz_list_tracking_categories
Free · Read-only
Lists the payroll tracking categories.

Payroll NZ: Statutory deductions

ToolWhat it does
xero_payroll_nz_get_statutory_deduction
Free · Read-only
Gets one statutory deduction by its id.
xero_payroll_nz_list_statutory_deductions
Free · Read-only
Lists the organization's statutory deductions.

Payroll NZ: Superannuations

ToolWhat it does
xero_payroll_nz_create_superannuation
Pro · Write
Creates a superannuation (KiwiSaver or fund) pay item.
xero_payroll_nz_get_superannuation
Free · Read-only
Gets one superannuation by its SuperannuationID.
xero_payroll_nz_list_superannuations
Free · Read-only
Lists the organization's superannuations.

Payroll NZ: Timesheets

ToolWhat it does
xero_payroll_nz_approve_timesheet
Pro · Destructive
DESTRUCTIVE: Approves a timesheet.
xero_payroll_nz_create_timesheet
Pro · Write
Creates a timesheet for an employee and a pay period.
xero_payroll_nz_create_timesheet_line
Pro · Write
Adds one line to a timesheet.
xero_payroll_nz_delete_timesheet
Pro · Destructive
DESTRUCTIVE: Deletes a timesheet.
xero_payroll_nz_delete_timesheet_line
Pro · Destructive
DESTRUCTIVE: Deletes one line from a timesheet.
xero_payroll_nz_get_timesheet
Free · Read-only
Gets one timesheet by its TimesheetID.
xero_payroll_nz_list_timesheets
Free · Read-only
Lists timesheets.
xero_payroll_nz_revert_timesheet
Pro · Destructive
DESTRUCTIVE: Reverts a timesheet to draft.
xero_payroll_nz_update_timesheet_line
Pro · Write
Updates one line of a timesheet.

Payroll NZ: Working patterns

ToolWhat it does
xero_payroll_nz_create_employee_working_pattern
Pro · Write
Creates a working pattern for an employee.
xero_payroll_nz_delete_employee_working_pattern
Pro · Destructive
DESTRUCTIVE: Deletes one working pattern of an employee.
xero_payroll_nz_get_employee_working_pattern
Free · Read-only
Gets one working pattern of an employee by its EmployeeWorkingPatternID.
xero_payroll_nz_list_employee_working_patterns
Free · Read-only
Lists the working patterns of one employee.

Payroll UK: Benefits

ToolWhat it does
xero_payroll_uk_create_benefit
Pro · Write
Creates an employer pension benefit.
xero_payroll_uk_get_benefit
Free · Read-only
Gets one benefit by its id.
xero_payroll_uk_list_benefits
Free · Read-only
Lists the organization's employer pension benefits.

Payroll UK: Deductions

ToolWhat it does
xero_payroll_uk_create_deduction
Pro · Write
Creates a deduction pay item for the organization.
xero_payroll_uk_get_deduction
Free · Read-only
Gets one deduction by its deductionId.
xero_payroll_uk_list_deductions
Free · Read-only
Lists the organization's deductions.

Payroll UK: Earnings orders

ToolWhat it does
xero_payroll_uk_get_earnings_order
Free · Read-only
Gets one earnings order by its id.
xero_payroll_uk_list_earnings_orders
Free · Read-only
Lists the organization's earnings orders.

Payroll UK: Earnings rates

ToolWhat it does
xero_payroll_uk_create_earnings_rate
Pro · Write
Creates an earnings rate pay item.
xero_payroll_uk_get_earnings_rate
Free · Read-only
Gets one earnings rate by its EarningsRateID.
xero_payroll_uk_list_earnings_rates
Free · Read-only
Lists the organization's earnings rates.

Payroll UK: Employee leave

ToolWhat it does
xero_payroll_uk_create_employee_leave
Pro · Write
Creates a leave record for one employee.
xero_payroll_uk_create_employee_leave_type
Pro · Write
Assigns a leave type to one employee.
xero_payroll_uk_delete_employee_leave
Pro · Destructive
DESTRUCTIVE: Deletes one leave record of an employee.
xero_payroll_uk_get_employee_leave
Free · Read-only
Gets one leave record of an employee by its LeaveID.
xero_payroll_uk_get_employee_leave_balances
Free · Read-only
Gets an employee's current leave balances.
xero_payroll_uk_get_employee_statutory_leave_balances
Free · Read-only
Gets an employee's remaining statutory leave balance.
xero_payroll_uk_list_employee_leave_periods
Free · Read-only
Lists an employee's leave by pay period.
xero_payroll_uk_list_employee_leave_types
Free · Read-only
Lists the leave types assigned to one employee.
xero_payroll_uk_list_employee_leaves
Free · Read-only
Lists the leave records of one employee.
xero_payroll_uk_update_employee_leave
Pro · Write
Updates one leave record of an employee.

Payroll UK: Employee tax

ToolWhat it does
xero_payroll_uk_get_employee_tax
Free · Read-only
Gets an employee's tax details.

Payroll UK: Employees

ToolWhat it does
xero_payroll_uk_create_employee
Pro · Write
Creates an employee.
xero_payroll_uk_get_employee
Free · Read-only
Gets one employee by their EmployeeID.
xero_payroll_uk_list_employees
Free · Read-only
Lists employees.
xero_payroll_uk_update_employee
Pro · Write
Updates an employee's personal details.

Payroll UK: Employment

ToolWhat it does
xero_payroll_uk_create_employment
Pro · Write
Adds employment details to an employee.

Payroll UK: Leave types

ToolWhat it does
xero_payroll_uk_create_leave_type
Pro · Write
Creates a leave type for the organization.
xero_payroll_uk_get_leave_type
Free · Read-only
Gets one leave type by its LeaveTypeID.
xero_payroll_uk_list_leave_types
Free · Read-only
Lists the organization's leave types.

Payroll UK: Opening balances

ToolWhat it does
xero_payroll_uk_create_employee_opening_balances
Pro · Write
Creates the opening balances of one employee.
xero_payroll_uk_get_employee_opening_balances
Free · Read-only
Gets an employee's opening balances.
xero_payroll_uk_update_employee_opening_balances
Pro · Write
Updates the opening balances of one employee.

Payroll UK: Pay run calendars

ToolWhat it does
xero_payroll_uk_create_pay_run_calendar
Pro · Write
Creates a pay run calendar.
xero_payroll_uk_get_pay_run_calendar
Free · Read-only
Gets one pay run calendar by its PayRunCalendarID.
xero_payroll_uk_list_pay_run_calendars
Free · Read-only
Lists the organization's pay run calendars.

Payroll UK: Pay runs

ToolWhat it does
xero_payroll_uk_get_pay_run
Free · Read-only
Gets one pay run by its PayRunID.
xero_payroll_uk_list_pay_runs
Free · Read-only
Lists pay runs.

Payroll UK: Pay templates

ToolWhat it does
xero_payroll_uk_create_employee_earnings_template
Pro · Write
Adds one earnings line to an employee's pay template.
xero_payroll_uk_create_multiple_employee_earnings_template
Pro · Write
Adds several earnings lines to an employee's pay template.
xero_payroll_uk_delete_employee_earnings_template
Pro · Destructive
DESTRUCTIVE: Deletes one earnings line from an employee's pay template.
xero_payroll_uk_get_employee_pay_template
Free · Read-only
Gets the pay template of one employee, with its earnings lines.
xero_payroll_uk_update_employee_earnings_template
Pro · Write
Updates one earnings line of an employee's pay template.

Payroll UK: Payment methods

ToolWhat it does
xero_payroll_uk_create_employee_payment_method
Pro · Destructive
DESTRUCTIVE: Sets how an employee is paid and into which bank accounts.
xero_payroll_uk_get_employee_payment_method
Free · Read-only
Gets an employee's payment method and bank accounts.

Payroll UK: Payslips

ToolWhat it does
xero_payroll_uk_get_pay_slip
Free · Read-only
Gets one payslip by its PayslipID.
xero_payroll_uk_list_pay_slips
Free · Read-only
Lists the payslips of one pay run.

Payroll UK: Reimbursements

ToolWhat it does
xero_payroll_uk_create_reimbursement
Pro · Write
Creates a reimbursement pay item.
xero_payroll_uk_get_reimbursement
Free · Read-only
Gets one reimbursement by its ReimbursementID.
xero_payroll_uk_list_reimbursements
Free · Read-only
Lists the organization's reimbursements.

Payroll UK: Salary and wages

ToolWhat it does
xero_payroll_uk_create_employee_salary_and_wage
Pro · Write
Creates a salary or wage record for an employee.
xero_payroll_uk_delete_employee_salary_and_wage
Pro · Destructive
DESTRUCTIVE: Deletes one salary and wages record of an employee.
xero_payroll_uk_get_employee_salary_and_wage
Free · Read-only
Gets one salary and wages record by its SalaryAndWagesID.
xero_payroll_uk_list_employee_salary_and_wages
Free · Read-only
Lists the salary and wages records of one employee.
xero_payroll_uk_update_employee_salary_and_wage
Pro · Write
Updates one salary and wages record of an employee.

Payroll UK: Settings

ToolWhat it does
xero_payroll_uk_get_settings
Free · Read-only
Gets the payroll settings.
xero_payroll_uk_list_tracking_categories
Free · Read-only
Lists the payroll tracking categories.

Payroll UK: Statutory leave

ToolWhat it does
xero_payroll_uk_create_employee_statutory_sick_leave
Pro · Write
Creates a statutory sick leave record for an employee.
xero_payroll_uk_get_employee_statutory_sick_leave
Free · Read-only
Gets one statutory sick leave record by its StatutorySickLeaveID.
xero_payroll_uk_get_statutory_leave_summary
Free · Read-only
Gets an employee's statutory leave summary.

Payroll UK: Timesheets

ToolWhat it does
xero_payroll_uk_approve_timesheet
Pro · Destructive
DESTRUCTIVE: Approves a timesheet.
xero_payroll_uk_create_timesheet
Pro · Write
Creates a timesheet for an employee and a pay period.
xero_payroll_uk_create_timesheet_line
Pro · Write
Adds one line to a timesheet.
xero_payroll_uk_delete_timesheet
Pro · Destructive
DESTRUCTIVE: Deletes a timesheet.
xero_payroll_uk_delete_timesheet_line
Pro · Destructive
DESTRUCTIVE: Deletes one line from a timesheet.
xero_payroll_uk_get_timesheet
Free · Read-only
Gets one timesheet by its TimesheetID.
xero_payroll_uk_list_timesheets
Free · Read-only
Lists timesheets.
xero_payroll_uk_revert_timesheet
Pro · Destructive
DESTRUCTIVE: Reverts a timesheet to draft.
xero_payroll_uk_update_timesheet_line
Pro · Write
Updates one line of a timesheet.