Get started
Set up Ekwo for New Zealand
Two ways in, and both end the same way: the rules of New Zealand installed in a database you own.
Create your Ekwo Cloud account
The hosted edition, operated for you: the web application and your own instance. No password — Ekwo Cloud sends a code to your address.
Run it yourself
Free, for ever. One command on your own Supabase project applies the schema, installs the New Zealand pack and creates your first company. Nothing is gated.
npx ekwo-os init --country NZIt asks for the rest as it goes: the connection to your project, the chart of accounts where there is a choice, your organisation and your first administrator.
Step by step
The same path as text: every command with New Zealand already on it, and the codes a first invoice is written with. An AI agent helping you reads the same text as Markdown, at /countries/nz/set-up.md.
Ekwo keeps balanced accounts in a database you own, with the rules of New Zealand as data. On Ekwo Cloud the New Zealand pack is ready to use, with an account opened in a minute; this page is the other way in, Ekwo OS, the open source core, installed on your own project. It is generated from the New Zealand pack, version 0.2.0; every code on it is read from the pack.
The New Zealand pack is community: contributed, and reviewed by nobody.
Your accountant works on the same data, with their own access, and the pack carries its sources, its version and its status. To find an accountant who works with Ekwo in New Zealand, see the directory or our partners. What Ekwo is, and its limits: the disclaimer.
1. What you need
- A Supabase project of your own. The free plan is enough to start; Ekwo does not create it, pay for it or have access to it.
- From its dashboard: the connection string (Connect → Session pooler), the Project URL and the
service_rolekey (Project Settings → API). The key is used once, to create your first administrator, and is written nowhere. The anon (publishable) key, on the same page, is what you sign in with afterwards. - Node 20 or later on your machine. Nothing else: no Supabase CLI, no Docker, no clone.
2. Install
One command. It asks for the rest as it goes.
npx ekwo-os init --country NZ
- One chart of accounts: New Zealand reference chart of accounts, 163 accounts.
- The accounts are kept in
en. - The Goods and services tax return is filed on one of these cadences:
month,bimonth,half_year. The default isbimonth. Pass--vat-period <cadence>to set yours. - A financial year follows the calendar unless you pass
--fiscal-year-start YYYY-MM-DD.
The same, with no question asked — every value your own:
npx ekwo-os init \
--country NZ \
--db-url "postgresql://postgres.<ref>:<password>@<pooler host>:5432/postgres" \
--supabase-url "https://<ref>.supabase.co" \
--service-role-key "$SUPABASE_SERVICE_ROLE_KEY" \
--org "Your Organisation" --company "Your Company" \
--admin-email "you@example.com" \
--yes
3. Before you go live
Four settings of your project no installer can reach: turn off self sign-up, keep two administrators, keep the service_role key off every other machine, and read the disclaimer. init prints them; the installation guide explains each.
4. A first invoice
Sign in as the administrator you just created, pick the company, and write a draft. --dry-run shows what the database would write, and writes nothing; post records it.
ekwo login --supabase-url https://<ref>.supabase.co --anon-key <publishable key> --email you@example.com
ekwo use "Your Company"
ekwo contact add "First Customer" --country NZ --ref customer-1
ekwo doc new --contact "First Customer" --ref invoice-1 --line "name=Consulting,price=1000.00,account=4000,tax=NZ-S-GST"
ekwo post invoice-1 --dry-run
ekwo post invoice-1
A line names its account and its tax by code, never by rate. 4000 is the account the pack names for sales; the chart may carry a closer one for what you sell — services, a reduced rate — and list_accounts lists them.
What the invoice says about your company — its address, its VAT number — comes from the company’s profile, which the MCP tool update_company_profile fills; ekwo init sets only the name.
The domestic sale taxes the pack carries today. Which one a sale carries is a question about that sale, for you or your accountant: the list is the pack’s, not advice.
| Tax code | Name | Rate |
|---|---|---|
NZ-S-GST |
Sale, GST 15 % | 15 % |
NZ-S-GST-INC |
Retail sale, GST 15 %, the price includes the GST | 15 % |
NZ-S-GST-PAY |
Sale, GST 15 %, accounted for on the payments basis | 15 % |
NZ-S-ZERO-GOINGCONCERN |
Sale of a taxable activity as a going concern, zero-rated | 0 % |
NZ-S-ZERO-LAND |
Sale of land between GST-registered persons, zero-rated | 0 % |
5. With an AI agent
The MCP server lets an agent act as you, under your own row level security, and never with the service_role key. Configuring it, and what an agent must and must not do.
What the New Zealand pack carries
- Charts of accounts: New Zealand reference chart of accounts (163).
- 17 taxes, at 0 %, 15 %.
- The Goods and services tax return (
NZ-GST101A), 11 boxes, filed month, bimonth, half_year. - Electronic invoices as
pint-aunz. - Financial statements: Statement of financial position — NZ IFRS, Tier 2 Reduced Disclosure Regime, Statement of profit or loss — NZ IFRS, Tier 2 Reduced Disclosure Regime, expenses by nature.
What it does not do
- No library of this repository writes the file of the NZ-GST101A yet: the return is computed and frozen here, and typed on the administration’s portal.
- Nothing is sent to an administration, a Peppol network or a bank by the open source software: transmission is yours, or an operator’s you appoint.
- What the pack leaves out on purpose is in its README.