shutro-erp 0.2.1 → 0.3.1

package/dist/account_portal/module.js

@@ -0,0 +1,18 @@
+/**
+ * The data layer of Accounting in the portal (RFC 0015 §5.4): portal users read the posted invoices, credit notes
+ * and bills of their contact and company (the portal's record rule) and nothing else of the ledger.
+ */
+import { accountingShutro } from '../accounting/index.js';
+import { portalRule, portalShutro } from '../portal/index.js';
+import { defineModule, extendModel } from './.kosh/bindings.js';
+export const MovePortal = extendModel('account.move', {
+    access: { 'portal.user': ['read'] },
+    rules: { portal: portalRule('partner') },
+});
+export const accountPortalShutro = defineModule({
+    name: 'account_portal',
+    version: '0.1.0',
+    depends: [accountingShutro, portalShutro],
+    models: [],
+    extensions: [MovePortal],
+});

package/dist/accounting/.kosh/bindings.js

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 5dbc1f9f7f888acd
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: c83d584195f8dd43
 // Bindings of module `accounting`: import the definition API from here to get types scoped to what it can see.
 export { defineModel, defineModule, extendModel, f, replace } from '../../server/orm.js';
 import { definitions } from '../../server/orm.js';

package/dist/accounting/.kosh/schema.d.ts

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 5dbc1f9f7f888acd
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: c83d584195f8dd43
 // Schema view of module `accounting` (RFC 0002 §7.7): the models it owns or depends on, with the extensions it can see.
 import type { F } from '../../server/orm.js';
 
