Xero

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

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

What you can specify: Search term, Customers only, Suppliers only, Include archived, Where filter, Order

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

What you can specify: Contact ID

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

What you can specify: Name, First name, Last name, Email, Phone, Company number, Tax number, Account number, Default currency, Postal address (Line 1, Line 2, City, Region, Postal code, Country), Street address (Line 1, Line 2, City, Region, Postal code, Country)

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

What you can specify: Contact ID, Name, First name, Last name, Email, Phone, Company number, Tax number, Account number, Default currency, Postal address (Line 1, Line 2, City, Region, Postal code, Country), Street address (Line 1, Line 2, City, Region, Postal code, Country), Status

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

What you can specify: Type, Statuses, Contact ID, Invoice numbers, From date, To date, Due from, Due to, Outstanding only, Search term, Where filter, Order

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

What you can specify: Invoice

Create a Xero sales invoice or bill for a contact with one or more line items.

What you can specify: Type, Contact ID, Line items (Description, Quantity, Unit amount, Account code, Item code, Tax type, Discount %), Date, Due date, Reference, Invoice number, Status, Line amount types, Currency

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

What you can specify: Invoice ID, Status, Date, Due date, Reference, Invoice number, Line items (Description, Quantity, Unit amount, Account code, Item code, Tax type, Discount %), Line amount types

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

What you can specify: Invoice ID

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

What you can specify: Invoice ID, Status, Payment type, From date, To date, Where filter, Order

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

What you can specify: Invoice ID, Account ID, Account code, Amount, Date, Reference

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

What you can specify: Bank account ID, Type, Status, Contact ID, Reconciled, From date, To date, Where filter, Order

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

What you can specify: Bank transaction

Record a spend or receive money transaction against a Xero bank account. Returns the created transaction.

What you can specify: Type, Bank account ID, Bank account code, Contact ID, Line items (Description, Quantity, Unit amount, Account code, Item code, Tax type, Discount %), Date, Reference, Status, Line amount types, Currency

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.

What you can specify: Bank transaction, Contact ID, Line items (Description, Quantity, Unit amount, Account code, Item code, Tax type, Discount %), Date, Reference, Status, Line amount types, Currency

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

What you can specify: From date, To date, Where filter, Order

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

What you can specify: From account ID, To account ID, Amount, Date, Reference

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

What you can specify: Status, From date, To date, Where filter, Order

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

What you can specify: Manual journal

Create a Xero manual journal from balanced debit and credit lines. Returns the created journal.

What you can specify: Narration, Journal lines (Line amount, Account code, Description, Tax type), Date, Status, Line amount types, Show on cash basis reports

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.

What you can specify: Manual journal, Narration, Journal lines (Line amount, Account code, Description, Tax type), Date, Status, Line amount types, Show on cash basis reports

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.

What you can specify: Type, Class, Status, Payments enabled, Where filter, Order

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

What you can specify: Code, Sold, Purchased, Where filter, Order

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

What you can specify: Status, Where filter, Order

List the organisation's budgets (overall and tracking-category budgets). Returns summaries without budget lines.

What you can specify: Budget IDs

Get a Xero budget with its budgeted amounts per account and period.

What you can specify: Budget, From date, To date

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

What you can specify: Record type, Record ID

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

What you can specify: Record type, Record ID, Attachment ID, Save to

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

What you can specify: Record type, Record ID, File, File name, Include online

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

What you can specify: From date, To date, Periods, Timeframe, Standard layout, Payments only

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

What you can specify: Date, Periods, Timeframe, Standard layout, Payments only

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

What you can specify: Date, Payments only

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

What you can specify: Kind, Contact ID, Date, From date, To date

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

What you can specify: From date, To date

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

What you can specify: Start date, Periods, Timeframe

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.

What you can specify: Month

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

What you can specify: Tax year

List the organisation's published tax reports, which Xero exposes only for Australian organisations (published BAS reports) and New Zealand organisations (finalised GST returns); organisations elsewhere typically get an empty list. Reports built in the Xero Report Centre are not available through the Xero API.

Get a published BAS report (Australian organisations) or finalised GST return (New Zealand organisations) by its ID from listPublishedReports: its summary fields, columns and rows.

What you can specify: Report ID

List Xero Projects with optional contact and status filters. Returns summaries.

What you can specify: Contact ID, Status, Project IDs

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

What you can specify: Project

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

What you can specify: Name, Contact ID, Estimate, Deadline

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

What you can specify: Project, Name, Status, Contact ID, Estimate, Deadline

List the staff who can log time on Xero Projects.

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

What you can specify: Project, Charge type

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

What you can specify: Project, Task

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

What you can specify: Project, Name, Rate, Charge type, Estimate (minutes)

Update a task of a Xero project.

What you can specify: Project, Task, Name, Rate, Charge type, Estimate (minutes)

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

What you can specify: Project, Task ID, User ID, Contact ID, Chargeable, From, To

Log time against a task of a Xero project.

What you can specify: Project, Task, User, Date, Duration (minutes), Description

Update a time entry on a Xero project. Invoiced or locked entries cannot be changed.

What you can specify: Project, Time entry, Task, User, Date, Duration (minutes), Description