Merge pull request #562 from frappe/fix-batchwise-inventory

fix: issues with Batch-wise Inventory

backend/database/bespoke.ts

@@ -138,7 +138,7 @@ export class BespokeQueries {
     location?: string,
     fromDate?: string,
     toDate?: string,
-    batchNumber?: string
+    batch?: string
   ): Promise<number | null> {
     const query = db.knex!(ModelNameEnum.StockLedgerEntry)
       .sum('quantity')
@@ -148,8 +148,8 @@ export class BespokeQueries {
       query.andWhere('location', location);
     }
 
-    if (batchNumber) {
-      query.andWhere('batchNumber', batchNumber);
+    if (batch) {
+      query.andWhere('batch', batch);
     }
 
     if (fromDate) {

fyo/core/dbHandler.ts

@@ -313,7 +313,7 @@ export class DatabaseHandler extends DatabaseBase {
     location?: string,
     fromDate?: string,
     toDate?: string,
-    batchNumber?: string
+    batch?: string
   ): Promise<number | null> {
     return (await this.#demux.callBespoke(
       'getStockQuantity',
@@ -321,7 +321,7 @@ export class DatabaseHandler extends DatabaseBase {
       location,
       fromDate,
       toDate,
-      batchNumber
+      batch
     )) as number | null;
   }
 

models/baseModels/Invoice/Invoice.ts

@@ -11,6 +11,7 @@ import {
 import { DEFAULT_CURRENCY } from 'fyo/utils/consts';
 import { ValidationError } from 'fyo/utils/errors';
 import { addItem, getExchangeRate, getNumberSeries } from 'models/helpers';
+import { validateBatch } from 'models/inventory/helpers';
 import { InventorySettings } from 'models/inventory/InventorySettings';
 import { StockTransfer } from 'models/inventory/StockTransfer';
 import { Transactional } from 'models/Transactional/Transactional';
@@ -545,6 +546,7 @@ export abstract class Invoice extends Transactional {
       const item = row.item;
       const quantity = row.stockNotTransferred;
       const trackItem = itemDoc.trackItem;
+      const batch = row.batch || null;
       let rate = row.rate as Money;
 
       if (this.exchangeRate && this.exchangeRate > 1) {
@@ -560,6 +562,7 @@ export abstract class Invoice extends Transactional {
         quantity,
         location,
         rate,
+        batch,
       });
     }
 

models/baseModels/InvoiceItem/InvoiceItem.ts

@@ -29,6 +29,7 @@ export abstract class InvoiceItem extends Doc {
   quantity?: number;
   transferQuantity?: number;
   unitConversionFactor?: number;
+  batch?: string;
 
   tax?: string;
   stockNotTransferred?: number;
@@ -430,9 +431,13 @@ export abstract class InvoiceItem extends Doc {
       !(this.enableDiscounting && !!this.setItemDiscountAmount),
     itemDiscountPercent: () =>
       !(this.enableDiscounting && !this.setItemDiscountAmount),
-    transferUnit: () => !this.enableInventory,
-    transferQuantity: () => !this.enableInventory,
-    unitConversionFactor: () => !this.enableInventory,
+    batch: () => !this.fyo.singles.InventorySettings?.enableBatches,
+    transferUnit: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+    transferQuantity: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+    unitConversionFactor: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
   };
 
   static filters: FiltersMap = {

models/baseModels/Item/Item.ts

@@ -19,7 +19,7 @@ export class Item extends Doc {
   trackItem?: boolean;
   itemType?: 'Product' | 'Service';
   for?: 'Purchases' | 'Sales' | 'Both';
-  hasBatchNumber?: boolean;
+  hasBatch?: boolean;
 
   formulas: FormulaMap = {
     incomeAccount: {
@@ -76,29 +76,6 @@ export class Item extends Doc {
         throw new ValidationError(this.fyo.t`Rate can't be negative.`);
       }
     },
-    hasBatchNumber: async (value: DocValue) => {
-      const { hasBatchNumber } = await this.fyo.db.get(
-        'Item',
-        this.name!,
-        'hasBatchNumber'
-      );
-
-      if (hasBatchNumber && value !== hasBatchNumber) {
-        const itemEntriesInSLE = await this.fyo.db.count(
-          ModelNameEnum.StockLedgerEntry,
-          {
-            filters: { item: this.name! },
-          }
-        );
-
-        if (itemEntriesInSLE > 0) {
-          throw new ValidationError(
-            this.fyo.t`Cannot change value of Has Batch No as Item ${this
-              .name!} already has transactions against it. `
-          );
-        }
-      }
-    },
   };
 
   static getActions(fyo: Fyo): Action[] {
@@ -146,15 +123,17 @@ export class Item extends Doc {
       !this.fyo.singles.AccountingSettings?.enableInventory ||
       this.itemType !== 'Product' ||
       (this.inserted && !this.trackItem),
-    hasBatchNumber: () => !this.trackItem,
     barcode: () => !this.fyo.singles.InventorySettings?.enableBarcodes,
-    uomConversions: () => !this.fyo.singles.AccountingSettings?.enableInventory,
+    hasBatch: () =>
+      !(this.fyo.singles.InventorySettings?.enableBatches && this.trackItem),
+    uomConversions: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
   };
 
   readOnly: ReadOnlyMap = {
     unit: () => this.inserted,
     itemType: () => this.inserted,
     trackItem: () => this.inserted,
-    hasBatchNumber: () => this.inserted,
+    hasBatch: () => this.inserted,
   };
 }

models/index.ts

@@ -26,14 +26,14 @@ import { ShipmentItem } from './inventory/ShipmentItem';
 import { StockLedgerEntry } from './inventory/StockLedgerEntry';
 import { StockMovement } from './inventory/StockMovement';
 import { StockMovementItem } from './inventory/StockMovementItem';
-import { BatchNumber } from './baseModels/BatchNumber/BatchNumber';
+import { Batch } from './inventory/Batch';
 
 export const models = {
   Account,
   AccountingLedgerEntry,
   AccountingSettings,
   Address,
-  BatchNumber,
+  Batch,
   Defaults,
   Item,
   JournalEntry,

models/inventory/Batch.ts

@@ -3,7 +3,7 @@ import {
   ListViewSettings,
 } from 'fyo/model/types';
 
-export class BatchNumber extends Doc {
+export class Batch extends Doc {
   static getListViewSettings(): ListViewSettings {
     return {
       columns: ["name", "expiryDate", "manufactureDate"],

models/inventory/InventorySettings.ts

@@ -1,5 +1,5 @@
 import { Doc } from 'fyo/model/doc';
-import { FiltersMap } from 'fyo/model/types';
+import { FiltersMap, ReadOnlyMap } from 'fyo/model/types';
 import { AccountTypeEnum } from 'models/baseModels/Account/types';
 import { ValuationMethod } from './types';
 
@@ -10,6 +10,8 @@ export class InventorySettings extends Doc {
   stockReceivedButNotBilled?: string;
   costOfGoodsSold?: string;
   enableBarcodes?: boolean;
+  enableBatches?: boolean;
+  enableUomConversions?: boolean;
 
   static filters: FiltersMap = {
     stockInHand: () => ({
@@ -25,4 +27,16 @@ export class InventorySettings extends Doc {
       accountType: AccountTypeEnum['Cost of Goods Sold'],
     }),
   };
+
+  readOnly: ReadOnlyMap = {
+    enableBarcodes: () => {
+      return !!this.enableBarcodes;
+    },
+    enableBatches: () => {
+      return !!this.enableBatches;
+    },
+    enableUomConversions: () => {
+      return !!this.enableUomConversions;
+    },
+  };
 }

models/inventory/StockLedgerEntry.ts

@@ -10,5 +10,5 @@ export class StockLedgerEntry extends Doc {
   location?: string;
   referenceName?: string;
   referenceType?: string;
-  batchNumber?: string;
+  batch?: string;
 }

models/inventory/StockManager.ts

@@ -1,6 +1,5 @@
 import { Fyo, t } from 'fyo';
 import { ValidationError } from 'fyo/utils/errors';
-import { DateTime } from 'luxon';
 import { ModelNameEnum } from 'models/types';
 import { Money } from 'pesa';
 import { StockLedgerEntry } from './StockLedgerEntry';
@@ -133,43 +132,7 @@ export class StockManager {
 
     const date = details.date.toISOString();
     const formattedDate = this.fyo.format(details.date, 'Datetime');
-    const isItemHasBatchNumber = await this.fyo.getValue(
-      'Item',
-      details.item,
-      'hasBatchNumber'
-    );
-
-    if (isItemHasBatchNumber && !this.isCancelled) {
-      if (!details.batchNumber) {
-        throw new ValidationError(
-          t`Please enter Batch Number for ${details.item}`
-        );
-      }
-
-      const itemsInBatch =
-        (await this.fyo.db.getStockQuantity(
-          details.item,
-          details.fromLocation,
-          undefined,
-          date,
-          details.batchNumber
-        )) ?? 0;
-
-      if (details.quantity <= itemsInBatch) return;
-
-      throw new ValidationError(
-        [
-          t`Insufficient Quantity`,
-          t`Additional quantity (${
-            details.quantity - itemsInBatch
-          }) is required in batch ${
-            details.batchNumber
-          } to make the outward transfer of item ${details.item} from ${
-            details.fromLocation
-          } on ${formattedDate}`,
-        ].join('\n')
-      );
-    }
+    const batch = details.batch || undefined;
 
     let quantityBefore =
       (await this.fyo.db.getStockQuantity(
@@ -177,22 +140,24 @@ export class StockManager {
         details.fromLocation,
         undefined,
         date,
-        undefined
+        batch
       )) ?? 0;
 
     if (this.isCancelled) {
       quantityBefore += details.quantity;
     }
 
+    const batchMessage = !!batch ? t` in Batch ${batch}` : '';
+
     if (quantityBefore < details.quantity) {
       throw new ValidationError(
         [
           t`Insufficient Quantity.`,
           t`Additional quantity (${
             details.quantity - quantityBefore
-          }) required to make outward transfer of item ${details.item} from ${
-            details.fromLocation
-          } on ${formattedDate}`,
+          }) required${batchMessage} to make outward transfer of item ${
+            details.item
+          } from ${details.fromLocation} on ${formattedDate}`,
         ].join('\n')
       );
     }
@@ -202,8 +167,9 @@ export class StockManager {
       details.fromLocation,
       details.date.toISOString(),
       undefined,
-      undefined
+      batch
     );
+
     if (quantityAfter === null) {
       // No future transactions
       return;
@@ -217,9 +183,9 @@ export class StockManager {
           t`Transfer will cause future entries to have negative stock.`,
           t`Additional quantity (${
             quantityAfter - quantityRemaining
-          }) required to make outward transfer of item ${details.item} from ${
-            details.fromLocation
-          } on ${formattedDate}`,
+          }) required${batchMessage} to make outward transfer of item ${
+            details.item
+          } from ${details.fromLocation} on ${formattedDate}`,
         ].join('\n')
       );
     }
@@ -244,7 +210,7 @@ class StockManagerItem {
   referenceType: string;
   fromLocation?: string;
   toLocation?: string;
-  batchNumber?: string;
+  batch?: string;
 
   stockLedgerEntries?: StockLedgerEntry[];
 
@@ -259,7 +225,7 @@ class StockManagerItem {
     this.toLocation = details.toLocation;
     this.referenceName = details.referenceName;
     this.referenceType = details.referenceType;
-    this.batchNumber = details.batchNumber;
+    this.batch = details.batch;
 
     this.fyo = fyo;
   }
@@ -312,7 +278,7 @@ class StockManagerItem {
       date: this.date,
       item: this.item,
       rate: this.rate,
-      batchNumber: this.batchNumber,
+      batch: this.batch || null,
       quantity,
       location,
       referenceName: this.referenceName,

models/inventory/StockMovement.ts

@@ -15,6 +15,7 @@ import {
 import { LedgerPosting } from 'models/Transactional/LedgerPosting';
 import { ModelNameEnum } from 'models/types';
 import { Money } from 'pesa';
+import { validateBatch } from './helpers';
 import { StockMovementItem } from './StockMovementItem';
 import { Transfer } from './Transfer';
 import { MovementType } from './types';
@@ -49,6 +50,11 @@ export class StockMovement extends Transfer {
 
   async validate() {
     await super.validate();
+    this.validateManufacture();
+    await validateBatch(this);
+  }
+
+  validateManufacture() {
     if (this.movementType !== MovementType.Manufacture) {
       return;
     }
@@ -109,7 +115,7 @@ export class StockMovement extends Transfer {
       item: row.item!,
       rate: row.rate!,
       quantity: row.quantity!,
-      batchNumber: row.batchNumber!,
+      batch: row.batch!,
       fromLocation: row.fromLocation,
       toLocation: row.toLocation,
     }));

models/inventory/StockMovementItem.ts

@@ -4,6 +4,7 @@ import { Doc } from 'fyo/model/doc';
 import {
   FiltersMap,
   FormulaMap,
+  HiddenMap,
   ReadOnlyMap,
   RequiredMap,
   ValidationMap,
@@ -30,7 +31,7 @@ export class StockMovementItem extends Doc {
   rate?: Money;
   amount?: Money;
   parentdoc?: StockMovement;
-  batchNumber?: string;
+  batch?: string;
 
   get isIssue() {
     return this.parentdoc?.movementType === MovementType.MaterialIssue;
@@ -233,6 +234,16 @@ export class StockMovementItem extends Doc {
     toLocation: () => this.isIssue,
   };
 
+  override hidden: HiddenMap = {
+    batch: () => !this.fyo.singles.InventorySettings?.enableBatches,
+    transferUnit: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+    transferQuantity: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+    unitConversionFactor: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+  };
+
   static createFilters: FiltersMap = {
     item: () => ({ trackItem: true, itemType: 'Product' }),
   };

models/inventory/StockTransfer.ts

@@ -15,6 +15,7 @@ import { addItem, getLedgerLinkAction, getNumberSeries } from 'models/helpers';
 import { LedgerPosting } from 'models/Transactional/LedgerPosting';
 import { ModelNameEnum } from 'models/types';
 import { Money } from 'pesa';
+import { validateBatch } from './helpers';
 import { StockTransferItem } from './StockTransferItem';
 import { Transfer } from './Transfer';
 
@@ -82,7 +83,7 @@ export abstract class StockTransfer extends Transfer {
         item: row.item!,
         rate: row.rate!,
         quantity: row.quantity!,
-        batchNumber: row.batchNumber!,
+        batch: row.batch!,
         fromLocation,
         toLocation,
       };
@@ -151,6 +152,11 @@ export abstract class StockTransfer extends Transfer {
     }
   }
 
+  override async validate(): Promise<void> {
+    await super.validate();
+    await validateBatch(this);
+  }
+
   static getActions(fyo: Fyo): Action[] {
     return [getLedgerLinkAction(fyo, false), getLedgerLinkAction(fyo, true)];
   }

models/inventory/StockTransferItem.ts

@@ -1,7 +1,12 @@
 import { t } from 'fyo';
 import { DocValue } from 'fyo/core/types';
 import { Doc } from 'fyo/model/doc';
-import { FiltersMap, FormulaMap, ValidationMap } from 'fyo/model/types';
+import {
+  FiltersMap,
+  FormulaMap,
+  HiddenMap,
+  ValidationMap,
+} from 'fyo/model/types';
 import { ValidationError } from 'fyo/utils/errors';
 import { ModelNameEnum } from 'models/types';
 import { Money } from 'pesa';
@@ -21,7 +26,7 @@ export class StockTransferItem extends Doc {
   amount?: Money;
   description?: string;
   hsnCode?: number;
-  batchNumber?: string
+  batch?: string;
 
   formulas: FormulaMap = {
     description: {
@@ -200,4 +205,14 @@ export class StockTransferItem extends Doc {
       return { for: ['not in', [itemNotFor]], trackItem: true };
     },
   };
+
+  override hidden: HiddenMap = {
+    batch: () => !this.fyo.singles.InventorySettings?.enableBatches,
+    transferUnit: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+    transferQuantity: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+    unitConversionFactor: () =>
+      !this.fyo.singles.InventorySettings?.enableUomConversions,
+  };
 }

models/inventory/helpers.ts

@@ -1 +1,51 @@
+import { ValidationError } from 'fyo/utils/errors';
+import { Invoice } from 'models/baseModels/Invoice/Invoice';
+import { InvoiceItem } from 'models/baseModels/InvoiceItem/InvoiceItem';
+import { ModelNameEnum } from 'models/types';
+import { StockMovement } from './StockMovement';
+import { StockMovementItem } from './StockMovementItem';
+import { StockTransfer } from './StockTransfer';
+import { StockTransferItem } from './StockTransferItem';
 
+export async function validateBatch(
+  doc: StockMovement | StockTransfer | Invoice
+) {
+  for (const row of doc.items ?? []) {
+    await validateItemRowBatch(row);
+  }
+}
+
+async function validateItemRowBatch(
+  doc: StockMovementItem | StockTransferItem | InvoiceItem
+) {
+  const idx = doc.idx ?? 0 + 1;
+  const item = doc.item;
+  const batch = doc.batch;
+  if (!item) {
+    return;
+  }
+
+  const hasBatch = await doc.fyo.getValue(
+    ModelNameEnum.Item,
+    item,
+    'hasBatch'
+  );
+
+  if (!hasBatch && batch) {
+    throw new ValidationError(
+      [
+        doc.fyo.t`Batch set for row ${idx}.`,
+        doc.fyo.t`Item ${item} is not a batched item`,
+      ].join(' ')
+    );
+  }
+
+  if (hasBatch && !batch) {
+    throw new ValidationError(
+      [
+        doc.fyo.t`Batch not set for row ${idx}.`,
+        doc.fyo.t`Item ${item} is a batched item`,
+      ].join(' ')
+    );
+  }
+}

models/inventory/tests/helpers.ts

@@ -1,5 +1,5 @@
 import { Fyo } from 'fyo';
-import { BatchNumber } from 'models/baseModels/BatchNumber/BatchNumber';
+import { Batch } from 'models/inventory/Batch';
 import { ModelNameEnum } from 'models/types';
 import { StockMovement } from '../StockMovement';
 import { StockTransfer } from '../StockTransfer';
@@ -27,7 +27,7 @@ type Transfer = {
   item: string;
   from?: string;
   to?: string;
-  batchNumber?: string;
+  batch?: string;
   quantity: number;
   rate: number;
 };
@@ -36,22 +36,22 @@ interface TransferTwo extends Omit<Transfer, 'from' | 'to'> {
   location: string;
 }
 
-export function getItem(name: string, rate: number, hasBatchNumber?: boolean) {
-  return { name, rate, trackItem: true, hasBatchNumber };
+export function getItem(name: string, rate: number, hasBatch: boolean = false) {
+  return { name, rate, trackItem: true, hasBatch };
 }
 
-export async function getBatchNumber(
-  schemaName: ModelNameEnum.BatchNumber,
-  batchNumber: string,
+export async function getBatch(
+  schemaName: ModelNameEnum.Batch,
+  batch: string,
   expiryDate: Date,
   manufactureDate: Date,
   fyo: Fyo
-): Promise<BatchNumber> {
+): Promise<Batch> {
   const doc = fyo.doc.getNewDoc(schemaName, {
-    batchNumber,
+    batch,
     expiryDate,
     manufactureDate,
-  }) as BatchNumber;
+  }) as Batch;
   return doc;
 }
 
@@ -83,7 +83,7 @@ export async function getStockMovement(
     item,
     from: fromLocation,
     to: toLocation,
-    batchNumber: batchNumber,
+    batch,
     quantity,
     rate,
   } of transfers) {
@@ -91,7 +91,7 @@ export async function getStockMovement(
       item,
       fromLocation,
       toLocation,
-      batchNumber,
+      batch,
       rate,
       quantity,
     });

models/inventory/tests/testBatches.spec.ts

@@ -0,0 +1,288 @@
+import { assertThrows } from 'backend/database/tests/helpers';
+import { ModelNameEnum } from 'models/types';
+import test from 'tape';
+import { closeTestFyo, getTestFyo, setupTestFyo } from 'tests/helpers';
+import { MovementType } from '../types';
+import { getItem, getSLEs, getStockMovement } from './helpers';
+
+const fyo = getTestFyo();
+
+setupTestFyo(fyo, __filename);
+
+const itemMap = {
+  Pen: {
+    name: 'Pen',
+    rate: 700,
+  },
+  Ink: {
+    name: 'Ink',
+    rate: 50,
+  },
+};
+
+const locationMap = {
+  LocationOne: 'LocationOne',
+  LocationTwo: 'LocationTwo',
+};
+
+const batchMap = {
+  batchOne: {
+    name: 'PN-AB001',
+    manufactureDate: '2022-11-03T09:57:04.528',
+  },
+  batchTwo: {
+    name: 'PN-AB002',
+    manufactureDate: '2022-10-03T09:57:04.528',
+  },
+  batchThree: {
+    name: 'PN-AB003',
+    manufactureDate: '2022-10-03T09:57:04.528',
+  },
+};
+
+test('create dummy items, locations & batches', async (t) => {
+  // Create Items
+  for (const { name, rate } of Object.values(itemMap)) {
+    const item = getItem(name, rate, true);
+    await fyo.doc.getNewDoc(ModelNameEnum.Item, item).sync();
+  }
+
+  // Create Locations
+  for (const name of Object.values(locationMap)) {
+    await fyo.doc.getNewDoc(ModelNameEnum.Location, { name }).sync();
+  }
+
+  // Create Batches
+  for (const batch of Object.values(batchMap)) {
+    const doc = fyo.doc.getNewDoc(ModelNameEnum.Batch, batch);
+    await doc.sync();
+
+    const exists = await fyo.db.exists(ModelNameEnum.Batch, batch.name);
+    t.ok(exists, `${batch.name} exists`);
+  }
+});
+
+test('batched item, create stock movement, material receipt', async (t) => {
+  const { rate } = itemMap.Pen;
+  const stockMovement = await getStockMovement(
+    MovementType.MaterialReceipt,
+    new Date('2022-11-03T09:57:04.528'),
+    [
+      {
+        item: itemMap.Pen.name,
+        to: locationMap.LocationOne,
+        quantity: 2,
+        batch: batchMap.batchOne.name,
+        rate,
+      },
+      {
+        item: itemMap.Pen.name,
+        to: locationMap.LocationOne,
+        quantity: 1,
+        batch: batchMap.batchTwo.name,
+        rate,
+      },
+    ],
+    fyo
+  );
+
+  await (await stockMovement.sync()).submit();
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Pen.name,
+      locationMap.LocationOne,
+      undefined,
+      undefined,
+      batchMap.batchOne.name
+    ),
+    2,
+    'batch one has quantity two'
+  );
+
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Pen.name,
+      locationMap.LocationOne,
+      undefined,
+      undefined,
+      batchMap.batchTwo.name
+    ),
+    1,
+    'batch two has quantity one'
+  );
+
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Pen.name,
+      locationMap.LocationOne,
+      undefined,
+      undefined,
+      batchMap.batchThree.name
+    ),
+    null,
+    'batch three has no quantity'
+  );
+
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Ink.name,
+      locationMap.LocationOne,
+      undefined,
+      undefined,
+      batchMap.batchOne.name
+    ),
+    null,
+    'non transacted item has no quantity'
+  );
+});
+
+test('batched item, create stock movement, material issue', async (t) => {
+  const { rate } = itemMap.Pen;
+  const quantity = 2;
+  const batch = batchMap.batchOne.name;
+
+  const stockMovement = await getStockMovement(
+    MovementType.MaterialIssue,
+    new Date('2022-11-03T10:00:00.528'),
+    [
+      {
+        item: itemMap.Pen.name,
+        from: locationMap.LocationOne,
+        batch,
+        quantity,
+        rate,
+      },
+    ],
+    fyo
+  );
+
+  await (await stockMovement.sync()).submit();
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Pen.name,
+      locationMap.LocationOne,
+      undefined,
+      undefined,
+      batch
+    ),
+    0,
+    'batch one quantity transacted out'
+  );
+
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Pen.name,
+      locationMap.LocationOne,
+      undefined,
+      undefined,
+      batchMap.batchTwo.name
+    ),
+    1,
+    'batch two quantity intact'
+  );
+});
+
+test('batched item, create stock movement, material transfer', async (t) => {
+  const { rate } = itemMap.Pen;
+  const quantity = 1;
+  const batch = batchMap.batchTwo.name;
+
+  const stockMovement = await getStockMovement(
+    MovementType.MaterialTransfer,
+    new Date('2022-11-03T09:58:04.528'),
+    [
+      {
+        item: itemMap.Pen.name,
+        from: locationMap.LocationOne,
+        to: locationMap.LocationTwo,
+        batch,
+        quantity,
+        rate,
+      },
+    ],
+    fyo
+  );
+
+  await (await stockMovement.sync()).submit();
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Pen.name,
+      locationMap.LocationOne,
+      undefined,
+      undefined,
+      batch
+    ),
+    0,
+    'location one batch transacted out'
+  );
+
+  t.equal(
+    await fyo.db.getStockQuantity(
+      itemMap.Pen.name,
+      locationMap.LocationTwo,
+      undefined,
+      undefined,
+      batch
+    ),
+    quantity,
+    'location two batch transacted in'
+  );
+});
+
+test('batched item, create invalid stock movements', async (t) => {
+  const { name, rate } = itemMap.Pen;
+  const quantity = await fyo.db.getStockQuantity(
+    itemMap.Pen.name,
+    locationMap.LocationTwo,
+    undefined,
+    undefined,
+    batchMap.batchTwo.name
+  );
+
+  t.equal(quantity, 1, 'location two, batch one has quantity');
+  if (!quantity) {
+    return;
+  }
+
+  let stockMovement = await getStockMovement(
+    MovementType.MaterialIssue,
+    new Date('2022-11-03T09:59:04.528'),
+    [
+      {
+        item: itemMap.Pen.name,
+        from: locationMap.LocationTwo,
+        batch: batchMap.batchOne.name,
+        quantity,
+        rate,
+      },
+    ],
+    fyo
+  );
+
+  await assertThrows(
+    async () => (await stockMovement.sync()).submit(),
+    'invalid stockMovement with insufficient quantity did not throw'
+  );
+
+  stockMovement = await getStockMovement(
+    MovementType.MaterialIssue,
+    new Date('2022-11-03T09:59:04.528'),
+    [
+      {
+        item: itemMap.Pen.name,
+        from: locationMap.LocationTwo,
+        quantity,
+        rate,
+      },
+    ],
+    fyo
+  );
+
+  await assertThrows(
+    async () => (await stockMovement.sync()).submit(),
+    'invalid stockMovement without batch did not throw'
+  );
+  t.equal(await fyo.db.getStockQuantity(name), 1, 'item still has quantity');
+});
+
+closeTestFyo(fyo, __filename);

models/inventory/tests/testInventory.spec.ts

@@ -17,12 +17,10 @@ const itemMap = {
   Pen: {
     name: 'Pen',
     rate: 700,
-    hasBatchNumber: true,
   },
   Ink: {
     name: 'Ink',
     rate: 50,
-    hasBatchNumber: false,
   },
 };
 
@@ -31,22 +29,14 @@ const locationMap = {
   LocationTwo: 'LocationTwo',
 };
 
-const batchNumberMap = {
-  batchNumberOne: {
-    name: 'IK-AB001',
-    manufactureDate: '2022-11-03T09:57:04.528',
-    expiryDate: '2023-11-03T09:57:04.528',
-  },
-};
-
 /**
  * Section 1: Test Creation of Items and Locations
  */
 
 test('create dummy items & locations', async (t) => {
   // Create Items
-  for (const { name, rate, hasBatchNumber } of Object.values(itemMap)) {
-    const item = getItem(name, rate, hasBatchNumber);
+  for (const { name, rate } of Object.values(itemMap)) {
+    const item = getItem(name, rate);
     await fyo.doc.getNewDoc(ModelNameEnum.Item, item).sync();
     t.ok(await fyo.db.exists(ModelNameEnum.Item, name), `${name} exists`);
   }
@@ -58,25 +48,6 @@ test('create dummy items & locations', async (t) => {
   }
 });
 
-test('create dummy batch numbers', async (t) => {
-  // create batchNumber
-  for (const { name, manufactureDate, expiryDate } of Object.values(
-    batchNumberMap
-  )) {
-    await fyo.doc
-      .getNewDoc(ModelNameEnum.BatchNumber, {
-        name,
-        expiryDate,
-        manufactureDate,
-      })
-      .sync();
-    t.ok(
-      await fyo.db.exists(ModelNameEnum.BatchNumber, name),
-      `${name} exists`
-    );
-  }
-});
-
 /**
  * Section 2: Test Creation of Stock Movements
  */
@@ -119,55 +90,6 @@ test('create stock movement, material receipt', async (t) => {
   t.equal(await fyo.db.getStockQuantity(itemMap.Ink.name), quantity);
 });
 
-test('Batch Enabled : create stock movement, material receipt', async (t) => {
-  const { rate } = itemMap.Pen;
-  const quantity = 2;
-  const batchNumber = batchNumberMap.batchNumberOne.name;
-  const amount = rate * quantity;
-  const stockMovement = await getStockMovement(
-    MovementType.MaterialReceipt,
-    new Date('2022-11-03T09:57:04.528'),
-    [
-      {
-        item: itemMap.Pen.name,
-        to: locationMap.LocationOne,
-        quantity,
-        batchNumber,
-        rate,
-      },
-    ],
-    fyo
-  );
-
-  await (await stockMovement.sync()).submit();
-  t.ok(stockMovement.name?.startsWith('SMOV-'));
-  t.equal(stockMovement.amount?.float, amount);
-  t.equal(stockMovement.items?.[0].amount?.float, amount);
-
-  const name = stockMovement.name!;
-
-  const sles = await getSLEs(name, ModelNameEnum.StockMovement, fyo);
-  t.equal(sles.length, 1);
-
-  const sle = sles[0];
-  t.notEqual(new Date(sle.date).toString(), 'Invalid Date');
-  t.equal(parseInt(sle.name), 2);
-  t.equal(sle.item, itemMap.Pen.name);
-  t.equal(parseFloat(sle.rate), rate);
-  t.equal(sle.quantity, quantity);
-  t.equal(sle.location, locationMap.LocationOne);
-  t.equal(
-    await fyo.db.getStockQuantity(
-      itemMap.Pen.name,
-      locationMap.LocationOne,
-      undefined,
-      undefined,
-      batchNumber
-    ),
-    quantity
-  );
-});
-
 test('create stock movement, material transfer', async (t) => {
   const { rate } = itemMap.Ink;
   const quantity = 2;
@@ -214,69 +136,6 @@ test('create stock movement, material transfer', async (t) => {
   t.equal(await fyo.db.getStockQuantity(itemMap.Ink.name), quantity);
 });
 
-test('Batch Enabled create stock movement, material transfer', async (t) => {
-  const { rate } = itemMap.Pen;
-  const quantity = 2;
-  const batchNumber = batchNumberMap.batchNumberOne.name;
-
-  const stockMovement = await getStockMovement(
-    MovementType.MaterialTransfer,
-    new Date('2022-11-03T09:58:04.528'),
-    [
-      {
-        item: itemMap.Pen.name,
-        from: locationMap.LocationOne,
-        to: locationMap.LocationTwo,
-        batchNumber,
-        quantity,
-        rate,
-      },
-    ],
-    fyo
-  );
-
-  await (await stockMovement.sync()).submit();
-  const name = stockMovement.name!;
-
-  const sles = await getSLEs(name, ModelNameEnum.StockMovement, fyo);
-  t.equal(sles.length, 2);
-
-  for (const sle of sles) {
-    t.notEqual(new Date(sle.date).toString(), 'Invalid Date');
-    t.equal(sle.item, itemMap.Pen.name);
-    t.equal(parseFloat(sle.rate), rate);
-
-    if (sle.location === locationMap.LocationOne) {
-      t.equal(sle.quantity, -quantity);
-    } else if (sle.location === locationMap.LocationTwo) {
-      t.equal(sle.quantity, quantity);
-    } else {
-      t.ok(false, 'no-op');
-    }
-  }
-
-  t.equal(
-    await fyo.db.getStockQuantity(
-      itemMap.Pen.name,
-      locationMap.LocationOne,
-      undefined,
-      undefined,
-      batchNumber
-    ),
-    0
-  );
-  t.equal(
-    await fyo.db.getStockQuantity(
-      itemMap.Pen.name,
-      locationMap.LocationTwo,
-      undefined,
-      undefined,
-      batchNumber
-    ),
-    quantity
-  );
-});
-
 test('create stock movement, material issue', async (t) => {
   const { rate } = itemMap.Ink;
   const quantity = 2;
@@ -310,50 +169,6 @@ test('create stock movement, material issue', async (t) => {
   t.equal(await fyo.db.getStockQuantity(itemMap.Ink.name), 0);
 });
 
-test('Batch Enabled create stock movement, material issue', async (t) => {
-  const { rate } = itemMap.Pen;
-  const quantity = 2;
-  const batchNumber = batchNumberMap.batchNumberOne.name;
-
-  const stockMovement = await getStockMovement(
-    MovementType.MaterialIssue,
-    new Date('2022-11-03T09:59:04.528'),
-    [
-      {
-        item: itemMap.Pen.name,
-        from: locationMap.LocationTwo,
-        batchNumber,
-        quantity,
-        rate,
-      },
-    ],
-    fyo
-  );
-
-  await (await stockMovement.sync()).submit();
-  const name = stockMovement.name!;
-
-  const sles = await getSLEs(name, ModelNameEnum.StockMovement, fyo);
-  t.equal(sles.length, 1);
-
-  const sle = sles[0];
-  t.notEqual(new Date(sle.date).toString(), 'Invalid Date');
-  t.equal(sle.item, itemMap.Pen.name);
-  t.equal(parseFloat(sle.rate), rate);
-  t.equal(sle.quantity, -quantity);
-  t.equal(sle.location, locationMap.LocationTwo);
-  t.equal(
-    await fyo.db.getStockQuantity(
-      itemMap.Pen.name,
-      undefined,
-      undefined,
-      undefined,
-      batchNumber
-    ),
-    0
-  );
-});
-
 /**
  * Section 3: Test Cancellation of Stock Movements
  */
@@ -399,7 +214,6 @@ async function runEntries(
       item: string;
       to?: string;
       from?: string;
-      batchNumber?: string;
       quantity: number;
       rate: number;
     }[];
@@ -435,7 +249,6 @@ test('create stock movements, invalid entries, in sequence', async (t) => {
           {
             item,
             to: locationMap.LocationOne,
-            batchNumber: batchNumberMap.batchNumberOne.name,
             quantity,
             rate,
           },
@@ -451,7 +264,6 @@ test('create stock movements, invalid entries, in sequence', async (t) => {
             item,
             from: locationMap.LocationOne,
             to: locationMap.LocationTwo,
-            batchNumber: batchNumberMap.batchNumberOne.name,
             quantity: quantity + 1,
             rate,
           },
@@ -466,7 +278,6 @@ test('create stock movements, invalid entries, in sequence', async (t) => {
           {
             item,
             from: locationMap.LocationOne,
-            batchNumber: batchNumberMap.batchNumberOne.name,
             quantity: quantity + 1,
             rate,
           },
@@ -481,7 +292,6 @@ test('create stock movements, invalid entries, in sequence', async (t) => {
           {
             item,
             from: locationMap.LocationOne,
-            batchNumber: batchNumberMap.batchNumberOne.name,
             to: locationMap.LocationTwo,
             quantity,
             rate,
@@ -497,7 +307,6 @@ test('create stock movements, invalid entries, in sequence', async (t) => {
           {
             item,
             from: locationMap.LocationTwo,
-            batchNumber: batchNumberMap.batchNumberOne.name,
             quantity,
             rate,
           },
@@ -562,28 +371,4 @@ test('create stock movements, invalid entries, out of sequence', async (t) => {
   );
 });
 
-test('create stock movements, material issue, insufficient quantity', async (t) => {
-  const { name, rate } = itemMap.Pen;
-  const quantity = 2;
-  const batchNumber = batchNumberMap.batchNumberOne.name;
-
-  const stockMovement = await getStockMovement(
-    MovementType.MaterialIssue,
-    new Date('2022-11-03T09:59:04.528'),
-    [
-      {
-        item: itemMap.Pen.name,
-        from: locationMap.LocationTwo,
-        batchNumber,
-        quantity,
-        rate,
-      },
-    ],
-    fyo
-  );
-
-  await assertThrows(async () => (await stockMovement.sync()).submit());
-  t.equal(await fyo.db.getStockQuantity(name), 0);
-});
-
 closeTestFyo(fyo, __filename);

models/inventory/types.ts

@@ -22,7 +22,7 @@ export interface SMTransferDetails {
   item: string;
   rate: Money;
   quantity: number;
-  batchNumber?: string;
+  batch?: string;
   fromLocation?: string;
   toLocation?: string;
 }

models/types.ts

@@ -4,7 +4,7 @@ export enum ModelNameEnum {
   AccountingLedgerEntry = 'AccountingLedgerEntry',
   AccountingSettings = 'AccountingSettings',
   Address = 'Address',
-  BatchNumber= 'BatchNumber',
+  Batch= 'Batch',
   Color = 'Color',
   CompanySettings = 'CompanySettings',
   Currency = 'Currency',

reports/inventory/StockBalance.ts

@@ -25,9 +25,11 @@ export class StockBalance extends StockLedger {
     const filters = {
       item: this.item,
       location: this.location,
+      batch: this.batch,
       fromDate: this.fromDate,
       toDate: this.toDate,
     };
+
     const rawData = getStockBalanceEntries(this._rawData ?? [], filters);
 
     return rawData.map((sbe, i) => {
@@ -41,7 +43,7 @@ export class StockBalance extends StockLedger {
   }
 
   getFilters(): Field[] {
-    return [
+    const filters = [
       {
         fieldtype: 'Link',
         target: 'Item',
@@ -56,6 +58,17 @@ export class StockBalance extends StockLedger {
         label: t`Location`,
         fieldname: 'location',
       },
+      ...(this.hasBatches
+        ? [
+            {
+              fieldtype: 'Link',
+              target: 'Batch',
+              placeholder: t`Batch`,
+              label: t`Batch`,
+              fieldname: 'batch',
+            },
+          ]
+        : []),
       {
         fieldtype: 'Date',
         placeholder: t`From Date`,
@@ -69,6 +82,8 @@ export class StockBalance extends StockLedger {
         fieldname: 'toDate',
       },
     ] as Field[];
+
+    return filters;
   }
 
   getColumns(): ColumnField[] {
@@ -89,6 +104,11 @@ export class StockBalance extends StockLedger {
         label: 'Location',
         fieldtype: 'Link',
       },
+      ...(this.hasBatches
+        ? ([
+            { fieldname: 'batch', label: 'Batch', fieldtype: 'Link' },
+          ] as ColumnField[])
+        : []),
       {
         fieldname: 'balanceQuantity',
         label: 'Balance Qty.',

reports/inventory/StockLedger.ts

@@ -3,6 +3,7 @@ import { RawValueMap } from 'fyo/core/types';
 import { Action } from 'fyo/model/types';
 import { cloneDeep } from 'lodash';
 import { DateTime } from 'luxon';
+import { InventorySettings } from 'models/inventory/InventorySettings';
 import { ValuationMethod } from 'models/inventory/types';
 import { ModelNameEnum } from 'models/types';
 import getCommonExportActions from 'reports/commonExporter';
@@ -26,6 +27,7 @@ export class StockLedger extends Report {
 
   item?: string;
   location?: string;
+  batch?: string;
   fromDate?: string;
   toDate?: string;
   ascending?: boolean;
@@ -34,6 +36,11 @@ export class StockLedger extends Report {
 
   groupBy: 'none' | 'item' | 'location' = 'none';
 
+  get hasBatches(): boolean {
+    return !!(this.fyo.singles.InventorySettings as InventorySettings)
+      .enableBatches;
+  }
+
   constructor(fyo: Fyo) {
     super(fyo);
     this._setObservers();
@@ -110,6 +117,10 @@ export class StockLedger extends Report {
         continue;
       }
 
+      if (this.batch && row.batch !== this.batch) {
+        continue;
+      }
+
       const date = row.date.valueOf();
       if (toDate && date > toDate) {
         continue;
@@ -260,11 +271,11 @@ export class StockLedger extends Report {
         label: 'Location',
         fieldtype: 'Link',
       },
-      {
-        fieldname: 'batchNumber',
-        label: 'Batch No.',
-        fieldtype: 'Link',
-      },
+      ...(this.hasBatches
+        ? ([
+            { fieldname: 'batch', label: 'Batch', fieldtype: 'Link' },
+          ] as ColumnField[])
+        : []),
       {
         fieldname: 'quantity',
         label: 'Quantity',
@@ -344,6 +355,17 @@ export class StockLedger extends Report {
         label: t`Location`,
         fieldname: 'location',
       },
+      ...(this.hasBatches
+        ? ([
+            {
+              fieldtype: 'Link',
+              target: 'Batch',
+              placeholder: t`Batch`,
+              label: t`Batch`,
+              fieldname: 'batch',
+            },
+          ] as Field[])
+        : []),
       {
         fieldtype: 'Date',
         placeholder: t`From Date`,

reports/inventory/helpers.ts

@@ -11,13 +11,14 @@ import {
 
 type Item = string;
 type Location = string;
+type Batch = string;
 
 export async function getRawStockLedgerEntries(fyo: Fyo) {
   const fieldnames = [
     'name',
     'date',
     'item',
-    'batchNumber',
+    'batch',
     'rate',
     'quantity',
     'location',
@@ -37,29 +38,27 @@ export function getStockLedgerEntries(
   valuationMethod: ValuationMethod
 ): ComputedStockLedgerEntry[] {
   const computedSLEs: ComputedStockLedgerEntry[] = [];
-  const stockQueues: Record<Item, Record<Location, StockQueue>> = {};
+  const stockQueues: Record<
+    Item,
+    Record<Location, Record<Batch, StockQueue>>
+  > = {};
 
   for (const sle of rawSLEs) {
     const name = safeParseInt(sle.name);
     const date = new Date(sle.date);
     const rate = safeParseFloat(sle.rate);
-    const {
-      item,
-      location,
-      batchNumber,
-      quantity,
-      referenceName,
-      referenceType,
-    } = sle;
+    const { item, location, quantity, referenceName, referenceType } = sle;
+    const batch = sle.batch ?? '';
 
     if (quantity === 0) {
       continue;
     }
 
     stockQueues[item] ??= {};
-    stockQueues[item][location] ??= new StockQueue();
+    stockQueues[item][location] ??= {};
+    stockQueues[item][location][batch] ??= new StockQueue();
 
-    const q = stockQueues[item][location];
+    const q = stockQueues[item][location][batch];
     const initialValue = q.value;
 
     let incomingRate: number | null;
@@ -88,7 +87,7 @@ export function getStockLedgerEntries(
 
       item,
       location,
-      batchNumber,
+      batch,
 
       quantity,
       balanceQuantity,
@@ -116,9 +115,13 @@ export function getStockBalanceEntries(
     location?: string;
     fromDate?: string;
     toDate?: string;
+    batch?: string;
   }
 ): StockBalanceEntry[] {
-  const sbeMap: Record<Item, Record<Location, StockBalanceEntry>> = {};
+  const sbeMap: Record<
+    Item,
+    Record<Location, Record<Batch, StockBalanceEntry>>
+  > = {};
 
   const fromDate = filters.fromDate ? Date.parse(filters.fromDate) : null;
   const toDate = filters.toDate ? Date.parse(filters.toDate) : null;
@@ -132,16 +135,23 @@ export function getStockBalanceEntries(
       continue;
     }
 
+    if (filters.batch && sle.batch !== filters.batch) {
+      continue;
+    }
+
+    const batch = sle.batch || '';
+
     sbeMap[sle.item] ??= {};
-    sbeMap[sle.item][sle.location] ??= getSBE(
+    sbeMap[sle.item][sle.location] ??= {};
+    sbeMap[sle.item][sle.location][batch] ??= getSBE(
       sle.item,
       sle.location,
-      sle.batchNumber
+      batch
     );
     const date = sle.date.valueOf();
 
     if (fromDate && date < fromDate) {
-      const sbe = sbeMap[sle.item][sle.location]!;
+      const sbe = sbeMap[sle.item][sle.location][batch];
       updateOpeningBalances(sbe, sle);
       continue;
     }
@@ -150,26 +160,28 @@ export function getStockBalanceEntries(
       continue;
     }
 
-    const sbe = sbeMap[sle.item][sle.location]!;
+    const sbe = sbeMap[sle.item][sle.location][batch];
     updateCurrentBalances(sbe, sle);
   }
 
   return Object.values(sbeMap)
-    .map((sbes) => Object.values(sbes))
-    .flat();
+    .map((sbeBatched) =>
+      Object.values(sbeBatched).map((sbes) => Object.values(sbes))
+    )
+    .flat(2);
 }
 
 function getSBE(
   item: string,
   location: string,
-  batchNumber: string
+  batch: string
 ): StockBalanceEntry {
   return {
     name: 0,
 
     item,
     location,
-    batchNumber,
+    batch,
 
     balanceQuantity: 0,
     balanceValue: 0,

reports/inventory/types.ts

@@ -5,7 +5,7 @@ export interface RawStockLedgerEntry {
   date: string;
   item: string;
   rate: string;
-  batchNumber: string;
+  batch: string | null;
   quantity: number;
   location: string;
   referenceName: string;
@@ -20,7 +20,7 @@ export interface ComputedStockLedgerEntry{
 
   item: string;
   location:string;
-  batchNumber: string;
+  batch: string;
 
   quantity: number;
   balanceQuantity: number;
@@ -41,7 +41,7 @@ export interface StockBalanceEntry{
 
   item: string;
   location:string;
-  batchNumber: string;
+  batch: string;
 
   balanceQuantity: number;
   balanceValue: number;

schemas/app/Batch.json

@@ -1,12 +1,12 @@
 {
-  "name": "BatchNumber",
-  "label": "Batch Number",
+  "name": "Batch",
+  "label": "Batch",
   "naming": "manual",
   "fields": [
     {
       "fieldname": "name",
       "fieldtype": "Data",
-      "label": "Batch Number",
+      "label": "Batch",
       "required": true
     },
     {

schemas/app/InvoiceItem.json

@@ -48,12 +48,12 @@
       "readOnly": true
     },
     {
-      "fieldname": "batchNumber",
-      "label": "Batch No",
+      "fieldname": "batch",
+      "label": "Batch",
       "fieldtype": "Link",
       "create": true,
-      "target": "BatchNumber",
-      "placeholder": "Batch No"
+      "target": "Batch",
+      "placeholder": "Batch"
     },
     {
       "fieldname": "quantity",
@@ -134,7 +134,7 @@
       "readOnly": true
     }
   ],
-  "tableFields": ["item", "tax", "batchNumber", "quantity", "rate", "amount"],
+  "tableFields": ["item", "tax", "quantity", "rate", "amount"],
   "keywordFields": ["item", "tax"],
   "quickEditFields": [
     "item",
@@ -146,7 +146,7 @@
 
     "transferQuantity",
     "transferUnit",
-    "batchNumber",
+    "batch",
     "quantity",
     "unit",
     "unitConversionFactor",

schemas/app/Item.json

@@ -132,8 +132,8 @@
       "default": false
     },
     {
-      "fieldname": "hasBatchNumber",
-      "label": "Has Batch No",
+      "fieldname": "hasBatch",
+      "label": "Has Batch",
       "fieldtype": "Check",
       "default": false,
       "section": "Inventory"
@@ -158,7 +158,6 @@
     "barcode",
     "hsnCode",
     "trackItem",
-    "hasBatchNumber",
     "uom"
   ],
   "keywordFields": ["name", "itemType", "for"]

schemas/app/PrintSettings.json

@@ -30,8 +30,8 @@
       "fieldtype": "Check"
     },
     {
-      "fieldname": "displayBatchNumber",
-      "label": "Display Batch Number",
+      "fieldname": "displayBatch",
+      "label": "Display Batch",
       "fieldtype": "Check"
     },
     {
@@ -143,7 +143,7 @@
     "logo",
     "displayLogo",
     "displayTaxInvoice",
-    "displayBatchNumber",
+    "displayBatch",
     "template",
     "color",
     "font",

schemas/app/inventory/InventorySettings.json

@@ -50,6 +50,16 @@
       "fieldname": "enableBarcodes",
       "label": "Enable Barcodes",
       "fieldtype": "Check"
+    },
+    {
+      "fieldname": "enableBatches",
+      "label": "Enable Batches",
+      "fieldtype": "Check"
+    },
+    {
+      "fieldname": "enableUomConversions",
+      "label": "Enable UOM Conversion",
+      "fieldtype": "Check"
     }
   ]
 }

schemas/app/inventory/StockLedgerEntry.json

@@ -51,10 +51,10 @@
       "readOnly": true
     },
     {
-      "fieldname": "batchNumber",
-      "label": "Batch No",
+      "fieldname": "batch",
+      "label": "Batch",
       "fieldtype": "Link",
-      "target": "BatchNumber",
+      "target": "Batch",
       "readOnly": true
     }
   ]

schemas/app/inventory/StockMovementItem.json

@@ -51,10 +51,10 @@
       "readOnly": true
     },
     {
-      "fieldname": "batchNumber",
-      "label": "Batch No",
+      "fieldname": "batch",
+      "label": "Batch",
       "fieldtype": "Link",
-      "target": "BatchNumber",
+      "target": "Batch",
       "create": true
     },
     {
@@ -84,7 +84,7 @@
       "readOnly": true
     }
   ],
-  "tableFields": ["item", "fromLocation", "toLocation", "batchNumber", "quantity", "rate"],
+  "tableFields": ["item", "fromLocation", "toLocation", "quantity", "rate"],
   "keywordFields": ["item"],
   "quickEditFields": [
     "item",
@@ -93,7 +93,7 @@
 
     "transferQuantity",
     "transferUnit",
-    "batchNumber",
+    "batch",
     "quantity",
     "unit",
     "unitConversionFactor",

schemas/app/inventory/StockTransferItem.json

@@ -42,10 +42,10 @@
       "readOnly": true
     },
     {
-      "fieldname": "batchNumber",
-      "label": "Batch No",
+      "fieldname": "batch",
+      "label": "Batch",
       "fieldtype": "Link",
-      "target": "BatchNumber"
+      "target": "Batch"
     },
     {
       "fieldname": "quantity",
@@ -86,13 +86,13 @@
       "placeholder": "HSN/SAC Code"
     }
   ],
-  "tableFields": ["item", "location", "batchNumber", "quantity", "rate", "amount"],
+  "tableFields": ["item", "location", "quantity", "rate", "amount"],
   "quickEditFields": [
     "item",
 
     "transferQuantity",
     "transferUnit",
-    "batchNumber",
+    "batch",
     "quantity",
     "unit",
     "unitConversionFactor",

schemas/schemas.ts

@@ -47,7 +47,7 @@ import submittable from './meta/submittable.json';
 import tree from './meta/tree.json';
 import { Schema, SchemaStub } from './types';
 import InventorySettings from './app/inventory/InventorySettings.json';
-import BatchNumber from './app/BatchNumber.json'
+import Batch from './app/Batch.json'
 
 export const coreSchemas: Schema[] = [
   PatchRun as Schema,
@@ -116,5 +116,5 @@ export const appSchemas: Schema[] | SchemaStub[] = [
   PurchaseReceipt as Schema,
   PurchaseReceiptItem as Schema,
 
-  BatchNumber as Schema
+  Batch as Schema
 ];

src/components/SalesInvoice/Templates/BaseTemplate.vue

@@ -83,7 +83,7 @@ export default {
         showHSN: this.showHSN,
         displayLogo: this.printSettings.displayLogo,
         displayTaxInvoice: this.printSettings.displayTaxInvoice,
-        displayBatchNumber: this.printSettings.displayBatchNumber,
+        displayBatch: this.printSettings.displayBatch,
         discountAfterTax: this.doc.discountAfterTax,
         logo: this.printSettings.logo,
         companyName: this.fyo.singles.AccountingSettings.companyName,

src/components/SalesInvoice/Templates/Basic.vue

@@ -74,9 +74,9 @@
             <div class="py-4 text-end w-2/12">Quantity</div>
             <div
               class="w-3/12 text-end py-4"
-              v-if="printObject.displayBatchNumber"
+              v-if="printObject.displayBatch"
             >
-              Batch No
+              Batch
             </div>
             <div class="py-4 text-end w-3/12">Rate</div>
             <div class="py-4 text-end w-3/12">Amount</div>
@@ -93,9 +93,9 @@
             <div class="w-2/12 text-end py-4">{{ row.quantity }}</div>
             <div
               class="w-3/12 text-end py-4"
-              v-if="printObject.displayBatchNumber"
+              v-if="printObject.displayBatch"
             >
-              {{ row.batchNumber }}
+              {{ row.batch }}
             </div>
             <div class="w-3/12 text-end py-4">{{ row.rate }}</div>
             <div class="w-3/12 text-end py-4">{{ row.amount }}</div>

src/components/SalesInvoice/Templates/Business.vue

@@ -68,8 +68,8 @@
         <div class="w-4/12">Item</div>
         <div class="w-2/12 text-end" v-if="printObject.showHSN">HSN/SAC</div>
         <div class="w-2/12 text-end">Quantity</div>
-        <div class="w-3/12 text-end" v-if="printObject.displayBatchNumber">
-          Batch No
+        <div class="w-3/12 text-end" v-if="printObject.displayBatch">
+          Batch
         </div>
         <div class="w-3/12 text-end">Rate</div>
         <div class="w-3/12 text-end">Amount</div>
@@ -84,8 +84,8 @@
           {{ row.hsnCode }}
         </div>
         <div class="w-2/12 text-end">{{ row.quantity }}</div>
-        <div class="w-3/12 text-end" v-if="printObject.displayBatchNumber">
-          {{ row.batchNumber }}
+        <div class="w-3/12 text-end" v-if="printObject.displayBatch">
+          {{ row.batch }}
         </div>
         <div class="w-3/12 text-end">{{ row.rate }}</div>
         <div class="w-3/12 text-end">{{ row.amount }}</div>

src/components/SalesInvoice/Templates/Minimal.vue

@@ -112,8 +112,8 @@
         <div class="w-4/12">Item</div>
         <div class="w-2/12 text-end" v-if="printObject.showHSN">HSN/SAC</div>
         <div class="w-2/12 text-end">Quantity</div>
-        <div class="w-3/12 text-end" v-if="printObject.displayBatchNumber">
-          Batch No
+        <div class="w-3/12 text-end" v-if="printObject.displayBatch">
+          Batch
         </div>
         <div class="w-3/12 text-end">Rate</div>
         <div class="w-3/12 text-end">Amount</div>
@@ -128,8 +128,8 @@
           {{ row.hsnCode }}
         </div>
         <div class="w-2/12 text-end">{{ row.quantity }}</div>
-        <div class="w-3/12 text-end" v-if="printObject.displayBatchNumber">
-          {{ row.batchNumber }}
+        <div class="w-3/12 text-end" v-if="printObject.displayBatch">
+          {{ row.batch }}
         </div>
         <div class="w-3/12 text-end">{{ row.rate }}</div>
         <div class="w-3/12 text-end">{{ row.amount }}</div>

src/pages/Settings/Settings.vue

@@ -120,16 +120,26 @@ export default {
     if (this.fieldsChanged.length === 0) {
       return;
     }
-    const fieldnames = this.fieldsChanged.map(({ fieldname }) => fieldname);
 
-    if (
-      fieldnames.includes('displayPrecision') ||
-      fieldnames.includes('hideGetStarted') ||
-      fieldnames.includes('displayPrecision') ||
-      fieldnames.includes('enableDiscounting') ||
-      fieldnames.includes('enableInventory') ||
-      fieldnames.includes('enableBarcodes')
-    ) {
+    const shouleShowReload = this.fieldsChanged
+      .map(({ fieldname }) => fieldname)
+      .some((f) => {
+        if (f.startsWith('enable')) {
+          return true;
+        }
+
+        if (f === 'displayPrecision') {
+          return true;
+        }
+
+        if (f === 'hideGetStarted') {
+          return true;
+        }
+
+        return false;
+      });
+
+    if (shouleShowReload) {
       this.showReloadToast();
     }
   },

src/utils/misc.ts

@@ -108,6 +108,7 @@ export const docsPathMap: Record<string, string | undefined> = {
   [ModelNameEnum.PurchaseReceipt]: 'inventory/purchase-receipt',
   StockLedger: 'inventory/stock-ledger',
   StockBalance: 'inventory/stock-balance',
+  [ModelNameEnum.Batch]: 'inventory/batches',
 
   // Entries
   Entries: 'entries/entries',

src/utils/search.ts

@@ -230,10 +230,16 @@ function getListViewList(fyo: Fyo): SearchItem[] {
     schemaNames.push(
       ModelNameEnum.StockMovement,
       ModelNameEnum.Shipment,
-      ModelNameEnum.PurchaseReceipt
+      ModelNameEnum.PurchaseReceipt,
+      ModelNameEnum.Location
     );
   }
 
+  const hasBatch = fyo.doc.singles.InventorySettings?.enableBatches;
+  if (hasBatch) {
+    schemaNames.push(ModelNameEnum.Batch);
+  }
+
   if (fyo.store.isDevelopment) {
     schemaNames = Object.keys(fyo.schemaMap) as ModelNameEnum[];
   }