Xero
The ledger, invoices and the numbers finance signs off. Read-only.
| Connects with | OAuth |
| Reads | 26 operations |
| Writes | None |
| Irreversible | None |
| Personal data | Contact details for customers and suppliers. |
| Data stays in | AWS Sydney (ap-southeast-2) |
What it reads
Section titled “What it reads”- The organisation’s settings: legal and trading name, base currency, financial year end, timezone and tax basis.
- The chart of accounts, tax rates, currencies, items, tracking categories and contact groups.
- Contacts (customers and suppliers), invoices and bills, credit notes, repeating invoices, quotes and purchase orders.
- Payments, bank transactions and manual journals.
- Budgets.
- Reports Xero computes: profit and loss, balance sheet, trial balance, executive summary, bank summary, budget summary, and aged receivables or payables for one contact at a time.
If the connection reaches more than one Xero organisation, StoriBot lists them and works in the one the Stori names.
What it does not read
Section titled “What it does not read”Payroll, and the attachments on invoices and bills. Neither has an operation in this connector.
What it writes
Section titled “What it writes”Nothing. There are no write operations in this connector.
How you connect it
Section titled “How you connect it”Connect with OAuth. From the Integrations page, choose Connect on Xero, tick the operations StoriBot may use, and approve at Xero signed in as yourself. Xero asks you which organisation to connect.
StoriBot never sees your Xero password. You can disconnect from StoriBot, or remove StoriBot under Connected apps in Xero.
What StoriBot will ask for
Section titled “What StoriBot will ask for”Xero shows a consent screen listing the read scopes the ticked operations need. They are Xero’s fine-grained ones, such as accounting.invoices.read, accounting.contacts.read, accounting.settings.read and one accounting.reports.<report>.read per report, plus offline_access so the connection stays live without asking you to sign in again. No write scope is requested.
Every operation
Section titled “Every operation”These are the names the Integrations page shows beside each tick box, in the order it lists them. Generated from the connector registry; do not edit by hand.
All 26 operations
| Operation | Kind | What it does |
|---|---|---|
list_organisations |
Read | List the companies this connection can reach, each with the tenant id every other operation needs, the entry’s tenantId, not its own id. |
get_organisation |
Read | Retrieve one company’s own settings: legal and trading name, base currency, financial year end, timezone, and how it reports tax. |
list_accounts |
Read | List the chart of accounts, each with its code, name, type, tax rate and class. |
list_contacts |
Read | List contacts, customers and suppliers alike, with their contact details, default tax treatment and payment terms. |
list_invoices |
Read | List sales invoices and bills, with their line items, totals and amounts due. |
list_payments |
Read | List payments made against invoices and credit notes, each with its amount, date and the account it moved through. |
list_bank_transactions |
Read | List spend and receive money transactions on the bank accounts, with their line items. |
get_profit_and_loss |
Read | Profit and loss for a period: income, cost of sales and expenses by account, with the net profit. |
get_balance_sheet |
Read | Balance sheet as at a date: assets, liabilities and equity by account. |
get_trial_balance |
Read | Trial balance as at a date: every account’s movement for the period and its closing debit and credit balance. |
get_aged_receivables |
Read | Aged receivables for ONE contact: their outstanding invoices bucketed by how overdue each is. |
get_aged_payables |
Read | Aged payables for ONE contact: the bills owed to them bucketed by how overdue each is. |
list_credit_notes |
Read | List credit notes, the adjustments raised against invoices and bills, with their line items and remaining credit. |
list_repeating_invoices |
Read | List repeating invoice templates, each with its schedule and amount. |
list_purchase_orders |
Read | List purchase orders with their line items and totals, spend committed before a bill exists. |
list_quotes |
Read | List quotes with their line items and totals, the sales pipeline before an invoice exists. |
list_manual_journals |
Read | List manual journals with their lines, the adjustments that move the profit and loss without any invoice behind them, so a period that will not reconcile to… |
list_items |
Read | List the products and services sold and bought, each with its code, description and sale and purchase prices. |
list_tracking_categories |
Read | List the tracking categories and their options, Xero’s own dimensions, such as department, region or cost centre. |
list_tax_rates |
Read | List the tax rates with their components and effective rates, which is what separates a gross figure from a net one. |
list_currencies |
Read | List the currencies the company has enabled. |
list_contact_groups |
Read | List the contact groups and their members, the company’s own segmentation of its customers and suppliers. |
list_budgets |
Read | List the budgets with their periods and amounts, which is what makes a profit and loss readable as over or under rather than just a number. |
get_executive_summary |
Read | Executive summary for a month: cash, profitability, debtor and creditor figures with the previous month beside them and the variance already worked out. |
get_bank_summary |
Read | Bank summary for a period: each bank account’s opening balance, money in, money out and closing balance. |
get_budget_summary |
Read | Budget summary: budgeted totals by account across several periods ending at the date. |