@ekwo-ai/core

TypeScript row types and a typed client for the Ekwo OS accounting schema.

• Types of the whole schema, hand written so they stay readable: accounts, journals, entries and lines, documents and lines, taxes and tax postings, and the row shapes the report functions return.
• The French FEC lives in @ekwo-ai/fec, which is MIT and depends on nothing. It is no longer re-exported here: import it from there.
• A thin client over the functions that carry the accounting rules — post_document, reconcile, trial_balance, vat_return, fec_lines. Everything else is a table, and Supabase already exposes those as REST.
• No runtime dependency of its own. @supabase/supabase-js is an optional peer; @ekwo-ai/fec is there because generateFec() on the client writes the file it has just fetched.

Install

npm install @ekwo-ai/core

Usage

import { EkwoClient } from '@ekwo-ai/core';
import { fecFileName } from '@ekwo-ai/fec';
import { createClient } from '@supabase/supabase-js';

const ekwo = new EkwoClient(createClient(url, key));

const entry = await ekwo.postDocument(documentId);
await ekwo.reconcile(receivableLineId, bankLineId);

const balance = await ekwo.trialBalance({ companyId, from: '2026-01-01', to: '2026-12-31' });
const boxes   = await ekwo.vatReturn({ companyId, from: '2026-07-01', to: '2026-09-30' });
const aged    = await ekwo.agedBalance(companyId, '2026-09-30', 'receivable');

const fec = await ekwo.generateFec({ companyId, from: '2026-01-01', to: '2026-12-31' });
await writeFile(fecFileName('123456789', '2026-12-31'), fec, 'utf8');

Without a Supabase client, format the file yourself from the rows of fec_lines():

import { checkFec, fromQueryRow, generateFec } from '@ekwo-ai/fec';

const lines = rows.map(fromQueryRow);
const violations = checkFec(lines);   // [] when the file is clean
const file = generateFec(lines, { decimalSeparator: ',', fieldSeparator: '|' });

API

| Export | Description | |---|---| | EkwoClient | Wrapper over the accounting functions of the schema. | | initInstance, claimInstanceAdmin | Record the installation and take the first administrator seat. | | registerInstance, unregisterInstance | Opt into being reachable by Ekwo, and out again. Never required. | | ACCOUNT_TYPES, internalGroup(type) | The eighteen account types and their balance-sheet group. | | isRegistered(instance) | Whether the operator opted into registering with Ekwo. | | isSale, isCreditNote, isAccountable | Document type predicates. | | createContact, createDocument, addDocumentLine, updateDocumentLines, postDocument, recordPayment, reconcile, settleFromStatement, listDocuments, getDocument, … | Keeping the books, once for every surface: the functions the MCP server and the ekwo command line both call. Each takes a Backend — five operations, select insert update remove rpc — that the caller implements over whatever reaches the database as a user. No accounting rule is in them; the schema holds those. | | BooksError, isRefusalState, socleCode, isServiceRoleKey | What an error of that layer looks like, what counts as the database refusing, and the one key no surface accepts. | | Types | Instance, InstanceAdmin, MemberRole, CompanyRole, Account, Journal, Entry, EntryLine, EkwoDocument, DocumentLine, Tax, TaxPosting, Contact, TrialBalanceRow, AgedBalanceRow, VatReturnRow, … |

Amounts come back from Postgres as strings, and the types say so: numeric is carried as Decimal = string rather than rounded into a float on the way in.

Licence

AGPL-3.0-only © Ekwo AI.