Get started
Set up Ekwo for Pakistan
Two ways in, and both end the same way: the rules of Pakistan 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 Pakistan pack and creates your first company. Nothing is gated.
npx ekwo-os init --country PKIt 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 Pakistan 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/pk/set-up.md.
Ekwo keeps double-entry books in a database you own, with the rules of Pakistan as data. On Ekwo Cloud the Pakistan 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 Pakistan pack, version 0.2.0; every code on it is read from the pack.
The Pakistan pack is community: contributed, and reviewed by nobody.
Your accountant works in the same books, with their own access, and the pack carries its sources, its version and its status. To find an accountant who works with Ekwo in Pakistan, 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 PK
- One chart of accounts: Pakistan reference chart of accounts, 172 accounts.
- The books are kept in
en. - 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 PK \
--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 the entry the database would write, and writes nothing; post books 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 PK --ref customer-1
ekwo doc new --contact "First Customer" --ref invoice-1 --line "name=Consulting,price=1000.00,account=4000,tax=PK-S-18"
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 |
|---|---|---|
PK-S-18 |
Sale of goods, standard rate 18 % | 18 % |
PK-S-18-FT |
Sale of goods to an unregistered buyer, 18 % + further tax 4 % | 22 % |
PK-S-10 |
Sale at a reduced rate of 10 % — photovoltaic cells and panels | 10 % |
PK-S-ZR-DOM |
Domestic supply, zero-rated — Fifth Schedule | 0 % |
PK-S-PRA-16 |
Sale of services, Punjab sales tax on services 16 % (PRA) | 16 % |
PK-S-SRB-15 |
Sale of services, Sindh sales tax on services 15 % (SRB) | 15 % |
PK-S-KPRA-15 |
Sale of services, Khyber Pakhtunkhwa sales tax on services 15 % (KPRA) | 15 % |
PK-S-BRA-15 |
Sale of services, Balochistan sales tax on services 15 % (BRA) | 15 % |
PK-S-ICT-15 |
Sale of services, Islamabad Capital Territory sales tax on services 15 % (ICT) | 15 % |
5. With an AI agent
The MCP server lets an agent keep the books 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 Pakistan pack carries
- Charts of accounts: Pakistan reference chart of accounts (172).
- 29 taxes, at 0 %, 1 %, 10 %, 15 %, 16 %, 17 %, 18 %, 22 %.
- The Monthly Sales Tax Return (form STR-7, filed on FBR IRIS) (
PK-STR7), 22 boxes, filed month. - Financial statements: Statement of financial position, Statement of profit or loss.
What it does not do
- No library of this repository writes the file of the PK-STR7 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.