ekwo-os 0.8.0 → 0.10.0

package/README.md

@@ -60,14 +60,15 @@ either.
    It asks for the connection string, the country, the chart of accounts and
    the language where the pack offers a choice, your organisation, the
    currency, the first company, the address of the first administrator and —
-   optionally — the IBAN of your main bank account, then does the rest. Five
+   optionally — the identifier of your main bank account (an IBAN, a routing number and an account number, a sort code… whatever your country's banks use), then does the rest. Five
    to ten seconds on a free project. Nothing is preselected for you on the
    three questions whose wrong answer is expensive: the country, the chart and
    the language.
 
-4. **Sign in** to your project as that administrator and start booking. Until
-   the Community web application lands, the interface is the REST API Supabase
-   generates from the schema, or `psql`, or `@ekwo-ai/core`.
+4. **Sign in** to your project as that administrator and start booking — in
+   the web application, [Ekwo Cloud](https://cloud.ekwo.ai), which opens your
+   own instance, or through the REST API Supabase generates from the schema,
+   `psql` or `@ekwo-ai/core`.
 
 5. **Do the four things below**, while the dashboard is still open. The
    installer prints them at the end of a successful run, because three of them
@@ -89,7 +90,7 @@ npx -y ekwo-os@latest init \
   --admin-email "you@example.com" \
   --admin-password "a-long-password" \
   --fiscal-year 2026 \
-  --iban "BE71096123456769" \
+  --bank-identifier "BE71096123456769" \
   --yes
 ```
 
@@ -150,7 +151,7 @@ first administrator, `init_instance()` and `claim_instance_admin()`, and
 nothing else. The instance row records no country. A flag that only describes
 a company — `--country`, `--company`, `--chart`, `--language`, `--currency`,
 `--fiscal-year`, `--fiscal-year-start`, `--vat-period`, `--filing-period`,
-`--iban`, `--bic`, `--bank-name` — is refused with it, exit code 2, before the
+`--bank-identifier` (and its old spelling `--iban`), `--bic`, `--bank-name` — is refused with it, exit code 2, before the
 database is touched: it would describe nothing.
 
 **`ekwo company new` is `create_company()`**, the function the `create_company`
@@ -273,7 +274,7 @@ and read by a person.
 | 1 | Applies `supabase/migrations/*.sql` in order | Recorded in `supabase_migrations.schema_migrations`, the Supabase CLI's own history table, so `supabase db push` and `ekwo migrate` stay interchangeable |
 | 2 | Applies every reference seed of `supabase/seed/`, in file-name order: `00_currencies.sql`, `00_territories.sql`, `05_framework_generic.sql`, then one `<n>_pack_<cc>.sql` per country pack, in the order of the number each pack declares | The currencies, the territories the tax rules name, the country-less financial statements every chart falls back on, and every country pack of the release — so a company in any of them can be created later without installing anything. They are exactly the seeds `supabase/config.toml` lists (a list `ekwo pack build` writes from `packs/`), so `supabase db push` installs the same set; a test compares both paths row by row. `90_demo_company.sql` is sample data and is never applied here |
 | 3 | Creates the first administrator through the Supabase Auth admin API | See below: a database connection cannot be a signed-in user |
-| 4 | `init_instance()`, `claim_instance_admin()`, the company, `company_members` as owner, `install_country_template()`, the first financial year, and the bank account when an IBAN was given | The six steps of the root README, in the same order, plus the one thing nobody can derive |
+| 4 | `init_instance()`, `claim_instance_admin()`, the company, `company_members` as owner, `install_country_template()`, the first financial year, and the bank account when an identifier was given | The six steps of the root README, in the same order, plus the one thing nobody can derive |
 | 5 | Writes `ekwo.json` | The installation: project URL and schema version. Nothing else, ever — no country, since each company carries its own. A file written by 0.6 or earlier also names a country; it is still read, and the key is taken for nothing |
 | 6 | Asks whether to register with Ekwo | The default answer is no, and no is a supported answer forever |
 
@@ -323,7 +324,7 @@ instead if the account already exists, and no key is needed.
 | `ekwo reverse <entry>` | Undoes a posted entry keyed by hand, through `reverse_entry()`: its mirror, posted and matched against it. By id or by number; `--date` as for `cancel`. |
 | `ekwo payment record` | Money in or out, booked and matched. With `--doc`, against that document. |
 | `ekwo match <transaction> <document>` | A bank statement line pays a document, through `settle_from_statement()`. |
-| `ekwo import <source> <file>…` | Books kept elsewhere — `trial-balance`, `fec`, `journal-items`, `journal-report` — whole or not at all, through `import_books()`, with a correspondence of accounts and journals you save and give back; or a bank statement — `camt.053`, `coda`, `cfonb120` — as pending lines. `--dry-run` rehearses. See [taking over books](#taking-over-books-ekwo-import). |
+| `ekwo import <source> <file>…` | Books kept elsewhere — `trial-balance`, `fec`, `journal-items`, `journal-report`, `transaction-journal`, `xaf` — whole or not at all, through `import_books()`, with a correspondence of accounts and journals you save and give back; or a bank statement — `camt.053`, `coda`, `cfonb120` — as pending lines. `--dry-run` rehearses. See [taking over books](#taking-over-books-ekwo-import). |
 | `ekwo doc list` / `show` | What exists, and with `--unpaid` what is posted and still owed. See [keeping books](#keeping-books). |
 
 There is no `eject`, because there is nothing to eject from. The schema is in
@@ -338,7 +339,7 @@ place, so the output reads the same in a file or a CI log — and takes `--json`
 for a program.
 
 `ekwo help --json` answers the list of commands and, in `usage`, the whole
-text of `--help` without colour: every flag and variable, for an assistant
+text of `--help` without colour: every flag and variable, for an agent
 that reads one document rather than a terminal.
 
 Under `--json` the standard output is **one JSON document and nothing else**;
@@ -572,6 +573,8 @@ ekwo import fec 123456789FEC20251231.txt --mapping map.json --open-years
 ekwo import trial-balance balance.csv --opening-date 2026-01-01 --dry-run --save-mapping map.json
 ekwo import journal-items items.csv accounts.csv partners.csv --dry-run --save-mapping map.json
 ekwo import journal-report report.csv chart.csv --date-order dmy --dry-run --save-mapping map.json
+ekwo import transaction-journal journal.csv account-list.csv --date-order mdy --dry-run --save-mapping map.json
+ekwo import xaf books.xaf --open-years --dry-run --save-mapping map.json
 ekwo import camt.053 statement.xml                 # or coda, cfonb120: pending lines for `ekwo match`
 ```
 
@@ -581,6 +584,8 @@ ekwo import camt.053 statement.xml                 # or coda, cfonb120: pending
 | `fec` | A *fichier des écritures comptables*: the eighteen columns of the arrêté of 29 July 2013, tab or bar separated |
 | `journal-items` | The lines of every entry exported as CSV from the list view of an ERP whose ledger is a table of lines, with the chart of accounts and the partners exported beside it |
 | `journal-report` | A journal report or a general ledger detail, saved as CSV from a cloud service's spreadsheet export, with its Journal ID and Account Code columns, and the chart and the contacts beside it |
+| `transaction-journal` | A transaction journal, saved as CSV from a spreadsheet export: each transaction a run of rows under one date, type and number, closed by its total; the list of accounts beside it |
+| `xaf` | An XML Audit File Financial, version 3.2 or 4.0: the accounts, the parties, the opening balance — on the day the file gives it — and every transaction of a year, in one file |
 | `camt.053`, `coda`, `cfonb120` | A bank statement: its lines, pending, ready for `ekwo match` |
 
 Each reader is a brick of [`packages/formats/`](../formats/README.md), named
@@ -666,13 +671,15 @@ for a statement. [`docs/import.md`](../../docs/import.md) is the long form.
 
 ## `ekwo module`
 
-A module is a Postgres schema beside the socle — `assets` for fixed assets,
-`budgets` for a plan against the ledger. Its migrations travel with this
-package, and `ekwo migrate` applies them by default.
+A module is a Postgres schema beside the socle — `fixed_assets` for fixed assets,
+`budgets` for a plan against the ledger, `tax` for the corporate income tax
+estimated from the books. Its migrations travel with this package, and
+`ekwo migrate` applies them by default.
 
 ```sh
 ekwo module list                          # what this release carries, and what the database holds
 ekwo module migrate [<code>]              # the migrations, and the country seeds they need
+                                          # (the code, `assets`, or the folder, `fixed-assets`)
 ekwo module enable assets --company "…"   # turn it on for one company
 ekwo module disable assets --company "…"  # turn it off; nothing it wrote is deleted
 ```
@@ -688,6 +695,14 @@ schemas. That is a setting of the API, not of the database, so `ekwo module
 enable` prints the line to add — Supabase dashboard → Project Settings → API,
 or `[api] schemas` in `supabase/config.toml`.
 
+**When a release renames a module's schema**, `ekwo migrate` applies the
+rename and says so: the exposed schemas of the project still name the old one,
+and only the operator can change that. The fixed assets module moved from
+`assets` to `fixed_assets` in its version 2.0.0 — replace one with the other in
+Project Settings → API. Its code, `assets`, is what `ekwo module` takes, and
+never changes; [`modules/fixed-assets/README.md`](../../modules/fixed-assets/README.md#upgrading-from-version-1-of-the-module)
+is the whole upgrade.
+
 **Before `supabase db push`**, run `ekwo migrate --no-modules`. The Supabase
 CLI knows the socle's migration files and not a module's, so it would report
 them as history it has no file for.
@@ -814,7 +829,8 @@ statements, the sentences the country requires on an invoice, the translations,
 and a year of books with the figures it produces. The compiler turns one into
 `supabase/seed/<n>_pack_<cc>.sql`, which is committed — and, where a pack
 carries a section for a module, into
-`supabase/seed/modules/<code>/<n>_pack_<cc>.sql`, applied by the module
+`supabase/seed/modules/<section>/<n>_pack_<cc>.sql` — `fixed_assets` for the
+fixed assets module — applied by the module
 migration runner and by nothing else.
 
 ```sh
@@ -915,8 +931,8 @@ dashboard under Connect → Session pooler, is the form that is never derived.
 | `--fiscal-year-start <date>` | The day that year opens, as `YYYY-MM-DD`. Needed only where the pack names no usual opening month (`defaults.fiscal_year_default`). |
 | `--currency <code>` | Currency of the company. Defaults to the pack's `defaults.currency`. |
 | `--language <xx>` | Language of the books, two letters. Defaults to `country_defaults.language_default`, which the pack fills. It decides which label of the pack lands on each account; the others are kept in `name_i18n`. |
-| `--iban <iban>` | Creates the main bank account, wired to the bank journal and its ledger account. Omitted, no bank account is created and `ekwo doctor` says so. |
-| `--bic <bic>` | Optional, on that account. |
+| `--bank-identifier <value>` | Creates the main bank account, wired to the bank journal and its ledger account. What it is written in is the country's: an IBAN, an ABA routing number and an account number (`"021000021 123456789"`), a sort code and an account number, a BSB, an IFSC, a CLABE… `ekwo pack describe <cc>` names it, and it is checked. A country whose pack declares none is asked for an account number as the bank wrote it. `--iban` is the old spelling and is refused where the banks do not use IBANs. Omitted, no bank account is created and `ekwo doctor` says so. |
+| `--bic <bic>` | Optional, on that account, for a bank that has one. |
 | `--bank-name <name>` | Optional. It also names the account in the books. |
 | `--demo` | Also load the sample company. |
 | `--register` | Register without being asked. `--register-email` sets the address. |
@@ -1060,7 +1076,7 @@ node packages/cli/dist/bin.js init \
   --country BE --chart default --language fr \
   --org "Scratch" --company "Scratch BV" \
   --admin-email "you@example.com" --admin-password "a-long-password" \
-  --fiscal-year 2026 --iban "BE71096123456769" --yes
+  --fiscal-year 2026 --bank-identifier "BE71096123456769" --yes
 
 # 2. Everything should be green, and nothing pending.
 node packages/cli/dist/bin.js status --db-url "$URL"