shutro-erp 0.2.0 → 0.3.0

package/dist/accounting/demo.js

@@ -3,7 +3,7 @@
  * and vendor bills with VAT, one invoice paid in full and one in part, so the aging, the trial balance and the
  * reconciliation page have something to show.
  */
-import { idByName } from '../modules-sdk/index.js';
+import { idByName, maybeIdByName } from '../modules-sdk/index.js';
 import { orm } from '../server/orm.js';
 import { installChart, installedChart } from './chart.js';
 import { registerPayment } from './payments.js';
@@ -49,7 +49,7 @@ const BILLS = [
     },
 ];
 async function document(env, context, kind, journal, currency, doc) {
-    const vat = await idByName(env, 'account.tax', kind === 'out_invoice' ? 'VAT 15%' : 'VAT 15% (purchases)');
+    const vat = await maybeIdByName(env, 'account.tax', kind === 'out_invoice' ? 'VAT 15%' : 'VAT 15% (purchases)');
     const lines = [];
     for (const l of doc.lines)
         lines.push({
@@ -58,7 +58,7 @@ async function document(env, context, kind, journal, currency, doc) {
             name: l.product,
             quantity: l.quantity,
             priceUnit: l.price,
-            tax: orm.asId(vat, 'account.tax'),
+            taxes: { set: vat === null ? [] : [orm.asId(vat, 'account.tax')] },
         });
     const created = await env.model('account.move').create([
         {
@@ -77,10 +77,11 @@ async function document(env, context, kind, journal, currency, doc) {
 export async function accountingDemo(context) {
     const chart = await context.system('chart of accounts', async (raw) => {
         const env = raw;
+        // A localization (l10n_bd) installs its chart with the app; without one, the generic chart.
         if ((await installedChart(env)) !== null)
             return 'the installed chart';
-        await installChart(env, 'bd');
-        return 'the Bangladesh chart';
+        await installChart(env, 'generic');
+        return 'the generic chart';
     });
     const journal = async (env, code) => {
         const found = await env.model('account.journal').search({ where: { code }, limit: 1 });

package/dist/accounting/index.d.ts

@@ -1,9 +1,9 @@
 import { defineModule } from '../modules-sdk/index.js';
 import type { Env } from './.kosh/bindings.js';
-export { CHARTS, type ChartInstalled, ChartInstalledError, type ChartTemplate, installChart, installedChart, installImmutability, } from './chart.js';
+export { type AccountSpec, CHARTS, type Chart, type ChartInstalled, ChartInstalledError, type ChartTemplate, COMMON_ACCOUNTS, chartsOf, DEFAULT_ACCOUNTS, type Defaults, installChart, installedChart, installImmutability, installLocalization, type LocalizationInstalled, localizationsOf, } from './chart.js';
 export { type AgingRow, agingReport, type Closed, closeFiscalYear, readSettings, reopenFiscalYear, type Settings, updateSettings, } from './closing.js';
-export { ACCOUNT_TYPES, AccountAccount, AccountFiscalYear, AccountFullReconcile, AccountJournal, AccountMove, AccountMoveLine, AccountPartialReconcile, AccountPayment, AccountPaymentTerm, AccountPaymentTermLine, type AccountType, accountingShutro, addDays, CompanyAccounting, JOURNAL_TYPES, type JournalType, MOVE_KINDS, type MoveKind, NUMBER_FIELD, REVERSED_KIND, ResCurrencyRate, TaxAccounts, } from './module.js';
-export { openLines, type ReconcileResult, type RegisterInput, reconcile, registerPayment, unreconcile, } from './payments.js';
+export { ACCOUNT_TYPES, AccountAccount, AccountFiscalYear, AccountFullReconcile, AccountJournal, AccountMove, AccountMoveLine, AccountPartialReconcile, AccountPayment, AccountPaymentTerm, AccountPaymentTermLine, AccountPaymentWithholding, AccountTaxComponent, type AccountType, AccountWithholding, accountingShutro, addDays, CompanyAccounting, fiscalYearOf, isRefund, JOURNAL_TYPES, type JournalType, MOVE_KINDS, type MoveKind, NUMBER_FIELD, owedToUs, PartnerWithholdings, REVERSED_KIND, ResBankAccount, ResCurrencyRate, type SupplyScope, supplyScope, TaxAccounts, } from './module.js';
+export { openLines, proposeWithholdings, type ReconcileResult, type RegisterInput, reconcile, registerPayment, unreconcile, type WithholdingProposal, } from './payments.js';
 export interface Reversed {
     readonly id: number;
     readonly name: string;

package/dist/accounting/index.js

@@ -18,16 +18,16 @@ import { permissions } from '../permissions/index.js';
 import { product } from '../product/index.js';
 import { reporting } from '../reporting/index.js';
 import { HttpProblem } from '../server/index.js';
-import { action, form, list, pivot, search } from '../views/index.js';
-import { CHARTS, ChartInstalledError, installChart, installedChart, installImmutability, } from './chart.js';
+import { action, field, form, list, pivot, search } from '../views/index.js';
+import { ChartInstalledError, chartsOf, installChart, installedChart, installImmutability, installLocalization, localizationsOf, } from './chart.js';
 import { agingReport, closeFiscalYear, readSettings, reopenFiscalYear, updateSettings, } from './closing.js';
 import { accountingDemo } from './demo.js';
-import { AccountAccount, AccountFiscalYear, AccountJournal, AccountMove, AccountMoveLine, AccountPayment, AccountPaymentTerm, accountingShutro, REVERSED_KIND, ResCurrencyRate, } from './module.js';
-import { openLines, reconcile, registerPayment, unreconcile } from './payments.js';
-export { CHARTS, ChartInstalledError, installChart, installedChart, installImmutability, } from './chart.js';
+import { AccountAccount, AccountFiscalYear, AccountJournal, AccountMove, AccountMoveLine, AccountPayment, AccountPaymentTerm, AccountWithholding, accountingShutro, REVERSED_KIND, ResBankAccount, ResCurrencyRate, } from './module.js';
+import { openLines, proposeWithholdings, reconcile, registerPayment, unreconcile, } from './payments.js';
+export { CHARTS, ChartInstalledError, COMMON_ACCOUNTS, chartsOf, DEFAULT_ACCOUNTS, installChart, installedChart, installImmutability, installLocalization, localizationsOf, } from './chart.js';
 export { agingReport, closeFiscalYear, readSettings, reopenFiscalYear, updateSettings, } from './closing.js';
-export { ACCOUNT_TYPES, AccountAccount, AccountFiscalYear, AccountFullReconcile, AccountJournal, AccountMove, AccountMoveLine, AccountPartialReconcile, AccountPayment, AccountPaymentTerm, AccountPaymentTermLine, accountingShutro, addDays, CompanyAccounting, JOURNAL_TYPES, MOVE_KINDS, NUMBER_FIELD, REVERSED_KIND, ResCurrencyRate, TaxAccounts, } from './module.js';
-export { openLines, reconcile, registerPayment, unreconcile, } from './payments.js';
+export { ACCOUNT_TYPES, AccountAccount, AccountFiscalYear, AccountFullReconcile, AccountJournal, AccountMove, AccountMoveLine, AccountPartialReconcile, AccountPayment, AccountPaymentTerm, AccountPaymentTermLine, AccountPaymentWithholding, AccountTaxComponent, AccountWithholding, accountingShutro, addDays, CompanyAccounting, fiscalYearOf, isRefund, JOURNAL_TYPES, MOVE_KINDS, NUMBER_FIELD, owedToUs, PartnerWithholdings, REVERSED_KIND, ResBankAccount, ResCurrencyRate, supplyScope, TaxAccounts, } from './module.js';
+export { openLines, proposeWithholdings, reconcile, registerPayment, unreconcile, } from './payments.js';
 /**
  * Reverses a posted entry: a new entry in the same journal with every line negated, linked both ways, posted when
  * asked. The original is never touched beyond its `reversedBy` link.
@@ -35,7 +35,7 @@ export { openLines, reconcile, registerPayment, unreconcile, } from './payments.
 export async function reverseMove(env, id, options = {}) {
     const moves = env.model('account.move');
     const [m] = await moves.browse([id]).load({
-        lines: { account: true, partner: true, product: true, tax: true },
+        lines: { account: true, partner: true, product: true, taxes: true },
         journal: true,
         partner: true,
         currency: true,
@@ -85,7 +85,7 @@ export async function reverseMove(env, id, options = {}) {
                         quantity: l.quantity,
                         priceUnit: l.priceUnit,
                         discount: l.discount,
-                        tax: l.tax?.id ?? null,
+                        taxes: { set: [...l.taxes].map((t) => t.id) },
                         debit: '0',
                         credit: '0',
                     })),
@@ -103,7 +103,6 @@ export async function reverseMove(env, id, options = {}) {
         state: reversal?.state ?? 'draft',
     };
 }
-const TEMPLATES = Object.keys(CHARTS);
 export const accounting = defineModule({
     shutro: accountingShutro,
     kosh: '^0.1.0',
@@ -134,14 +133,14 @@ export const accounting = defineModule({
             label: 'Customer invoices',
             views: ['list', 'form'],
             viewIds: { list: 'account.move.invoice.list', form: 'account.move.invoice.form' },
-            domain: { kind: { in: ['out_invoice', 'out_refund'] } },
+            domain: { kind: { in: ['out_invoice', 'out_refund', 'out_debit'] } },
             defaults: { kind: 'out_invoice' },
         }),
         'accounting.action_vendor_bills': action(AccountMove, {
             label: 'Vendor bills',
             views: ['list', 'form'],
             viewIds: { list: 'account.move.invoice.list', form: 'account.move.invoice.form' },
-            domain: { kind: { in: ['in_invoice', 'in_refund'] } },
+            domain: { kind: { in: ['in_invoice', 'in_refund', 'in_debit'] } },
             defaults: { kind: 'in_invoice' },
         }),
         'accounting.action_moves': action(AccountMove, {
@@ -242,6 +241,14 @@ export const accounting = defineModule({
             label: 'Fiscal years',
             views: ['list', 'form'],
         }),
+        'accounting.action_withholdings': action(AccountWithholding, {
+            label: 'Withholdings',
+            views: ['list', 'form'],
+        }),
+        'accounting.action_banks': action(ResBankAccount, {
+            label: 'Bank accounts',
+            views: ['list', 'form'],
+        }),
         'accounting.action_rates': action(ResCurrencyRate, {
             label: 'Currency rates',
             views: ['list', 'form'],
@@ -368,6 +375,20 @@ export const accounting = defineModule({
             action: 'accounting.action_fiscal_years',
             sequence: 3,
         },
+        {
+            id: 'accounting.withholdings',
+            parent: 'accounting.configuration',
+            label: 'Withholdings',
+            action: 'accounting.action_withholdings',
+            sequence: 2.5,
+        },
+        {
+            id: 'accounting.banks',
+            parent: 'accounting.configuration',
+            label: 'Bank accounts',
+            action: 'accounting.action_banks',
+            sequence: 3.5,
+        },
         {
             id: 'accounting.rates',
             parent: 'accounting.configuration',
@@ -398,7 +419,85 @@ export const accounting = defineModule({
             ],
         },
     ],
+    // Which withholdings apply to a contact (VDS, TDS), next to their roles (RFC 0016).
+    viewExtensions: [
+        // A tax's accounts, reverse charge's payable account, and its components (CGST / SGST / IGST).
+        {
+            view: 'account.tax.form',
+            operations: [
+                {
+                    insertAfter: 'amount',
+                    nodes: [
+                        {
+                            kind: 'group',
+                            id: 'tax_accounts',
+                            children: [
+                                field({ field: 'account', id: 'tax_account' }),
+                                field({ field: 'refundAccount', id: 'tax_refund_account' }),
+                                field({ field: 'reverseChargeAccount', id: 'tax_reverse_charge_account' }),
+                            ],
+                        },
+                        {
+                            kind: 'lines',
+                            id: 'components',
+                            field: 'components',
+                            columns: [
+                                field({ field: 'name', id: 'component_name' }),
+                                field({ field: 'code', id: 'component_code' }),
+                                field({ field: 'share', id: 'component_share' }),
+                                field({ field: 'scope', id: 'component_scope' }),
+                                field({ field: 'account', id: 'component_account' }),
+                                field({ field: 'refundAccount', id: 'component_refund_account' }),
+                                field({ field: 'reverseChargeAccount', id: 'component_reverse_charge_account' }),
+                            ],
+                        },
+                    ],
+                },
+            ],
+        },
+        {
+            view: 'res.partner.form',
+            operations: [
+                { append: 'roles', nodes: [field({ field: 'withholdings', id: 'withholdings' })] },
+            ],
+        },
+    ],
     documents: [
+        {
+            key: 'withholding_certificate',
+            name: 'Withholding certificate',
+            model: 'account.payment',
+            layout: {
+                paper: 'A4',
+                header: '{{company.name}}',
+                footer: 'Page {{page}} of {{pages}}',
+                blocks: [
+                    { kind: 'heading', id: 'title', text: 'Certificate of withholding at source', level: 1 },
+                    {
+                        kind: 'fields',
+                        id: 'payment',
+                        items: [
+                            { label: 'Payment', bind: 'name' },
+                            { label: 'Date', bind: 'date' },
+                            { label: 'Paid to', bind: 'partner.name' },
+                            { label: 'Amount paid', bind: 'amount' },
+                            { label: 'Withheld', bind: 'amountWithheld' },
+                        ],
+                    },
+                    {
+                        kind: 'table',
+                        id: 'withheld',
+                        bind: 'withholdings',
+                        columns: [
+                            { label: 'Withholding', bind: 'withholding.name' },
+                            { label: 'Base', bind: 'base', align: 'end' },
+                            { label: 'Amount', bind: 'amount', align: 'end', sum: true },
+                        ],
+                    },
+                    { kind: 'text', id: 'in_words', text: 'Withheld: {{amountWithheld|words}}' },
+                ],
+            },
+        },
         {
             key: 'invoice',
             name: 'Invoice',
@@ -444,7 +543,7 @@ export const accounting = defineModule({
                             { label: 'Quantity', bind: 'quantity', align: 'end' },
                             { label: 'Unit price', bind: 'priceUnit', align: 'end' },
                             { label: 'Discount %', bind: 'discount', align: 'end' },
-                            { label: 'Tax', bind: 'tax.name' },
+                            { label: 'Tax', bind: 'taxAmount', align: 'end' },
                             { label: 'Subtotal', bind: 'subtotal', align: 'end', sum: true },
                         ],
                     },
@@ -458,7 +557,9 @@ export const accounting = defineModule({
                             { label: 'Total', bind: 'amountTotal' },
                         ],
                     },
+                    { kind: 'text', id: 'in_words', text: '{{amountTotal|words}}' },
                     { kind: 'text', id: 'terms', text: '{{paymentTerm.note}}' },
+                    { kind: 'text', id: 'payment', text: '{{paymentDetails}}' },
                     { kind: 'text', id: 'notes', text: '{{narration}}' },
                 ],
             },
@@ -491,7 +592,7 @@ export const accounting = defineModule({
                 ],
             },
             sheet: [
-                k.group('party', ['partner', 'kind', 'invoiceOrigin', 'ref']),
+                k.group('party', ['partner', 'kind', 'invoiceOrigin', 'ref', 'debitOf', 'placeOfSupply']),
                 k.group('dates', ['date', 'dateDue', 'paymentTerm', 'journal']),
                 k.lines('lines', [
                     'product',
@@ -500,7 +601,7 @@ export const accounting = defineModule({
                     'quantity',
                     'priceUnit',
                     'discount',
-                    'tax',
+                    'taxes',
                     'subtotal',
                 ], { readonlyWhen: { state: { ne: 'draft' } } }),
                 k.group('totals', [
@@ -570,11 +671,11 @@ export const accounting = defineModule({
             measures: [{ sum: 'balance' }],
             comparison: { field: 'date', mode: 'yoy' },
         }),
+        // The tax lines of posted documents: each with the base its tax was computed on (SD in the VAT's base).
         'account.move.line.vat': pivot(AccountMoveLine, {
             rows: ['taxReport'],
-            cols: ['lineKind'],
             measures: [
-                { sum: 'subtotal', label: 'Base' },
+                { sum: 'taxBase', label: 'Base' },
                 { sum: 'balance', label: 'Amount' },
             ],
         }),
@@ -601,8 +702,15 @@ export const accounting = defineModule({
             },
             sheet: [
                 k.group('who', ['partner', 'kind', 'journal', 'date']),
-                k.group('how_much', ['currency', 'amount', 'memo', 'move']),
+                k.group('how_much', ['currency', 'amount', 'amountWithheld', 'memo', 'move']),
                 k.group('what', ['documents'], { label: 'Pays', columns: 1 }),
+                k.lines('withholdings', [
+                    { field: 'withholding', id: 'withheld_by' },
+                    { field: 'base', id: 'withheld_base' },
+                    { field: 'amount', id: 'withheld_amount' },
+                ], {
+                    readonlyWhen: { state: { ne: 'draft' } },
+                }),
             ],
             readonlyWhen: { state: { ne: 'draft' } },
             chatter: true,
@@ -681,6 +789,24 @@ export const accounting = defineModule({
             header: { buttons: [] },
             sheet: [k.group('main', ['name', 'dateFrom', 'dateTo', 'state', 'lockDate'])],
         })),
+        'account.withholding.list': list(AccountWithholding, {
+            columns: ['name', 'direction', 'base', 'rate', 'threshold', 'account'],
+        }),
+        'account.withholding.form': form(AccountWithholding, (k) => ({
+            sheet: [
+                k.group('withholding', ['name', 'direction', 'sequence']),
+                k.group('amount', ['base', 'rate', 'threshold', 'account']),
+            ],
+        })),
+        'res.bank.account.list': list(ResBankAccount, {
+            columns: ['bank', 'branch', 'number', 'routing', 'currency'],
+        }),
+        'res.bank.account.form': form(ResBankAccount, (k) => ({
+            sheet: [
+                k.group('bank_details', ['bank', 'branch', 'routing', 'swift']),
+                k.group('account_details', ['number', 'holder', 'currency', 'sequence']),
+            ],
+        })),
         'res.currency.rate.list': list(ResCurrencyRate, {
             columns: ['date', 'currency', 'rate', 'company'],
             defaultOrder: ['date desc'],
@@ -700,7 +826,11 @@ export const accounting = defineModule({
                 entries: { label: 'Journal entries', domain: { kind: 'entry' }, group: 'kind' },
                 invoices: {
                     label: 'Invoices and bills',
-                    domain: { kind: { in: ['out_invoice', 'out_refund', 'in_invoice', 'in_refund'] } },
+                    domain: {
+                        kind: {
+                            in: ['out_invoice', 'out_refund', 'out_debit', 'in_invoice', 'in_refund', 'in_debit'],
+                        },
+                    },
                     group: 'kind',
                 },
             },
@@ -760,13 +890,23 @@ export const accounting = defineModule({
         demo: accountingDemo,
     },
     routes: (context) => {
+        // The charts: the generic one and the installed localizations' (RFC 0016).
+        const charts = chartsOf(context.registry.loaded.modules);
+        const localizations = localizationsOf(context.registry.loaded.modules);
         context.app.post('/api/v1/accounting/charts/install', async (request) => {
             const template = request.body?.template;
-            if (typeof template !== 'string' || !TEMPLATES.includes(template))
-                throw new HttpProblem(400, 'invalid-template', 'Unknown chart template', `template must be one of ${TEMPLATES.join(', ')}.`);
+            if (typeof template !== 'string' || !charts.has(template))
+                throw new HttpProblem(400, 'invalid-template', 'Unknown chart template', `template must be one of ${[...charts.keys()].join(', ')}.`);
             return request.env(async (env) => {
                 try {
-                    return await installChart(env, template);
+                    const localization = localizations.get(template);
+                    if (localization === undefined)
+                        return await installChart(env, template, charts.get(template));
+                    // A country's chart comes with the rest of its localization (taxes, withholdings, fiscal year).
+                    if ((await installedChart(env)) !== null)
+                        throw new ChartInstalledError((await installedChart(env)));
+                    const done = await installLocalization(env, localization);
+                    return { ...done.chart, localization: done };
                 }
                 catch (error) {
                     if (error instanceof ChartInstalledError)
@@ -777,8 +917,30 @@ export const accounting = defineModule({
         });
         context.app.get('/api/v1/accounting/charts', async (request) => request.env(async (env) => ({
             installed: await installedChart(env),
-            templates: TEMPLATES.map((t) => ({ code: t, label: CHARTS[t].label })),
+            templates: [...charts].map(([code, chart]) => ({ code, label: chart.label })),
         })));
+        // What a payment of these documents should withhold (RFC 0016): the register-payment dialog shows it first.
+        const withholdingsOf = (input) => {
+            if (input === undefined)
+                return undefined;
+            if (!Array.isArray(input))
+                throw new HttpProblem(400, 'invalid-body', 'Invalid request', 'withholdings is a list.');
+            return input.map((w) => {
+                const row = (w ?? {});
+                const withholding = Number(row.withholding);
+                const amount = String(row.amount ?? '');
+                if (!Number.isInteger(withholding) || withholding <= 0 || !/^\d+(\.\d+)?$/.test(amount))
+                    throw new HttpProblem(400, 'invalid-body', 'Invalid request', 'Each withholding is { withholding: id, amount: "decimal" }.');
+                return { withholding, amount };
+            });
+        };
+        context.app.post('/api/v1/accounting/payments/propose', async (request) => {
+            const moves = request.body?.moves;
+            const ids = Array.isArray(moves) ? moves.map(Number) : [];
+            if (ids.length === 0 || ids.some((id) => !Number.isInteger(id) || id <= 0))
+                throw new HttpProblem(400, 'invalid-body', 'Invalid request', 'moves is a list of document ids.');
+            return request.env((env) => proposeWithholdings(env, ids));
+        });
         context.app.post('/api/v1/accounting/payments/register', async (request) => {
             const body = (request.body ?? {});
             const moves = Array.isArray(body.moves) ? body.moves.map(Number) : [];
@@ -797,6 +959,7 @@ export const accounting = defineModule({
                 date: body.date === undefined ? undefined : String(body.date),
                 amount: body.amount === undefined ? undefined : String(body.amount),
                 memo: body.memo === undefined ? undefined : String(body.memo),
+                withholdings: withholdingsOf(body.withholdings),
             }), { write: true });
         });
         const lineIds = (body) => {
@@ -855,6 +1018,18 @@ export const accounting = defineModule({
         context.app.get('/api/v1/accounting/settings', async (request) => request.env((env) => readSettings(env)));
         context.app.put('/api/v1/accounting/settings', async (request) => {
             const body = (request.body ?? {});
+            const code = (v, name, pattern, example) => {
+                if (v === undefined)
+                    return undefined;
+                if (v === null || v === '')
+                    return null;
+                const value = String(v).toUpperCase();
+                if (!pattern.test(value))
+                    throw new HttpProblem(400, 'invalid-body', 'Invalid request', `${name} is like ${example}.`);
+                return value;
+            };
+            const country = code(body.country, 'country', /^[A-Z]{2}$/, 'IN');
+            const state = code(body.state, 'state', /^[A-Z]{2}-[A-Z0-9]{1,3}$/, 'IN-MH');
             const date = (v, name) => {
                 if (v === undefined)
                     return undefined;
@@ -869,6 +1044,8 @@ export const accounting = defineModule({
             return request.env((env) => updateSettings(env, {
                 ...(lockDate === undefined ? {} : { lockDate }),
                 ...(taxLockDate === undefined ? {} : { taxLockDate }),
+                ...(country === undefined ? {} : { country }),
+                ...(state === undefined ? {} : { state }),
             }), { write: true });
         });
         context.app.post('/api/v1/accounting/fiscal-years/:id/close', async (request) => {