Xero

receivables money

What customers owe: every AUTHORISED sales invoice (ACCREC) with an amount due, totalled and aged into buckets overall and per customer, largest debtor first. Owing is Xero's own AmountDue, in the organisation's base currency; invoices in another currency are counted apart. age_by due counts days overdue from the due date, so not_due is its own bucket; issued counts days since the invoice date.

age_by

string. Default due.

contact

string. Only customers whose name contains this.

payables money

What the business owes its suppliers: every AUTHORISED bill (ACCPAY) with an amount due, totalled and aged into buckets overall and per supplier, largest first, as receivables does for customers.

age_by

string. Default due.

contact

string. Only suppliers whose name contains this.

contact_overview customers

Everything about one contact, customer or supplier: name, email, phones, addresses and people; its sales invoices and bills (count, total, owing, the unpaid ones); payments; credit notes; and quotes, open ones listed.

contact*

string. A Xero ContactID, or part of the contact's name.

cash_position money

Money in and out of each bank account, from spend and receive money (transfers included) and payments, for a period or all time, with what is not yet reconciled. NOT the bank balance: Xero's balance comes from its reports, which are not read, and opening balances and manual journals are not counted.

from

string. First day, e.g. 2026-07-01. Omit for all time.

to

string. Last day, inclusive.

sales_and_spend money

Sales and spend for a period ex tax, per account code or per tracking option, summed from the line items of approved invoices, bills, their credit notes and spend and receive money (not transfers, overpayments or prepayments), by document date, in the base currency.

from*

string. First day, e.g. 2026-07-01.

to

string. Last day, inclusive. Default today.

by

string. Default account.

side

string. Omit for both.

category

string. With by tracking: only this tracking category, e.g. Region.

gst tax

GST on sales against GST on purchases for a period, and the net, per tax type: an ESTIMATE from the tax on the line items of the documents sales_and_spend reads, by document date. Not Xero's BAS or activity statement.

from*

string. First day, e.g. 2026-07-01.

to

string. Last day, inclusive. Default today.

unreconciled money

Spend and receive money and payments entered in Xero but not yet reconciled, per bank account with the oldest date, then the oldest of them listed. Xero's statement lines are not read, so a line nobody entered is not here.

account

string. Only bank accounts whose name or code contains this.

limit

integer. Transactions to list. Default 25, at most 100.

accounts Accounts

The chart of accounts: code, name, type (BANK, REVENUE, EXPENSE…), class and tax type. Line items name an account by code.

Keyed by source_id

asset_types Asset types

The kinds of fixed asset and how each depreciates.

Keyed by source_id

assets Assets

Fixed assets: number, name, status (DRAFT, REGISTERED, DISPOSED), purchase date and price, and depreciation.

Keyed by source_id

attachments Attachments

Files on a Xero document: name, type and size, with the document's kind and ID (parent_type, parent_id). Metadata only.

Keyed by source_id

bank_transactions Bank transactions

Spend and receive money through a bank account, with line items. account_id is the bank account (accounts).

Keyed by source_id

bank_transfers Bank transfers

Money moved between two of the organisation's bank accounts.

Keyed by source_id

batch_payments Batch payments

Payments made or received in one batch, with each payment in it and the payees' bank details.

Keyed by source_id

branding_themes Branding themes

The invoice and quote templates.

Keyed by source_id

budgets Budgets

The organisation's budgets as Xero lists them. Budget lines are not read.

Keyed by source_id

contact_groups Contact groups

Groups contacts are sorted into.

Keyed by source_id

contacts Contacts

Customers and suppliers: name, email, addresses, phones, is_customer, is_supplier and bank account details.

Keyed by source_id

credit_notes Credit notes

Credit notes: ACCRECCREDIT to a customer, ACCPAYCREDIT from a supplier, with line items, allocations and what remains.

Keyed by source_id

currencies Currencies

The currencies the organisation trades in.

