Documentation index
Start here. Short definitions: glossary. Portal Guides is this catalogue.
Staff runbooks live in index-staff.md (Mission Control → Documentation only).
Get started
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+) |
| Power BI starter |
OData M queries + starter zip for Power BI Desktop |
Clients & assistants
Portal shortcuts
| Page |
Path |
| Dashboard |
/dashboard/ |
| Settings |
/dashboard/?panel=settings |
| Xero authorisations |
/dashboard/?panel=authorisations |
| Portal guide (this doc) |
/docs/portal-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/ |
| Trusted catalog (IT) |
/addin/catalog/ · /addin/catalog.zip |
| Word templates zip |
/word/templates.zip |
| Power BI starter zip |
/power-bi/starter.zip |
| NZ forms workbook |
/excel/forms.xlsx |
| Email setup / Sent |
/dashboard/email/ · /dashboard/email/sent/ |
| Ask x0 |
/ask/ |
| Simulator (public) |
/sim/ |
x0