shutro-erp 0.3.5 → 0.3.7

package/dist/pos/module.js

@@ -8,6 +8,7 @@ import { accountingShutro } from '../accounting/index.js';
 import { contactsShutro } from '../contacts/index.js';
 import { messagingShutro } from '../messaging/index.js';
 import { productShutro } from '../product/index.js';
+import { emitting } from '../server/index.js';
 import { orm } from '../server/orm.js';
 import { check, compute, defineModel, defineModule, f, method, records, } from './.kosh/bindings.js';
 import { bookSessions } from './accounting.js';
@@ -30,6 +31,12 @@ export const PosShop = defineModel('pos.shop', {
     archivable: true,
     access: { 'pos.cashier': ['read'], 'pos.manager': [...ALL, 'export'] },
     fields: {
+        /** Its prices (RFC 0028 §3.1): the shop's price list, else list prices; a customer's own list wins. */
+        pricelist: f.many2one('product.pricelist', {
+            ondelete: 'restrict',
+            label: 'Price list',
+            help: 'The till prices products by this list; a sale for a customer with a list of their own uses theirs.',
+        }),
         name: f.char({ required: true }),
         /** Prices on the register include the taxes (a shop) or not (a wholesale counter). */
         pricesIncludeTax: f.boolean({ default: true, label: 'Prices include taxes' }),
@@ -44,6 +51,16 @@ export const PosShop = defineModel('pos.shop', {
             label: 'Cash difference account',
         }),
     },
+    methods: {
+        /**
+         * The key of the receipt template each of these shops prints (`<module>.<key>`). The Counter's own here; a
+         * localization overrides it (`l10n_bd_pos`: the Mushak 6.3 receipt for shops that issue it).
+         */
+        receiptTemplate: method('pos.shop', async function () {
+            const shops = this;
+            return new Map(shops.ids.map((id) => [id, 'pos.receipt']));
+        }),
+    },
 });
 /** How a shop takes money: cash, a card terminal, mobile money, a transfer; each to its journal. */
 export const PosPaymentMethod = defineModel('pos.payment.method', {
@@ -55,7 +72,11 @@ export const PosPaymentMethod = defineModel('pos.payment.method', {
     fields: {
         shop: f.many2one('pos.shop', { required: true, ondelete: 'cascade' }),
         name: f.char({ required: true }),
-        kind: f.selection({ cash: 'Cash', card: 'Card', mobile: 'Mobile money', transfer: 'Bank transfer' }, { required: true, default: 'cash' }),
+        kind: f.selection({ cash: 'Cash', card: 'Card', mobile: 'Mobile money', transfer: 'Bank transfer' }, {
+            required: true,
+            default: 'cash',
+            help: 'The kind of payment; only cash payments count toward the cash expected in the drawer.',
+        }),
         journal: f.many2one('account.journal', { ondelete: 'restrict' }),
         sequence: f.integer({ required: true, default: 10 }),
     },
@@ -86,6 +107,7 @@ export const PosSession = defineModel('pos.session', {
             scale: 2,
             store: true,
             label: 'Cash expected',
+            help: 'The opening cash plus the cash taken on paid sales, less the change given back.',
             ...compute('pos.session', 'expectedCash', [
                 'openingCash',
                 'orders.state',
@@ -112,6 +134,7 @@ export const PosSession = defineModel('pos.session', {
             scale: 2,
             store: true,
             label: 'Difference',
+            help: 'The cash counted at closing less the cash expected; negative when cash is missing.',
             ...compute('pos.session', 'closingDifference', ['closingCash', 'expectedCash'], (sessions) => {
                 for (const s of sessions)
                     s.closingDifference =
@@ -134,6 +157,7 @@ export const PosSession = defineModel('pos.session', {
             scale: 2,
             store: true,
             label: 'Sold',
+            help: 'The total of the session’s paid sales.',
             ...compute('pos.session', 'total', ['orders.state', 'orders.total'], (sessions) => {
                 for (const s of sessions)
                     s.total = [...s.orders]
@@ -142,10 +166,11 @@ export const PosSession = defineModel('pos.session', {
             }),
         }),
         state: f.state({
+            help: 'Open while the cashier sells; closed once the cash in the drawer is counted.',
             states: { open: 'Open', closed: 'Closed' },
             initial: 'open',
             transitions: {
-                close: {
+                close: emitting('pos.session.closed', {
                     from: ['open'],
                     to: 'closed',
                     guard: records('pos.session', async (sessions) => sessions.filter((s) => s.closingCash === null)),
@@ -163,7 +188,7 @@ export const PosSession = defineModel('pos.session', {
                         await env.asSuperuser({ reason: 'counter session books' }, (su) => bookSessions(su, sessions.ids));
                         await env.model('pos.session').browse(sessions.ids).closed();
                     }),
-                },
+                }),
             },
         }),
     },
@@ -256,6 +281,7 @@ export const PosOrder = defineModel('pos.order', {
             scale: 2,
             store: true,
             label: 'Untaxed',
+            help: 'The sum of the lines’ amounts before taxes.',
             ...compute('pos.order', 'amountUntaxed', ['lines.subtotal'], (orders) => {
                 for (const o of orders)
                     o.amountUntaxed = [...o.lines].reduce((sum, l) => sum.plus(l.subtotal ?? ZERO), ZERO);
@@ -265,6 +291,7 @@ export const PosOrder = defineModel('pos.order', {
             scale: 2,
             store: true,
             label: 'Taxes',
+            help: 'The sum of the taxes on the lines.',
             ...compute('pos.order', 'amountTax', ['lines.taxAmount'], (orders) => {
                 for (const o of orders)
                     o.amountTax = [...o.lines].reduce((sum, l) => sum.plus(l.taxAmount ?? ZERO), ZERO);
@@ -274,6 +301,7 @@ export const PosOrder = defineModel('pos.order', {
             scale: 2,
             store: true,
             label: 'Total',
+            help: 'What the customer pays: the untaxed amount plus the taxes.',
             ...compute('pos.order', 'total', ['amountUntaxed', 'amountTax'], (orders) => {
                 for (const o of orders)
                     o.total = (o.amountUntaxed ?? ZERO).plus(o.amountTax ?? ZERO);
@@ -283,6 +311,7 @@ export const PosOrder = defineModel('pos.order', {
             scale: 2,
             store: true,
             label: 'Paid',
+            help: 'The sum of the payments received for the sale.',
             ...compute('pos.order', 'amountPaid', ['payments.amount'], (orders) => {
                 for (const o of orders)
                     o.amountPaid = [...o.payments].reduce((sum, p) => sum.plus(p.amount), ZERO);
@@ -293,6 +322,7 @@ export const PosOrder = defineModel('pos.order', {
             scale: 2,
             store: true,
             label: 'Change',
+            help: 'What the cashier gives back when the payments exceed the total.',
             ...compute('pos.order', 'change', ['amountPaid', 'total'], (orders) => {
                 for (const o of orders) {
                     const over = (o.amountPaid ?? ZERO).minus(o.total ?? ZERO);
@@ -301,6 +331,7 @@ export const PosOrder = defineModel('pos.order', {
             }),
         }),
         state: f.state({
+            help: 'Being paid while the sale is at the register; paid once the payments cover the total, or voided when it is abandoned.',
             states: { draft: 'Being paid', paid: 'Paid', void: 'Voided' },
             initial: 'draft',
             transitions: {
@@ -363,8 +394,20 @@ export const PosOrderLine = defineModel('pos.order.line', {
         priceUnit: f.decimal({ scale: 2, required: true, default: '0', label: 'Unit price' }),
         discount: f.decimal({ scale: 2, required: true, default: '0', label: 'Discount %' }),
         taxes: f.many2many('account.tax', { relation: 'pos_line_tax_rel' }),
-        subtotal: f.decimal({ scale: 2, store: true, label: 'Untaxed', ...lineAmounts }),
-        taxAmount: f.decimal({ scale: 2, store: true, label: 'Tax', ...lineAmounts }),
+        subtotal: f.decimal({
+            scale: 2,
+            store: true,
+            label: 'Untaxed',
+            help: 'The line’s amount before taxes, after the discount.',
+            ...lineAmounts,
+        }),
+        taxAmount: f.decimal({
+            scale: 2,
+            store: true,
+            label: 'Tax',
+            help: 'The taxes on this line, after the discount.',
+            ...lineAmounts,
+        }),
     },
 });
 export const PosOrderPayment = defineModel('pos.order.payment', {
@@ -380,6 +423,7 @@ export const PosOrderPayment = defineModel('pos.order.payment', {
         /** The method's kind, kept on the payment so a session's cash adds up without a second hop. */
         kind: f.selection({ cash: 'Cash', card: 'Card', mobile: 'Mobile money', transfer: 'Bank transfer' }, {
             store: true,
+            help: 'The kind of the payment’s method, copied from the method.',
             ...compute('pos.order.payment', 'kind', ['method.kind'], (payments) => {
                 for (const p of payments)
                     p.kind = p.method.kind;

package/dist/pos/routes.js

@@ -12,6 +12,7 @@
  */
 import { mailerFromEnv } from '../mail/index.js';
 import { messengerFromEnv } from '../notify/index.js';
+import { priceFor } from '../product/index.js';
 import { documentFields, renderDocument } from '../reporting/index.js';
 import { HttpProblem, publicApiModels } from '../server/index.js';
 import { orm } from '../server/orm.js';
@@ -28,6 +29,31 @@ export function registerCounterRoutes(context, options = {}) {
     const messenger = 'messenger' in options ? options.messenger : messengerFromEnv();
     const models = publicApiModels(context.registry);
     const fields = documentFields(models);
+    /** The receipt template of a sale: its shop's (`pos.shop.receiptTemplate()`), as the cashier may read it. */
+    const receiptTemplateOf = async (env, id) => {
+        const [order] = await env
+            .model('pos.order')
+            .browse([id])
+            .load({ session: ['shop'] });
+        const shop = order?.session?.shop?.id;
+        const keys = shop === undefined
+            ? new Map()
+            : await env.model('pos.shop').browse([shop]).receiptTemplate();
+        const key = (shop === undefined ? undefined : keys.get(shop)) ?? 'pos.receipt';
+        const find = async (k) => (await (await env.model('report.template').search({ where: { key: k }, limit: 1 })).load([])).read(['id', 'name', 'layout', 'scope'])[0];
+        const template = (await find(key)) ?? (await find('pos.receipt'));
+        if (template === undefined)
+            throw new HttpProblem(409, 'no-template', 'No receipt template', 'Run the apps\u2019 defaults.');
+        return template;
+    };
+    // `GET /api/v1/counter/orders/:id/receipt-template`: the template its receipt prints with (the shop decides).
+    app.get('/api/v1/counter/orders/:id/receipt-template', async (request) => {
+        const id = idOf(request.params.id, 'id');
+        return request.env(async (raw) => {
+            const template = await receiptTemplateOf(raw, id);
+            return { id: template['id'], name: template['name'] };
+        });
+    });
     // `POST /api/v1/counter/orders/:id/receipt` `{ email?, phone? }`: the receipt sent — the document by email,
     // a summary by text; what was sent is said back.
     app.post('/api/v1/counter/orders/:id/receipt', async (request) => {
@@ -47,9 +73,7 @@ export function registerCounterRoutes(context, options = {}) {
             if (email !== '') {
                 if (mailer === undefined)
                     throw new HttpProblem(409, 'no-mailer', 'No email set up', 'Set SMTP_URL to send receipts by email.');
-                const [template] = (await (await env.model('report.template').search({ where: { key: 'pos.receipt' }, limit: 1 })).load([])).read(['id', 'name', 'layout', 'scope']);
-                if (template === undefined)
-                    throw new HttpProblem(409, 'no-template', 'No receipt template', 'Run the apps\u2019 defaults.');
+                const template = await receiptTemplateOf(env, id);
                 const rendered = await renderDocument(env, model, template, fields, { ids: [id] }, 'html');
                 await mailer.send({
                     to: email,
@@ -70,29 +94,49 @@ export function registerCounterRoutes(context, options = {}) {
     });
     app.get('/api/v1/counter/shops', async (request) => request.env(async (raw) => {
         const env = raw;
-        const shops = await (await env.model('pos.shop').search({})).load({ methods: true });
+        const shops = await (await env.model('pos.shop').search({})).load({
+            methods: true,
+            pricelist: true,
+        });
         return {
             shops: shops.map((s) => ({
                 id: s.id,
                 name: s.name,
                 pricesIncludeTax: s.pricesIncludeTax,
                 receiptFooter: s.receiptFooter,
+                pricelist: s.pricelist?.id ?? null,
                 methods: [...s.methods].map((m) => ({ id: m.id, name: m.name, kind: m.kind })),
             })),
         };
     }));
+    // `GET /api/v1/counter/catalogue?shop=`: the products on sale, at the shop's prices (its price list).
     app.get('/api/v1/counter/catalogue', async (request) => request.env(async (raw) => {
         const env = raw;
+        const shopId = Number(request.query?.shop);
+        const [shop] = Number.isSafeInteger(shopId) && shopId > 0
+            ? await env
+                .model('pos.shop')
+                .browse([shopId])
+                .load({ pricelist: true })
+            : [];
+        const list = shop?.pricelist?.id ?? null;
+        const today = env.today();
         const products = await (await env
             .model('product.product')
             .search({ where: { saleOk: true }, order: ['name asc'], limit: 2000 })).load({ taxes: true, category: true, uom: true, image: true });
+        const prices = new Map();
+        if (list !== null)
+            for (const p of products)
+                prices.set(p.id, (await priceFor(env, list, p.id, '1', today)).price);
         return {
             products: products.map((p) => ({
                 id: p.id,
                 name: p.name,
                 code: p.code,
                 barcode: p.barcode,
-                price: p.listPrice.toString(),
+                price: (list === null
+                    ? p.listPrice
+                    : (prices.get(p.id) ?? p.listPrice)).toString(),
                 category: p.category?.name ?? null,
                 uom: p.uom?.name ?? null,
                 image: p.image?.id ?? null,
@@ -157,9 +201,35 @@ export function registerCounterRoutes(context, options = {}) {
             const [current] = await env
                 .model('pos.session')
                 .browse([session])
-                .load({ shop: true });
+                .load({ shop: { pricelist: true } });
             if (current === undefined)
                 throw new HttpProblem(404, 'missing-record', 'Not found', 'No such session.');
+            // The customer's own price list, else the shop's (RFC 0028 §3.1).
+            const customer = input.partner === undefined || input.partner === null
+                ? null
+                : idOf(input.partner, 'partner');
+            // A customer's price list is Sales' field: read when Sales is installed.
+            let own = null;
+            if (customer !== null)
+                try {
+                    const partners = env.model('res.partner');
+                    const [row] = (await partners.browse([customer]).load(['pricelist'])).read([
+                        'pricelist',
+                    ]);
+                    own = typeof row?.['pricelist'] === 'number' ? row['pricelist'] : null;
+                }
+                catch {
+                    own = null; // Sales is not installed: no customer lists
+                }
+            const list = own ?? current.shop.pricelist?.id ?? null;
+            const today = env.today();
+            const listed = new Map();
+            for (const l of input.lines)
+                if (text(l.priceUnit) === '' && list !== null) {
+                    const quantity = text(l.quantity) || '1';
+                    listed.set(`${String(l.product)}:${quantity}`, (await priceFor(env, list, idOf(l.product, 'product'), quantity, today))
+                        .price);
+                }
             const products = await env
                 .model('product.product')
                 .browse(input.lines.map((l) => idOf(l.product, 'product')))
@@ -183,7 +253,10 @@ export function registerCounterRoutes(context, options = {}) {
                                 product: product.id,
                                 name: product.name,
                                 quantity: orm.toDecimal(text(l.quantity) || '1'),
-                                priceUnit: orm.toDecimal(text(l.priceUnit) || product.listPrice.toString()),
+                                priceUnit: text(l.priceUnit) !== ''
+                                    ? orm.toDecimal(text(l.priceUnit))
+                                    : (listed.get(`${String(l.product)}:${text(l.quantity) || '1'}`) ??
+                                        product.listPrice),
                                 discount: orm.toDecimal(text(l.discount) || '0'),
                                 taxes: { set: [...product.taxes].map((t) => t.id) },
                             };

package/dist/pos/web/Register.js

@@ -204,11 +204,8 @@ export function Register({ api }) {
     });
     const printReceipt = async (sale) => {
         try {
-            const { templates } = await api.call('GET', '/api/v1/models/pos.order/documents');
-            const template = templates.find((tpl) => tpl.name === 'Receipt') ??
-                templates.find((tpl) => tpl.scope === 'record');
-            if (template === undefined)
-                throw new Error(t('noReceiptTemplate'));
+            // The shop's receipt (a Mushak 6.3 receipt where the shop issues them).
+            const template = await api.call('GET', `/api/v1/counter/orders/${sale.id}/receipt-template`);
             const file = await api.download(`/api/v1/models/pos.order/documents/${template.id}`, {
                 ids: [sale.id],
             });

package/dist/pos_stock/.kosh/bindings.js

@@ -1,4 +1,4 @@
-// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: b32a210a7e48fcbc
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: af4eb6b5269b81cc
 // Bindings of module `pos_stock`: 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';