shutro-erp 0.2.1 → 0.3.0

package/dist/accounting/payments.d.ts

@@ -51,9 +51,34 @@ export interface RegisterInput {
     readonly moves: readonly number[];
     readonly journal: number;
     readonly date?: string | undefined;
+    /** The money paid; by default what is due less what is withheld. */
     readonly amount?: string | undefined;
     readonly memo?: string | undefined;
+    /** What to withhold (see {@link proposeWithholdings}); none by default. */
+    readonly withholdings?: readonly {
+        readonly withholding: number;
+        readonly amount: string;
+    }[] | undefined;
 }
+export interface WithholdingProposal {
+    /** What the documents still owe. */
+    readonly residual: string;
+    readonly currency: string;
+    readonly withholdings: readonly {
+        readonly withholding: number;
+        readonly name: string;
+        readonly base: string;
+        readonly amount: string;
+    }[];
+    /** The money to pay: the residual less the withholdings. */
+    readonly amount: string;
+}
+/**
+ * The withholdings a payment of `moves` should keep back (RFC 0016 §5.1): those of the partner in the payment's
+ * direction (vendor bills: `vendor`; our invoices: `customer`), for documents whose total reaches their threshold,
+ * on the documents' untaxed amount, tax or total — prorated to what is still due — rounded to the currency.
+ */
+export declare function proposeWithholdings(env: Env, moves: readonly number[]): Promise<WithholdingProposal>;
 /** A payment for posted documents of one partner and currency, with their residual as the default amount. */
 export declare function registerPayment(env: Env, input: RegisterInput): Promise<{
     id: number;

package/dist/accounting/payments.js

@@ -9,6 +9,7 @@
  */
 import { HttpProblem } from '../server/index.js';
 import { orm } from '../server/orm.js';
+import { owedToUs } from './module.js';
 const fail = (model, fields, problem, hint) => new orm.ValidationError(model, fields, problem, hint);
 /** The open (not fully reconciled) lines of a reconcilable account, oldest due first. */
 export async function openLines(env, ids) {
@@ -331,6 +332,7 @@ export async function postPayments(payments) {
         currency: true,
         company: { currency: true, accountReceivable: true, accountPayable: true },
         documents: { lines: { account: true } },
+        withholdings: { withholding: { account: true } },
     });
     for (const p of loaded) {
         if (p.journal.type !== 'cash' && p.journal.type !== 'bank')
@@ -352,7 +354,7 @@ export async function postPayments(payments) {
                 throw fail('account.payment', ['documents'], `${d.name} is not from ${p.partner.name}.`, "Pay one partner's documents at a time.");
             if (d.currency.id !== p.currency.id)
                 throw fail('account.payment', ['documents'], `${d.name} is in another currency.`, "Pay in the document's currency.");
-            const incoming = d.kind === 'out_invoice' || d.kind === 'in_refund';
+            const incoming = owedToUs(d.kind);
             if (incoming !== (p.kind === 'inbound'))
                 throw fail('account.payment', ['documents'], `${d.name} is not ${p.kind === 'inbound' ? 'money to receive' : 'money to send'}.`, 'Check the direction.');
             for (const l of d.lines)
@@ -360,6 +362,25 @@ export async function postPayments(payments) {
                     docLineIds.push(l.id);
         }
         const inbound = p.kind === 'inbound';
+        // Withheld (VDS, TDS): the documents are settled by the money plus what was kept back (RFC 0016).
+        let withheld = orm.toDecimal(0);
+        const withheldLines = [];
+        for (const w of p.withholdings) {
+            const kept = w.amount.amount;
+            if (kept.lte(0))
+                continue;
+            withheld = withheld.plus(kept);
+            withheldLines.push({
+                account: w.withholding.account.id,
+                partner: p.partner.id,
+                name: w.withholding.name,
+                // Paying a vendor: a liability to the state (credit). Paid by a customer: a receivable from it (debit).
+                amountCurrency: inbound ? kept : kept.neg(),
+                debit: '0',
+                credit: '0',
+            });
+        }
+        const settled = amount.plus(withheld);
         const created = await env.model('account.move').create([
             {
                 journal: p.journal.id,
@@ -383,10 +404,11 @@ export async function postPayments(payments) {
                             account: counterpart.id,
                             partner: p.partner.id,
                             name: p.memo ?? 'Payment',
-                            amountCurrency: inbound ? amount.neg() : amount,
+                            amountCurrency: inbound ? settled.neg() : settled,
                             debit: '0',
                             credit: '0',
                         },
+                        ...withheldLines,
                     ],
                 },
             },
@@ -415,6 +437,68 @@ export async function postPayments(payments) {
         }
     }
 }
+/**
+ * The withholdings a payment of `moves` should keep back (RFC 0016 §5.1): those of the partner in the payment's
+ * direction (vendor bills: `vendor`; our invoices: `customer`), for documents whose total reaches their threshold,
+ * on the documents' untaxed amount, tax or total — prorated to what is still due — rounded to the currency.
+ */
+export async function proposeWithholdings(env, moves) {
+    const docs = await env
+        .model('account.move')
+        .browse(moves.map((id) => orm.asId(id, 'account.move')))
+        .load({ partner: { withholdings: true }, currency: true });
+    const first = docs.first();
+    if (docs.length === 0)
+        throw fail('account.payment', ['documents'], 'No documents to pay.', 'Choose a posted document.');
+    const inbound = owedToUs(first.kind);
+    const unit = first.currency.rounding;
+    const round = (d) => d.div(unit).toDecimalPlaces(0, orm.Decimal.ROUND_HALF_UP).times(unit);
+    let residual = orm.toDecimal(0);
+    const byWithholding = new Map();
+    for (const d of docs) {
+        const due = d.amountResidual?.amount ?? orm.toDecimal(0);
+        residual = residual.plus(due);
+        const total = d.amountTotal?.amount ?? orm.toDecimal(0);
+        if (total.isZero())
+            continue;
+        const share = due.div(total); // a partly paid document withholds on what is left
+        for (const w of d.partner?.withholdings ?? []) {
+            if (w.direction !== (inbound ? 'customer' : 'vendor') || total.lt(w.threshold))
+                continue;
+            const whole = w.base === 'tax'
+                ? (d.amountTax?.amount ?? orm.toDecimal(0))
+                : w.base === 'total'
+                    ? total
+                    : (d.amountUntaxed?.amount ?? orm.toDecimal(0));
+            const base = whole.times(share);
+            const entry = byWithholding.get(w.id) ?? {
+                name: w.name,
+                sequence: w.sequence,
+                base: orm.toDecimal(0),
+                amount: orm.toDecimal(0),
+            };
+            entry.base = entry.base.plus(base);
+            entry.amount = entry.amount.plus(base.times(w.rate));
+            byWithholding.set(w.id, entry);
+        }
+    }
+    // In their order (sequence, then as created).
+    const withholdings = [...byWithholding]
+        .sort(([a, x], [b, y]) => x.sequence - y.sequence || a - b)
+        .map(([withholding, w]) => ({
+        withholding,
+        name: w.name,
+        base: round(w.base).toFixed(),
+        amount: round(w.amount).toFixed(),
+    }));
+    const kept = withholdings.reduce((s, w) => s.plus(w.amount), orm.toDecimal(0));
+    return {
+        residual: residual.toFixed(),
+        currency: first.currency.name,
+        withholdings,
+        amount: residual.minus(kept).toFixed(),
+    };
+}
 /** A payment for posted documents of one partner and currency, with their residual as the default amount. */
 export async function registerPayment(env, input) {
     const docs = await env
@@ -430,8 +514,10 @@ export async function registerPayment(env, input) {
             throw fail('account.payment', ['documents'], `${d.name} is a journal entry, not a document.`, 'Pay invoices, bills or credit notes.');
         residual = residual.plus(d.amountResidual?.amount ?? 0);
     }
-    const kind = first.kind === 'out_invoice' || first.kind === 'in_refund' ? 'inbound' : 'outbound';
-    const amount = input.amount ?? residual.toString();
+    const kind = owedToUs(first.kind) ? 'inbound' : 'outbound';
+    const withholdings = input.withholdings ?? [];
+    const kept = withholdings.reduce((s, w) => s.plus(orm.toDecimal(w.amount)), orm.toDecimal(0));
+    const amount = input.amount ?? residual.minus(kept).toString();
     const created = await env.model('account.payment').create([
         {
             kind,
@@ -443,6 +529,12 @@ export async function registerPayment(env, input) {
             memo: input.memo ?? null,
             company: first.company.id,
             documents: { set: docs.ids },
+            withholdings: {
+                create: withholdings.map((w) => ({
+                    withholding: orm.asId(w.withholding, 'account.withholding'),
+                    amount: w.amount,
+                })),
+            },
         },
     ]);
     await created.post();

package/dist/accounting/web/RegisterPayment.d.ts

@@ -1,7 +1,8 @@
 /**
  * "Register payment" on a posted document that is not fully paid (a node component of the invoice form): a
- * dialog with the journal, the date, the amount (the amount due by default) and a memo, posted through
- * `POST /api/v1/accounting/payments/register`; the form reloads afterwards.
+ * dialog with the journal, the date, the withholdings the partner's documents call for (VDS, TDS — proposed by the
+ * server, each amount editable), the amount (what is due less what is withheld, by default) and a memo, posted
+ * through `POST /api/v1/accounting/payments/register`; the form reloads afterwards.
  */
 import { type NodeComponentProps } from '../../ui/index.js';
 import { type ReactElement } from 'react';

package/dist/accounting/web/RegisterPayment.js

@@ -1,21 +1,35 @@
 import { Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 /**
  * "Register payment" on a posted document that is not fully paid (a node component of the invoice form): a
- * dialog with the journal, the date, the amount (the amount due by default) and a memo, posted through
- * `POST /api/v1/accounting/payments/register`; the form reloads afterwards.
+ * dialog with the journal, the date, the withholdings the partner's documents call for (VDS, TDS — proposed by the
+ * server, each amount editable), the amount (what is due less what is withheld, by default) and a memo, posted
+ * through `POST /api/v1/accounting/payments/register`; the form reloads afterwards.
  */
-import { Alert, Button, Dialog, Input, Label, Select } from '../../ui/index.js';
+import { Alert, Button, Dialog, Input, Label, Select, useKosh, } from '../../ui/index.js';
 import { useMutation, useQuery } from '@tanstack/react-query';
 import { useId, useState } from 'react';
 import { useTranslation } from 'react-i18next';
+/** Exact decimal subtraction of decimal strings (no floats): `a - Σ b`, to the cent. */
+function less(a, bs) {
+    const cents = (v) => {
+        const [w = '0', f = ''] = v.trim().split('.');
+        return BigInt(w === '' ? '0' : w) * 100n + BigInt(`${f}00`.slice(0, 2));
+    };
+    const r = bs.reduce((s, b) => s - (/^\d+(\.\d+)?$/.test(b) ? cents(b) : 0n), cents(a));
+    const sign = r < 0n ? '-' : '';
+    const abs = r < 0n ? -r : r;
+    return `${sign}${abs / 100n}.${String(abs % 100n).padStart(2, '0')}`;
+}
 export function RegisterPayment({ api, record, reload }) {
     const { t } = useTranslation('accounting');
+    const { format } = useKosh();
     const id = useId();
     const [open, setOpen] = useState(false);
     const [journal, setJournal] = useState(null);
     const [date, setDate] = useState(new Date().toISOString().slice(0, 10));
     const [amount, setAmount] = useState(null);
     const [memo, setMemo] = useState('');
+    const [kept, setKept] = useState({});
     const [error, setError] = useState(null);
     const journals = useQuery({
         queryKey: ['accounting', 'journals', 'cash-bank'],
@@ -25,17 +39,34 @@ export function RegisterPayment({ api, record, reload }) {
         }),
         enabled: open,
     });
+    const proposal = useQuery({
+        queryKey: ['accounting', 'withholdings', record?.id],
+        queryFn: () => api.call('POST', '/api/v1/accounting/payments/propose', { moves: [record?.id] }),
+        enabled: open,
+    });
+    const withholdings = (proposal.data?.withholdings ?? []).map((w) => ({
+        ...w,
+        amount: kept[w.withholding] ?? w.amount,
+    }));
+    const due = proposal.data?.residual ??
+        record?.['amountResidual']?.amount ??
+        '';
+    const net = less(due, withholdings.map((w) => w.amount));
     const pay = useMutation({
         mutationFn: () => api.call('POST', '/api/v1/accounting/payments/register', {
             moves: [record?.id],
             journal: Number(journal),
             date,
-            ...(amount === null ? {} : { amount }),
+            amount: amount ?? net,
+            withholdings: withholdings
+                .filter((w) => /^\d+(\.\d+)?$/.test(w.amount) && Number(w.amount) > 0)
+                .map((w) => ({ withholding: w.withholding, amount: w.amount })),
             ...(memo === '' ? {} : { memo }),
         }),
         onSuccess: () => {
             setOpen(false);
             setError(null);
+            setKept({});
             reload();
         },
         onError: (e) => setError(e.message),
@@ -44,9 +75,11 @@ export function RegisterPayment({ api, record, reload }) {
         return null;
     if (record['paymentState'] === 'paid')
         return null;
-    const due = record['amountResidual']?.amount ?? '';
     return (_jsxs(_Fragment, { children: [_jsx(Button, { variant: "secondary", onClick: () => setOpen(true), children: t('pay.button') }), _jsx(Dialog, { open: open, onOpenChange: setOpen, title: t('pay.title'), footer: _jsx(Button, { variant: "primary", busy: pay.isPending, disabled: journal === null, onClick: () => pay.mutate(), children: t('pay.confirm') }), children: _jsxs("div", { className: "grid gap-3", children: [error === null ? null : _jsx(Alert, { tone: "danger", children: error }), _jsx(Select, { id: `${id}-journal`, label: t('pay.journal'), value: journal, options: (journals.data?.items ?? []).map((j) => ({
                                 value: String(j.id),
                                 label: `${String(j['code'])} ${String(j['name'])}`,
-                            })), onChange: setJournal }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-date`, children: t('pay.date') }), _jsx(Input, { id: `${id}-date`, type: "date", value: date, onChange: (e) => setDate(e.target.value) })] }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-amount`, children: t('pay.amount') }), _jsx(Input, { id: `${id}-amount`, inputMode: "decimal", value: amount ?? due, onChange: (e) => setAmount(e.target.value) })] }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-memo`, children: t('pay.memo') }), _jsx(Input, { id: `${id}-memo`, value: memo, onChange: (e) => setMemo(e.target.value) })] })] }) })] }));
+                            })), onChange: setJournal }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-date`, children: t('pay.date') }), _jsx(Input, { id: `${id}-date`, type: "date", value: date, onChange: (e) => setDate(e.target.value) })] }), withholdings.length === 0 ? null : (_jsxs("fieldset", { className: "grid gap-2 rounded-md border p-3", children: [_jsx("legend", { className: "px-1 text-sm font-medium", children: t('pay.withheld') }), withholdings.map((w) => (_jsxs("div", { className: "grid gap-1", children: [_jsxs(Label, { htmlFor: `${id}-w${w.withholding}`, children: [w.name, " (", format.decimal(w.base, 2), ")"] }), _jsx(Input, { id: `${id}-w${w.withholding}`, inputMode: "decimal", value: w.amount, onChange: (e) => setKept((k) => ({ ...k, [w.withholding]: e.target.value })) })] }, w.withholding)))] })), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-amount`, children: t('pay.amount') }), _jsx(Input, { id: `${id}-amount`, inputMode: "decimal", value: amount ?? net, onChange: (e) => setAmount(e.target.value) }), withholdings.length === 0 ? null : (_jsx("p", { className: "text-xs text-muted-foreground", children: t('pay.due', {
+                                        amount: format.decimal(due, 2),
+                                        withheld: format.decimal(less('0', withholdings.map((w) => w.amount)).replace('-', ''), 2),
+                                    }) }))] }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-memo`, children: t('pay.memo') }), _jsx(Input, { id: `${id}-memo`, value: memo, onChange: (e) => setMemo(e.target.value) })] })] }) })] }));
 }