@@ -14,11 +14,15 @@ export interface SchemaView {
   readonly 'account.payment': AccountPayment;
   readonly 'account.payment.term': AccountPaymentTerm;
   readonly 'account.payment.term.line': AccountPaymentTermLine;
+  readonly 'account.payment.withholding': AccountPaymentWithholding;
   readonly 'account.tax': AccountTax;
+  readonly 'account.tax.component': AccountTaxComponent;
+  readonly 'account.withholding': AccountWithholding;
   readonly 'approval.level': ApprovalLevel;
   readonly 'approval.policy': ApprovalPolicy;
   readonly 'approval.request': ApprovalRequest;
   readonly 'audit.event': AuditEvent;
+  readonly 'auth.api_key': AuthApiKey;
   readonly 'auth.credential': AuthCredential;
   readonly 'auth.session': AuthSession;
   readonly 'auth.user_grant': AuthUserGrant;
@@ -38,6 +42,7 @@ export interface SchemaView {
   readonly 'report.schedule': ReportSchedule;
   readonly 'report.spreadsheet': ReportSpreadsheet;
   readonly 'report.template': ReportTemplate;
+  readonly 'res.bank.account': ResBankAccount;
   readonly 'res.company': ResCompany;
   readonly 'res.currency': ResCurrency;
   readonly 'res.currency.rate': ResCurrencyRate;
@@ -163,7 +168,7 @@ export interface AccountMove {
     readonly numberGeneral: F.Char<{ readonly readonly: true; readonly sequence: true }>;
     readonly journal: F.Many2one<'account.journal', { readonly required: true }>;
     readonly date: F.DateOnly<{ readonly required: true; readonly default: true }>;
-    readonly kind: F.Selection<'entry' | 'out_invoice' | 'out_refund' | 'in_invoice' | 'in_refund', { readonly required: true; readonly default: true }>;
+    readonly kind: F.Selection<'entry' | 'out_invoice' | 'out_refund' | 'in_invoice' | 'in_refund' | 'out_debit' | 'in_debit', { readonly required: true; readonly default: true }>;
     readonly partner: F.Many2one<'res.partner'>;
     readonly ref: F.Char;
     readonly currency: F.Many2one<'res.currency', { readonly required: true }>;
@@ -175,6 +180,7 @@ export interface AccountMove {
     readonly amountDebit: F.Monetary<'companyCurrency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly amountCredit: F.Monetary<'companyCurrency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly dateDue: F.DateOnly;
+    readonly paymentDetails: F.Text<{ readonly readonly: true; readonly compute: true }>;
     readonly paymentTerm: F.Many2one<'account.payment.term'>;
     readonly invoiceOrigin: F.Char;
     readonly amountUntaxed: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
@@ -187,6 +193,8 @@ export interface AccountMove {
     readonly postedAt: F.Datetime;
     readonly postedTx: F.Char;
     readonly reversalOf: F.Many2one<'account.move'>;
+    readonly debitOf: F.Many2one<'account.move'>;
+    readonly placeOfSupply: F.Char;
     readonly reversedBy: F.Many2one<'account.move'>;
   };
   readonly methods: AccountMoveMethods;
@@ -228,10 +236,14 @@ export interface AccountMoveLine {
     readonly quantity: F.Decimal<{ readonly default: true }>;
     readonly priceUnit: F.Decimal<{ readonly default: true }>;
     readonly discount: F.Decimal<{ readonly default: true }>;
-    readonly tax: F.Many2one<'account.tax'>;
+    readonly taxes: F.Many2many<'account.tax', { readonly required: true }>;
+    readonly tax: F.Many2one<'account.tax', { readonly readonly: true }>;
     readonly subtotal: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly taxAmount: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly taxLineOf: F.Many2one<'account.tax'>;
+    readonly taxComponent: F.Many2one<'account.tax.component'>;
+    readonly taxReverseCharge: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly taxBase: F.Monetary<'currency'>;
     readonly balance: F.Monetary<'companyCurrency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly posted: F.Bool<{ readonly required: true; readonly readonly: true; readonly default: true; readonly compute: true; readonly store: true }>;
     readonly accountType: F.Selection<'asset_receivable' | 'asset_cash' | 'asset_current' | 'asset_prepayments' | 'asset_fixed' | 'asset_non_current' | 'liability_payable' | 'liability_current' | 'liability_non_current' | 'equity' | 'equity_unaffected' | 'income' | 'income_other' | 'expense' | 'expense_direct_cost' | 'expense_depreciation' | 'off_balance', { readonly readonly: true; readonly compute: true; readonly store: true }>;
@@ -295,6 +307,8 @@ export interface AccountPayment {
     readonly amount: F.Monetary<'currency', { readonly required: true }>;
     readonly memo: F.Char;
     readonly documents: F.Many2many<'account.move', { readonly required: true }>;
+    readonly withholdings: F.One2many<'account.payment.withholding', { readonly required: true }>;
+    readonly amountWithheld: F.Monetary<'currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
     readonly move: F.Many2one<'account.move'>;
     readonly state: F.State<'draft' | 'posted' | 'cancel', { readonly required: true; readonly readonly: true; readonly default: true }>;
   };
@@ -351,6 +365,29 @@ export interface AccountPaymentTermLine {
 export interface AccountPaymentTermLineMethods extends F.Methods<typeof import('../module.js').accountingShutro, 'account.payment.term.line'> {
 }
 
+/** `account.payment.withholding` (owner: accounting). */
+export interface AccountPaymentWithholding {
+  readonly name: 'account.payment.withholding';
+  readonly fields: {
+    readonly id: F.Id<'account.payment.withholding'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly payment: F.Many2one<'account.payment', { readonly required: true }>;
+    readonly withholding: F.Many2one<'account.withholding', { readonly required: true }>;
+    readonly currency: F.Many2one<'res.currency', { readonly readonly: true; readonly compute: true; readonly store: true }>;
+    readonly base: F.Monetary<'currency'>;
+    readonly amount: F.Monetary<'currency', { readonly required: true }>;
+  };
+  readonly methods: AccountPaymentWithholdingMethods;
+}
+
+/** Methods of `account.payment.withholding`: declared ones and transitions. */
+export interface AccountPaymentWithholdingMethods extends F.Methods<typeof import('../module.js').accountingShutro, 'account.payment.withholding'> {
+}
+
 /** `account.tax` (owner: product; extended by: accounting). */
 export interface AccountTax {
   readonly name: 'account.tax';
@@ -364,10 +401,17 @@ export interface AccountTax {
     readonly active: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly name: F.Char<{ readonly required: true; readonly translate: true }>;
     readonly use: F.Selection<'sale' | 'purchase', { readonly required: true; readonly default: true }>;
+    readonly sequence: F.Integer<{ readonly required: true; readonly default: true }>;
+    readonly amountType: F.Selection<'percent' | 'fixed', { readonly required: true; readonly default: true }>;
     readonly rate: F.Decimal<{ readonly required: true; readonly default: true }>;
+    readonly fixedAmount: F.Decimal<{ readonly required: true; readonly default: true }>;
+    readonly affectsBase: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly priceIncluded: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly reverseCharge: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly account: F.Many2one<'account.account'>; // accounting
     readonly refundAccount: F.Many2one<'account.account'>; // accounting
-    readonly priceIncluded: F.Bool<{ readonly required: true; readonly default: true }>; // accounting
+    readonly reverseChargeAccount: F.Many2one<'account.account'>; // accounting
+    readonly components: F.One2many<'account.tax.component', { readonly required: true }>; // accounting
   };
   readonly methods: AccountTaxMethods;
 }
@@ -376,6 +420,60 @@ export interface AccountTax {
 export interface AccountTaxMethods extends F.Methods<typeof import('../../product/index.js').productShutro, 'account.tax'>, F.Methods<typeof import('../module.js').accountingShutro, 'account.tax'> {
 }
 
+/** `account.tax.component` (owner: accounting). */
+export interface AccountTaxComponent {
+  readonly name: 'account.tax.component';
+  readonly fields: {
+    readonly id: F.Id<'account.tax.component'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly tax: F.Many2one<'account.tax', { readonly required: true }>;
+    readonly sequence: F.Integer<{ readonly required: true; readonly default: true }>;
+    readonly name: F.Char<{ readonly required: true; readonly translate: true }>;
+    readonly share: F.Decimal<{ readonly required: true; readonly default: true }>;
+    readonly scope: F.Selection<'always' | 'intra' | 'inter', { readonly required: true; readonly default: true }>;
+    readonly code: F.Char;
+    readonly account: F.Many2one<'account.account'>;
+    readonly refundAccount: F.Many2one<'account.account'>;
+    readonly reverseChargeAccount: F.Many2one<'account.account'>;
+  };
+  readonly methods: AccountTaxComponentMethods;
+}
+
+/** Methods of `account.tax.component`: declared ones and transitions. */
+export interface AccountTaxComponentMethods extends F.Methods<typeof import('../module.js').accountingShutro, 'account.tax.component'> {
+}
+
+/** `account.withholding` (owner: accounting). */
+export interface AccountWithholding {
+  readonly name: 'account.withholding';
+  readonly fields: {
+    readonly id: F.Id<'account.withholding'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly active: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly company: F.Many2one<'res.company', { readonly required: true; readonly default: true }>;
+    readonly name: F.Char<{ readonly required: true; readonly translate: true }>;
+    readonly sequence: F.Integer<{ readonly required: true; readonly default: true }>;
+    readonly direction: F.Selection<'vendor' | 'customer', { readonly required: true; readonly default: true }>;
+    readonly base: F.Selection<'untaxed' | 'tax' | 'total', { readonly required: true; readonly default: true }>;
+    readonly rate: F.Decimal<{ readonly required: true; readonly default: true }>;
+    readonly threshold: F.Decimal<{ readonly required: true; readonly default: true }>;
+    readonly account: F.Many2one<'account.account', { readonly required: true }>;
+  };
+  readonly methods: AccountWithholdingMethods;
+}
+
+/** Methods of `account.withholding`: declared ones and transitions. */
+export interface AccountWithholdingMethods extends F.Methods<typeof import('../module.js').accountingShutro, 'account.withholding'> {
+}
+
 /** `approval.level` (owner: permissions). */
 export interface ApprovalLevel {
   readonly name: 'approval.level';
@@ -482,6 +580,34 @@ export interface AuditEvent {
 export interface AuditEventMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'audit.event'> {
 }
 
+/** `auth.api_key` (owner: base). */
+export interface AuthApiKey {
+  readonly name: 'auth.api_key';
+  readonly fields: {
+    readonly id: F.Id<'auth.api_key'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly name: F.Char<{ readonly required: true }>;
+    readonly user: F.Many2one<'res.users', { readonly required: true }>;
+    readonly tokenHash: F.Char<{ readonly required: true }>;
+    readonly prefix: F.Char<{ readonly required: true }>;
+    readonly scopes: F.Text<{ readonly required: true }>;
+    readonly expiresAt: F.Datetime<{ readonly required: true }>;
+    readonly lastUsedAt: F.Datetime;
+    readonly lastUsedIp: F.Char;
+    readonly revoked: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly issuedBy: F.Many2one<'res.users'>;
+  };
+  readonly methods: AuthApiKeyMethods;
+}
+
+/** Methods of `auth.api_key`: declared ones and transitions. */
+export interface AuthApiKeyMethods extends F.Methods<typeof import('../../server/index.js').baseShutro, 'auth.api_key'> {
+}
+
 /** `auth.credential` (owner: base). */
 export interface AuthCredential {
   readonly name: 'auth.credential';
@@ -820,8 +946,10 @@ export interface ProductProduct {
     readonly standardPrice: F.Decimal<{ readonly required: true; readonly default: true }>;
     readonly saleOk: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly purchaseOk: F.Bool<{ readonly required: true; readonly default: true }>;
-    readonly tax: F.Many2one<'account.tax'>;
-    readonly purchaseTax: F.Many2one<'account.tax'>;
+    readonly taxes: F.Many2many<'account.tax', { readonly required: true }>;
+    readonly purchaseTaxes: F.Many2many<'account.tax', { readonly required: true }>;
+    readonly tax: F.Many2one<'account.tax', { readonly readonly: true }>;
+    readonly purchaseTax: F.Many2one<'account.tax', { readonly readonly: true }>;
     readonly description: F.Text<{ readonly translate: true }>;
   };
   readonly methods: ProductProductMethods;
@@ -956,6 +1084,34 @@ export interface ReportTemplate {
 export interface ReportTemplateMethods extends F.Methods<typeof import('../../reporting/index.js').reportingShutro, 'report.template'> {
 }
 
+/** `res.bank.account` (owner: accounting). */
+export interface ResBankAccount {
+  readonly name: 'res.bank.account';
+  readonly fields: {
+    readonly id: F.Id<'res.bank.account'>;
+    readonly createdAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly updatedAt: F.Datetime<{ readonly required: true; readonly readonly: true }>;
+    readonly createdBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly updatedBy: F.Many2one<'res.users', { readonly readonly: true }>;
+    readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
+    readonly active: F.Bool<{ readonly required: true; readonly default: true }>;
+    readonly company: F.Many2one<'res.company', { readonly required: true; readonly default: true }>;
+    readonly sequence: F.Integer<{ readonly required: true; readonly default: true }>;
+    readonly bank: F.Char<{ readonly required: true }>;
+    readonly branch: F.Char;
+    readonly number: F.Char<{ readonly required: true }>;
+    readonly holder: F.Char;
+    readonly routing: F.Char;
+    readonly swift: F.Char;
+    readonly currency: F.Many2one<'res.currency'>;
+  };
+  readonly methods: ResBankAccountMethods;
+}
+
+/** Methods of `res.bank.account`: declared ones and transitions. */
+export interface ResBankAccountMethods extends F.Methods<typeof import('../module.js').accountingShutro, 'res.bank.account'> {
+}
+
 /** `res.company` (owner: base; extended by: accounting). */
 export interface ResCompany {
   readonly name: 'res.company';
@@ -968,7 +1124,11 @@ export interface ResCompany {
     readonly displayName: F.Char<{ readonly required: true; readonly readonly: true; readonly compute: true }>;
     readonly name: F.Char<{ readonly required: true }>;
     readonly currency: F.Many2one<'res.currency', { readonly required: true }>;
-    readonly chartTemplate: F.Selection<'generic' | 'bd'>; // accounting
+    readonly numberGrouping: F.Selection<'international' | 'lakh', { readonly required: true; readonly default: true }>;
+    readonly fiscalYearStart: F.Integer<{ readonly required: true; readonly default: true }>; // accounting
+    readonly chartTemplate: F.Char; // accounting
+    readonly country: F.Char; // accounting
+    readonly state: F.Char; // accounting
     readonly lockDate: F.DateOnly; // accounting
     readonly taxLockDate: F.DateOnly; // accounting
     readonly accountReceivable: F.Many2one<'account.account'>; // accounting
@@ -1027,7 +1187,7 @@ export interface ResCurrencyRate {
 export interface ResCurrencyRateMethods extends F.Methods<typeof import('../module.js').accountingShutro, 'res.currency.rate'> {
 }
 
-/** `res.partner` (owner: contacts). */
+/** `res.partner` (owner: contacts; extended by: accounting). */
 export interface ResPartner {
   readonly name: 'res.partner';
   readonly fields: {
@@ -1051,17 +1211,19 @@ export interface ResPartner {
     readonly city: F.Char;
     readonly zip: F.Char;
     readonly country: F.Char;
+    readonly state: F.Char;
     readonly taxId: F.Char;
     readonly isCustomer: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly isVendor: F.Bool<{ readonly required: true; readonly default: true }>;
     readonly currency: F.Many2one<'res.currency'>;
     readonly notes: F.Text;
+    readonly withholdings: F.Many2many<'account.withholding', { readonly required: true }>; // accounting
   };
   readonly methods: ResPartnerMethods;
 }
 
 /** Methods of `res.partner`: declared ones and transitions. */
-export interface ResPartnerMethods extends F.Methods<typeof import('../../contacts/index.js').contactsShutro, 'res.partner'> {
+export interface ResPartnerMethods extends F.Methods<typeof import('../../contacts/index.js').contactsShutro, 'res.partner'>, F.Methods<typeof import('../module.js').accountingShutro, 'res.partner'> {
 }
 
 /** `res.users` (owner: base). */
@@ -1083,6 +1245,7 @@ export interface ResUsers {
     readonly companies: F.Many2many<'res.company', { readonly required: true }>;
     readonly lang: F.Char<{ readonly default: true }>;
     readonly tz: F.Char<{ readonly default: true }>;
+    readonly isService: F.Bool<{ readonly required: true; readonly default: true }>;
   };
   readonly methods: ResUsersMethods;
 }

package/dist/accounting/chart.d.ts

@@ -1,14 +1,24 @@
+/**
+ * Charts of accounts (RFC 0009 §5.6) and localizations (RFC 0016 §5.2): the generic template lives here; a country's
+ * comes with its localization module (`l10n_bd`). Installing a template for a company creates its accounts and
+ * journals, links the company's default accounts, and points the taxes at their accounts; installing a
+ * localization also sets the accounts of its own taxes, its withholdings, the fiscal year and the number grouping.
+ * Each is applied once per company. Also here: the database triggers that keep posted entries immutable below the
+ * ORM (raw SQL, deletes), created idempotently with the module's defaults.
+ */
+import type { KoshModule, LocalizationSpec } from '../modules-sdk/index.js';
 import type { Env } from './.kosh/bindings.js';
-import type { AccountType } from './module.js';
-export type ChartTemplate = 'generic' | 'bd';
-interface AccountSpec {
+import { type AccountType } from './module.js';
+/** A chart's code: `generic`, or a localization's key (`bd`). */
+export type ChartTemplate = string;
+export interface AccountSpec {
     readonly code: string;
     readonly name: string;
     readonly type: AccountType;
     readonly reconcile?: boolean;
 }
 /** Which accounts the company's defaults point to, by code. */
-interface Defaults {
+export interface Defaults {
     readonly receivable: string;
     readonly payable: string;
     readonly exchangeGain: string;
@@ -19,7 +29,7 @@ interface Defaults {
     readonly income: string;
     readonly expense: string;
 }
-interface Chart {
+export interface Chart {
     readonly label: string;
     readonly accounts: readonly AccountSpec[];
     readonly defaults: Defaults;
@@ -29,7 +39,16 @@ interface Chart {
         readonly purchase: string;
     };
 }
-export declare const CHARTS: Readonly<Record<ChartTemplate, Chart>>;
+/** The accounts every chart starts from (a localization adds its own). */
+export declare const COMMON_ACCOUNTS: readonly AccountSpec[];
+/** The default accounts of the common set, by code. */
+export declare const DEFAULT_ACCOUNTS: Defaults;
+/** The charts Accounting ships: the generic one. Countries bring theirs (`chartsOf`). */
+export declare const CHARTS: Readonly<Record<string, Chart>>;
+/** Every chart the installed modules offer: the generic one and the localizations'. */
+export declare function chartsOf(modules: readonly KoshModule[]): ReadonlyMap<string, Chart>;
+/** The localizations of the installed modules, by key. */
+export declare function localizationsOf(modules: readonly KoshModule[]): ReadonlyMap<string, LocalizationSpec>;
 export interface ChartInstalled {
     readonly template: ChartTemplate;
     readonly accounts: number;
@@ -43,7 +62,21 @@ export declare function installedChart(env: Env): Promise<ChartTemplate | null>;
  * and the tax accounts of the product module's taxes.
  * @throws {Error} when the company already has a chart (the caller turns it into a 409)
  */
-export declare function installChart(env: Env, template: ChartTemplate): Promise<ChartInstalled>;
+export declare function installChart(env: Env, template: ChartTemplate, chart?: Chart): Promise<ChartInstalled>;
+export interface LocalizationInstalled {
+    readonly localization: string;
+    /** The chart, when the company had none yet. */
+    readonly chart: ChartInstalled | null;
+    readonly taxes: number;
+    readonly withholdings: number;
+    readonly fiscalYear: string | null;
+}
+/**
+ * Sets a company up for a country (RFC 0016 §5.2), once and idempotently: its chart (unless it has one), the
+ * accounts of the localization's taxes, its withholdings (those it lacks, by name), the fiscal year's first month and
+ * the number grouping, and the current fiscal year when there is none. Everything is the company's data afterwards.
+ */
+export declare function installLocalization(env: Env, localization: LocalizationSpec): Promise<LocalizationInstalled>;
 export declare class ChartInstalledError extends Error {
     readonly template: ChartTemplate;
     constructor(template: ChartTemplate);
@@ -54,4 +87,3 @@ export declare class ChartInstalledError extends Error {
  * reversal link, reconciliation marks) stay open.
  */
 export declare function installImmutability(env: Env): Promise<void>;
-export {};

package/dist/accounting/chart.js

@@ -1,12 +1,7 @@
-/**
- * Charts of accounts (RFC 0009 §5.6): the generic template and the Bangladesh one (RFC 0008 decision 2; VAT accounts
- * follow the Mushak structure: output VAT, input VAT, VAT payable, AT, SD). Installing a template for a company
- * creates its accounts and journals, links the company's default accounts, and points the taxes at their accounts.
- * A template is applied once per company. Also here: the database triggers that keep posted entries immutable
- * below the ORM (raw SQL, deletes), created idempotently with the module's defaults.
- */
 import { orm } from '../server/orm.js';
-const COMMON = [
+import { fiscalYearOf } from './module.js';
+/** The accounts every chart starts from (a localization adds its own). */
+export const COMMON_ACCOUNTS = [
     { code: '1000', name: 'Cash', type: 'asset_cash' },
     { code: '1010', name: 'Bank', type: 'asset_cash' },
     { code: '1100', name: 'Accounts receivable', type: 'asset_receivable', reconcile: true },
@@ -35,7 +30,8 @@ const COMMON = [
     { code: '6900', name: 'Exchange loss', type: 'expense' },
     { code: '9999', name: 'Suspense', type: 'asset_current', reconcile: true },
 ];
-const DEFAULTS = {
+/** The default accounts of the common set, by code. */
+export const DEFAULT_ACCOUNTS = {
     receivable: '1100',
     payable: '2000',
     exchangeGain: '4910',
@@ -46,32 +42,16 @@ const DEFAULTS = {
     income: '4000',
     expense: '6300',
 };
+/** The charts Accounting ships: the generic one. Countries bring theirs (`chartsOf`). */
 export const CHARTS = {
     generic: {
         label: 'Generic',
         accounts: [
-            ...COMMON,
+            ...COMMON_ACCOUNTS,
             { code: '2200', name: 'VAT collected', type: 'liability_current' },
             { code: '1300', name: 'VAT paid', type: 'asset_current' },
         ],
-        defaults: DEFAULTS,
-        taxAccounts: { sale: '2200', purchase: '1300' },
-    },
-    bd: {
-        label: 'Bangladesh',
-        accounts: [
-            ...COMMON,
-            // VAT and SD Act 2012 (Mushak): output and input VAT, the net payable, advance tax, supplementary duty.
-            { code: '2200', name: 'Output VAT (Mushak)', type: 'liability_current' },
-            { code: '1300', name: 'Input VAT (Mushak)', type: 'asset_current' },
-            { code: '2210', name: 'VAT payable', type: 'liability_current' },
-            { code: '1310', name: 'Advance tax (AT) receivable', type: 'asset_current' },
-            { code: '2220', name: 'Supplementary duty (SD) payable', type: 'liability_current' },
-            { code: '1320', name: 'Advance income tax (AIT) receivable', type: 'asset_current' },
-            { code: '2230', name: 'Tax deducted at source (TDS) payable', type: 'liability_current' },
-            { code: '2240', name: 'VAT deducted at source (VDS) payable', type: 'liability_current' },
-        ],
-        defaults: DEFAULTS,
+        defaults: DEFAULT_ACCOUNTS,
         taxAccounts: { sale: '2200', purchase: '1300' },
     },
 };
@@ -82,6 +62,20 @@ const JOURNALS = [
     { code: 'BNK', name: 'Bank', type: 'bank', account: 'bank' },
     { code: 'MISC', name: 'Miscellaneous', type: 'general', account: null },
 ];
+/** Every chart the installed modules offer: the generic one and the localizations'. */
+export function chartsOf(modules) {
+    const out = new Map(Object.entries(CHARTS));
+    for (const m of modules) {
+        const l = m.localization;
+        if (l !== undefined)
+            out.set(l.key, { ...l.chart, label: l.label });
+    }
+    return out;
+}
+/** The localizations of the installed modules, by key. */
+export function localizationsOf(modules) {
+    return new Map(modules.flatMap((m) => m.localization === undefined ? [] : [[m.localization.key, m.localization]]));
+}
 /** Already-installed template of the environment's company, or null. */
 export async function installedChart(env) {
     const [company] = await env.model('res.company').browse([env.companyId]).load({});
@@ -92,8 +86,7 @@ export async function installedChart(env) {
  * and the tax accounts of the product module's taxes.
  * @throws {Error} when the company already has a chart (the caller turns it into a 409)
  */
-export async function installChart(env, template) {
-    const chart = CHARTS[template];
+export async function installChart(env, template, chart = CHARTS[template]) {
     const company = env.companyRef;
     const existing = await installedChart(env);
     if (existing !== null)
@@ -149,6 +142,107 @@ export async function installChart(env, template) {
     }
     return { template, accounts: accounts.length, journals: journals.length, taxes: linked };
 }
+/**
+ * Sets a company up for a country (RFC 0016 §5.2), once and idempotently: its chart (unless it has one), the
+ * accounts of the localization's taxes, its withholdings (those it lacks, by name), the fiscal year's first month and
+ * the number grouping, and the current fiscal year when there is none. Everything is the company's data afterwards.
+ */
+export async function installLocalization(env, localization) {
+    const company = env.companyRef;
+    const chartSpec = {
+        ...localization.chart,
+        label: localization.label,
+    };
+    const chart = (await installedChart(env)) === null
+        ? await installChart(env, localization.key, chartSpec)
+        : null;
+    const accountOf = async (code) => {
+        const found = await env.model('account.account').search({ where: { code, company }, limit: 1 });
+        const id = found.ids[0];
+        if (id === undefined)
+            throw new Error(`The ${localization.label} chart has no account ${code}.`);
+        return id;
+    };
+    let taxes = 0;
+    for (const [externalId, code] of Object.entries(localization.taxes ?? {})) {
+        let tax;
+        try {
+            tax = Number(await env.refId('account.tax', externalId));
+        }
+        catch (error) {
+            if (error instanceof orm.UnknownExternalIdError)
+                continue; // removed by the users
+            throw error;
+        }
+        await env
+            .model('account.tax')
+            .browse([orm.asId(tax, 'account.tax')])
+            .write({ account: await accountOf(code) });
+        taxes += 1;
+    }
+    for (const [externalId, target] of Object.entries(localization.components ?? {})) {
+        let component;
+        try {
+            component = Number(await env.refId('account.tax.component', externalId));
+        }
+        catch (error) {
+            if (error instanceof orm.UnknownExternalIdError)
+                continue; // removed by the users
+            throw error;
+        }
+        const codes = typeof target === 'string' ? { account: target } : target;
+        await env
+            .model('account.tax.component')
+            .browse([orm.asId(component, 'account.tax.component')])
+            .write({
+            account: await accountOf(codes.account),
+            ...(codes.reverseCharge === undefined
+                ? {}
+                : { reverseChargeAccount: await accountOf(codes.reverseCharge) }),
+        });
+    }
+    let withholdings = 0;
+    for (const w of localization.withholdings ?? []) {
+        const exists = await env
+            .model('account.withholding')
+            .search({ where: { name: w.name, company }, limit: 1 });
+        if (exists.length > 0)
+            continue;
+        await env.model('account.withholding').create([
+            {
+                name: w.name,
+                direction: w.direction,
+                base: w.base,
+                rate: w.rate,
+                threshold: w.threshold ?? '0',
+                account: await accountOf(w.account),
+                company,
+            },
+        ]);
+        withholdings += 1;
+    }
+    const start = localization.fiscalYearStart ?? 1;
+    await env.asSuperuser({ reason: `localize the company for ${localization.label}` }, (su) => su
+        .model('res.company')
+        .browse([company])
+        .write({
+        fiscalYearStart: start,
+        numberGrouping: localization.grouping ?? 'international',
+        country: localization.country,
+    }));
+    let fiscalYear = null;
+    const years = await env.model('account.fiscal.year').search({ where: { company }, limit: 1 });
+    if (years.length === 0) {
+        const { dateFrom, dateTo } = fiscalYearOf(env.today(), start);
+        const [y, m] = dateFrom.split('-').map(Number);
+        fiscalYear = m === 1 ? String(y) : `${y}–${String(y + 1).slice(2)}`;
+        await env
+            .model('account.fiscal.year')
+            .create([{ name: fiscalYear, dateFrom, dateTo, company }]);
+    }
+    await env.flush(); // the checks run in the caller's scope, not at commit (Shutro request #11)
+    return { localization: localization.key, chart, taxes, withholdings, fiscalYear };
+}
 export class ChartInstalledError extends Error {
     template;
     constructor(template) {

package/dist/accounting/closing.d.ts

@@ -18,13 +18,18 @@ export interface Settings {
     readonly chartTemplate: string | null;
     readonly lockDate: string | null;
     readonly taxLockDate: string | null;
+    /** Where the company is registered (ISO 3166 / 3166-2): taxes split by place of supply compare against it. */
+    readonly country: string | null;
+    readonly state: string | null;
     readonly accounts: Readonly<Record<string, number | null>>;
 }
 export declare function readSettings(env: Env): Promise<Settings>;
-/** The lock dates (managers). */
+/** The lock dates, the company's country and state (managers). */
 export declare function updateSettings(env: Env, input: {
     readonly lockDate?: string | null;
     readonly taxLockDate?: string | null;
+    readonly country?: string | null;
+    readonly state?: string | null;
 }): Promise<Settings>;
 export interface AgingRow {
     readonly partner: number | null;