Xero

Get the connected Xero organisation: name, base currency, country, timezone, financial year end, tax basis, default tax rates and lock dates.

Takes no parameters.

Search Xero contacts (customers and suppliers) by name, email or number and return contact summaries.

Get a Xero contact with addresses, phones, contact persons, default accounts, payment terms and outstanding/overdue balances.

Create a new Xero contact (customer or supplier). Returns the created contact.

Update fields of an existing Xero contact; omitted fields are left unchanged. Returns the updated contact.

List Xero sales invoices or bills with optional type, status, contact, date and amount-due filters (newest first). Returns summaries without line items; use getInvoice for full details.

Get a Xero invoice or bill with its line items, totals, amounts due and payments.

Create a Xero sales invoice or bill for a contact with one or more line items. Use listAccounts, listItems and listTaxRates for valid account codes, item codes and tax types.

Update a Xero invoice or bill: change its status (approve, void, delete), dates, reference, number or line items. Omitted fields are left unchanged.

Email an AUTHORISED Xero sales invoice to its contact using the organisation's invoice email template. The contact must have an email address.

List payments recorded in Xero against invoices, bills and credit notes, with optional invoice, type, status and date filters (newest first).

Record a payment against an AUTHORISED Xero invoice or bill from a bank account (or an account with "payments enabled"). Returns the created payment.

List spend and receive money transactions of the organisation's bank accounts, with optional account, type, contact, reconciliation and date filters (newest first).

Get a Xero spend or receive money transaction with its line items, totals and bank account.

Record a spend or receive money transaction against a Xero bank account. Use listAccounts for the bank account and line account codes. Returns the created transaction.

Update a Xero spend or receive money transaction: change its date, reference, contact or lines, or set status DELETED to void it. Omitted fields are left unchanged. Reconciled transactions cannot have their amounts changed.

List money transfers between the organisation's own bank accounts, with optional date filters (newest first).

Transfer money between two of the organisation's own Xero bank accounts. Returns the created transfer.

List Xero manual journals with optional status and date filters (newest first). Returns summaries without journal lines; use getManualJournal for the lines.

Get a Xero manual journal with its debit and credit lines.

Create a Xero manual journal from balanced debit and credit lines. Use listAccounts for valid account codes and listTaxRates for tax types. Returns the created journal.

Update a Xero manual journal: post a draft, void it, or change its narration, date or lines. Omitted fields are left unchanged. Only DRAFT journals can have their lines changed.

List the organisation's chart of accounts (codes, names, types, classes, tax types and bank accounts). Use it to find account codes for invoice lines and bank accounts for payments.

List the organisation's products and services (item codes, prices, default accounts and tax types) for use on invoice lines.

List the organisation's tax rates (name, tax type code, rate and where each applies) for use on invoice lines.

List the organisation's budgets (overall and tracking-category budgets). Returns summaries without budget lines; use getBudget for the budgeted amounts.

Get a Xero budget with its budgeted amounts per account and period. Compare it against getProfitAndLossReport to report on budget versus actual.

List the files attached to a Xero record (invoice, bill, credit note, bank transaction, contact, manual journal and so on). Use downloadAttachment to fetch one.

Download a file attached to a Xero record into agent file storage.

Attach a file from agent storage to a Xero record. Returns the created attachment.

Get the Profit and Loss (income statement) report for a period: revenue, expenses and net profit by account, optionally with comparison periods.

Get the Balance Sheet report as at a date: assets, liabilities and equity by account, optionally with comparison periods.

Get the Trial Balance report as at a date: every account with its year-to-date and period debit and credit movements.

Get the aged receivables or aged payables report for one contact: outstanding invoices by age bracket with totals.

Get the Bank Summary report for a period: opening balance, money in, money out and closing balance for each bank account.

Get the Budget Summary report: budgeted amounts per account across a number of periods.

Get the Executive Summary report for a month: cash, profitability, income, performance and position metrics with the prior month and year-to-date for comparison.

Get the 1099 report for a tax year: each contact to be reported with their tax details and address. US organisations only.

List Xero Projects with optional contact and status filters. Returns summaries; use getProject for the full invoicing breakdown.

Get a Xero project with its estimate, time logged and the task and expense amounts invoiced or still to be invoiced.

Create a Xero project for a contact, optionally with an estimate and deadline.

Update a Xero project: rename it, change its contact, estimate or deadline, or close and reopen it. Omitted fields are left unchanged.

List the staff who can log time on Xero Projects. Use it to find the userId that createProjectTimeEntry requires.

List the tasks of a Xero project with their rates, estimates and the time logged, invoiced and still to be invoiced.

Get one task of a Xero project with its rate, estimate and invoicing totals.

Add a task to a Xero project. Time is logged against tasks, so create one before recording time.

Update a task of a Xero project. Xero replaces the whole task, so pass the name, rate and charge type even when only one of them changes — read the current values with getProjectTask first.

List time logged against a Xero project, with optional task, user, contact, chargeability and date filters.

Log time against a task of a Xero project. Find the task with listProjectTasks and the user with listProjectUsers.

Update a time entry on a Xero project. Xero replaces the whole entry, so pass the task, user, date and duration even when only one of them changes — read the current values with listProjectTimeEntries first. Invoiced or locked entries cannot be changed.