package/dist/accounting/web/SettingsPage.js

@@ -22,6 +22,8 @@ export function SettingsPage({ api }) {
     const [template, setTemplate] = useState(null);
     const [lockDate, setLockDate] = useState(null);
     const [taxLockDate, setTaxLockDate] = useState(null);
+    const [country, setCountry] = useState(null);
+    const [state, setState] = useState(null);
     const [message, setMessage] = useState(null);
     const [error, setError] = useState(null);
     const install = useMutation({
@@ -39,6 +41,8 @@ export function SettingsPage({ api }) {
         mutationFn: () => api.call('PUT', '/api/v1/accounting/settings', {
             lockDate: lockDate ?? settings.data?.lockDate ?? null,
             taxLockDate: taxLockDate ?? settings.data?.taxLockDate ?? null,
+            country: country ?? settings.data?.country ?? null,
+            state: state ?? settings.data?.state ?? null,
         }),
         onSuccess: async () => {
             setError(null);
@@ -54,5 +58,5 @@ export function SettingsPage({ api }) {
                         }) })) : (_jsxs("div", { className: "flex flex-wrap items-end gap-2", children: [_jsx(Select, { id: `${id}-chart`, label: t('settings.choose'), className: "w-64", value: template, options: (charts.data?.templates ?? []).map((c) => ({
                                     value: c.code,
                                     label: c.label,
-                                })), onChange: setTemplate }), _jsx(Button, { variant: "primary", disabled: template === null, busy: install.isPending, onClick: () => install.mutate(), children: t('settings.install') })] }))] }), _jsxs("section", { className: "grid gap-3 rounded-lg border p-4", children: [_jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-lock`, children: t('settings.lockDate') }), _jsx(Input, { id: `${id}-lock`, type: "date", value: lockDate ?? current?.lockDate ?? '', onChange: (e) => setLockDate(e.target.value === '' ? null : e.target.value) }), _jsx("p", { className: "text-xs text-muted-foreground", children: t('settings.lockDateHint') })] }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-taxlock`, children: t('settings.taxLockDate') }), _jsx(Input, { id: `${id}-taxlock`, type: "date", value: taxLockDate ?? current?.taxLockDate ?? '', onChange: (e) => setTaxLockDate(e.target.value === '' ? null : e.target.value) }), _jsx("p", { className: "text-xs text-muted-foreground", children: t('settings.taxLockDateHint') })] }), _jsx("div", { children: _jsx(Button, { variant: "primary", busy: save.isPending, onClick: () => save.mutate(), children: t('settings.save') }) })] })] }));
+                                })), onChange: setTemplate }), _jsx(Button, { variant: "primary", disabled: template === null, busy: install.isPending, onClick: () => install.mutate(), children: t('settings.install') })] }))] }), _jsxs("section", { className: "grid gap-3 rounded-lg border p-4", children: [_jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-lock`, children: t('settings.lockDate') }), _jsx(Input, { id: `${id}-lock`, type: "date", value: lockDate ?? current?.lockDate ?? '', onChange: (e) => setLockDate(e.target.value === '' ? null : e.target.value) }), _jsx("p", { className: "text-xs text-muted-foreground", children: t('settings.lockDateHint') })] }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-taxlock`, children: t('settings.taxLockDate') }), _jsx(Input, { id: `${id}-taxlock`, type: "date", value: taxLockDate ?? current?.taxLockDate ?? '', onChange: (e) => setTaxLockDate(e.target.value === '' ? null : e.target.value) }), _jsx("p", { className: "text-xs text-muted-foreground", children: t('settings.taxLockDateHint') })] }), _jsxs("div", { className: "grid gap-3 sm:grid-cols-2", children: [_jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-country`, children: t('settings.country') }), _jsx(Input, { id: `${id}-country`, maxLength: 2, value: country ?? current?.country ?? '', onChange: (e) => setCountry(e.target.value) })] }), _jsxs("div", { className: "grid gap-1", children: [_jsx(Label, { htmlFor: `${id}-state`, children: t('settings.state') }), _jsx(Input, { id: `${id}-state`, maxLength: 6, value: state ?? current?.state ?? '', onChange: (e) => setState(e.target.value) })] }), _jsx("p", { className: "text-xs text-muted-foreground sm:col-span-2", children: t('settings.placeHint') })] }), _jsx("div", { children: _jsx(Button, { variant: "primary", busy: save.isPending, onClick: () => save.mutate(), children: t('settings.save') }) })] })] }));
 }

package/dist/accounting/web/messages.js

@@ -12,6 +12,9 @@ export const messages = {
             lockDateHint: 'Nothing is posted, reversed or matched on or before this date.',
             taxLockDate: 'Tax lock date',
             taxLockDateHint: 'Tax returns are filed up to this date.',
+            country: 'Country (ISO code, e.g. IN)',
+            state: 'State (e.g. IN-MH)',
+            placeHint: 'Where the company is registered: a tax split by state (GST) posts its within-state parts when the place of supply is this state.',
             save: 'Save',
             saved: 'Settings saved.',
         },
@@ -55,6 +58,8 @@ export const messages = {
             memo: 'Memo',
             confirm: 'Pay',
             done: 'Payment {{name}} registered.',
+            withheld: 'Withheld at source',
+            due: 'Due {{amount}}; withheld {{withheld}}.',
         },
     },
     bn: {
@@ -69,6 +74,9 @@ export const messages = {
             lockDateHint: 'এই তারিখ বা তার আগে কিছু পোস্ট, রিভার্স বা মেলানো যাবে না।',
             taxLockDate: 'কর লক তারিখ',
             taxLockDateHint: 'এই তারিখ পর্যন্ত কর রিটার্ন দাখিল হয়েছে।',
+            country: 'দেশ (ISO কোড, যেমন IN)',
+            state: 'রাজ্য (যেমন IN-MH)',
+            placeHint: 'প্রতিষ্ঠান যেখানে নিবন্ধিত: রাজ্যভেদে ভাগ হওয়া কর (GST) সরবরাহের স্থান এই রাজ্য হলে রাজ্যের ভেতরের অংশগুলো পোস্ট করে।',
             save: 'সংরক্ষণ',
             saved: 'সেটিংস সংরক্ষিত।',
         },
@@ -112,6 +120,8 @@ export const messages = {
             memo: 'মন্তব্য',
             confirm: 'পরিশোধ',
             done: 'পেমেন্ট {{name}} নথিভুক্ত হয়েছে।',
+            withheld: 'উৎসে কর্তন',
+            due: 'বাকি {{amount}}; কর্তন {{withheld}}।',
         },
     },
 };