Keyed by source_id

files Files

Files in Xero's file library: name, type, size and folder. Metadata only.

Keyed by source_id

folders Folders

The file library's folders.

Keyed by source_id

invoices Invoices

Sales invoices (kind ACCREC) and bills (ACCPAY) with line items: contact, dates, status, total, amount_due and amount_paid. Who owes what: summarize amount_due where kind is ACCREC and status AUTHORISED, grouped by contact_name.

Keyed by source_id

items Items

Products and services: code, name, sale and purchase details, and stock on hand where tracked.

Keyed by source_id

journals Journals

The general ledger: every journal line Xero wrote, the raw ledger behind every report. Read only once Xero has approved journals for this app.

Keyed by source_id

leave_applications Leave applications

Leave applied for: the person, leave type, dates, units, title and description.

Keyed by source_id

linked_transactions Linked transactions

Billable expenses: a bill line linked to the sales invoice it is charged on.

Keyed by source_id

manual_journals Manual journals

Journals entered by hand, with their lines.

Keyed by source_id

organisations Organisations

The organisation itself: name, legal name, country, base currency and financial year.

Keyed by source_id

overpayments Overpayments

Money paid or received over what was owed, and how it was allocated.

Keyed by source_id

pay_runs Pay runs

Pay runs: period, payment date, status, calendar, totals (Wages, Tax, Super, NetPay) and who was paid. Each person's lines are in payslips.

Keyed by source_id

payments Payments

Payments against invoices, credit notes, prepayments and overpayments: date, amount, the invoice (invoice_id) and the account paid through.

Keyed by source_id

payroll_calendars Payroll calendars

Payroll calendars: weekly, fortnightly or monthly, and their dates.

Keyed by source_id

payroll_employees Payroll employees

People on the payroll (Payroll AU): name, contact, address, job title, status, dates, leave balances, opening balances, pay template, tax declaration, bank accounts and super memberships.

Keyed by source_id

payroll_timesheets Payroll timesheets

Payroll timesheets: a person's hours for a period by earnings rate. No amounts.

Keyed by source_id

payslips Payslips

One person's pay in one pay run (pay_run_id): wages, deductions, tax, super and net_pay, with earnings, leave accrued and taken, deduction, super and tax lines in the document.

Keyed by source_id

prepayments Prepayments

Money paid or received before an invoice, and how it was allocated.

Keyed by source_id

project_tasks Project tasks

The tasks inside each Xero project.

Keyed by source_id

project_times Project times

Time logged against project tasks: who (user_id), the day and the minutes.

Keyed by source_id

project_users Project users

The people who can log time to projects.

Keyed by source_id

projects Projects

Xero projects: name, contact, status, deadline and estimate.

Keyed by source_id

purchase_orders Purchase orders

Purchase orders to suppliers, with line items and delivery date.

Keyed by source_id

quotes Quotes

Quotes to customers, with line items, status and expiry.

Keyed by source_id

repeating_invoices Repeating invoices

Invoice and bill templates Xero raises on a schedule.

Keyed by source_id

reports Reports

Xero's own reports as it answered them: TrialBalance, BalanceSheet, ExecutiveSummary, ProfitAndLoss and BankSummary at each month's end (period_end; period_start for the two that span the month), the same as at today (source_id '<report>:current', with BudgetSummary), and published tax reports (report 'Published'). Figures are in the document's Rows.

Keyed by source_id

settings Settings

Settings Xero answers as one document: payroll settings, pay items and fixed-asset settings, by source_id.

Keyed by source_id

super_funds Super funds

The super funds the business pays into.

Keyed by source_id

tax_rates Tax rates

The tax rates set up in Xero, keyed by tax type.

Keyed by source_id

tracking_categories Tracking categories

Tracking categories and their options (department, region and so on).

Keyed by source_id

users Users

The people who sign in to the organisation's Xero, and their role.

Keyed by source_id