Documentation index
Start here. Short definitions: glossary. Portal Guides is this catalogue; staff also browse Admin → Documentation.
Get started
| Guide |
Use when |
| Excel desktop |
Power Query / From Web + Bearer (or Basic) |
| Excel add-in |
Sideload Connect x0 — sign in, token, load a table |
| Word add-in |
Mail merge, Avery labels, item catalogue |
| Excel workbook |
Dashboard snapshot download (Accounts / NZ forms / Reports & Attachments / all) |
| Glossary |
Acronyms and x0 product words |
Stationery & email
| Guide |
Use when |
| NZ Excel forms |
A4 tax invoice, PO, quote, remittance, statement, works order, … |
| Word add-in |
Customer/supplier merge, labels, catalogue |
| Email form PDFs |
From: + SMTP, Email PDF button, Sent list |
API, cache & SQL
| Guide |
Use when |
| OData |
Entity sets, filters, scopes, X0 connection card |
| Data schema diagram |
Dashboard ER diagram, mermaid for agents / markdown |
| Contacts & Invoices write |
PUT/POST/DELETE Contacts + draft Invoices (REST + OData) |
| Items & PurchaseOrders write |
PUT/POST/DELETE Items + draft PurchaseOrders (REST + OData) |
| Credit notes, lifecycle & payments |
CreditNotes, invoice/PO authorise, payments |
| Data freshness |
Cache vs Xero, TTL, incremental If-Modified-Since, portal Refresh |
| Date transform |
Xero /Date(ms)/ → ISO or Excel serial (julian) |
| Gzip responses |
Optional compressed API responses (Standard+) |
| Postgres / warehouse |
Read-only SQL schema of your cache (Professional+) |
Clients & assistants
| Guide |
Use when |
| Yaak |
Prove a Bearer key before Excel |
| AI agents |
HTTP / agents (not Excel) |
| MCP for AI agents |
Local MCP servers — schema, setup, efficiency metrics |
| Ask x0 |
In-portal assistant (Standard+), Q-XXXX log |
| Xero API simulator |
Drop-in for api.xero.com while developing |
Portal shortcuts
| Page |
Path |
| Dashboard |
/dashboard/ |
| Data schema |
/dashboard/#section-schema |
| Guides |
/docs/ |
| This index |
/docs/index/ |
| Glossary |
/docs/glossary/ |
| Excel add-in install |
/excel/addin/ |
| Word add-in install |
/word/addin/ |
| Word templates zip |
/word/templates.zip |
| NZ forms workbook |
/excel/forms.xlsx |
| Email setup / Sent |
/dashboard/email/ · /dashboard/email/sent/ |
| Ask x0 |
/ask/ |
| Simulator (public) |
/sim/ |
Staff / operators
Not on the customer Guides list — open Admin → Documentation or the repo docs/ folder:
| Area |
Docs |
| Architecture |
architecture.md, app-shell.md, dev-environment.md |
| Cache & sync |
data-cache-and-sync.md, cache-policy.md |
| Billing |
billing-invoices.md, billing-payments.md, pricing.md |
| Support |
support-queries.md, source-queries.md, customer-block.md |
| Xero internals |
xero-quirks.md, xero-data-map.md, source-types.md, accounts-write.md, contacts-invoices-write.md, items-purchase-orders-write.md |
| Options & jq |
customer-options.md, jq-transforms.md, webhooks.md |
| Ops |
ops-blocklist.md, ops-databases.md, volume-margin.md, staff-presence.md, docker-deploy.md, overnight-test-suite.md |
| Roadmap |
roadmap.md |
x0