shareneus 1.6.25 → 1.6.26

package/dist/tax/index.d.ts

@@ -6,4 +6,4 @@
  */
 export type { TaxComponentType, CalcMethod, AppliedOn, RoundingMethod, TaxCategory, SupplyType, ResolvedSupplyType, WithholdingType, ResolverType, IRegimeComponent, IRegimeFeatures, IRounding, ITreatment, ITaxRegime, ITaxCodeComponent, ITaxCode, ITaxComponent, ITaxSummaryLine, ITaxSummary, IWithholding, IWithholdingCalcInput, ILineAmountFields, IComponentOverride, ITaxCalcLineInput, ITaxSummaryInput, IRoundingConfig, IDocumentTotalsInput, IDocumentTotals, ITaxIdLabel, ITaxIdEntry, ITaxExemption, ITaxAuthority, IExternalProvider, } from "./tax.types";
 export type { IInclusiveResult } from "./tax-calculator";
-export { CalculateNetAmt, CalculateLineTax, ExtractNetFromInclusive, SumTaxComponents, ComputeTaxSummary, ComputeDocumentTotals, DetermineSupplyType, FindTaxCodeByRateAndSupplyType, CalculateWithholding, RoundAmount, ValidateTaxId, ValidateHSNSACLength, ConvertFlatToTaxes, GetDefaultTaxIdLabels, GetPrintableTaxIds, } from "./tax-calculator";
+export { CalculateGrossAmt, CalculateNetAmt, CalculateLineTax, ExtractNetFromInclusive, SumTaxComponents, ComputeTaxSummary, ComputeDocumentTotals, DetermineSupplyType, FindTaxCodeByRateAndSupplyType, CalculateWithholding, RoundAmount, ValidateTaxId, ValidateHSNSACLength, ConvertFlatToTaxes, GetDefaultTaxIdLabels, GetPrintableTaxIds, } from "./tax-calculator";

package/dist/tax/index.js

@@ -6,8 +6,9 @@
  * Import from "shareneus/tax" in both UI and API code.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetPrintableTaxIds = exports.GetDefaultTaxIdLabels = exports.ConvertFlatToTaxes = exports.ValidateHSNSACLength = exports.ValidateTaxId = exports.RoundAmount = exports.CalculateWithholding = exports.FindTaxCodeByRateAndSupplyType = exports.DetermineSupplyType = exports.ComputeDocumentTotals = exports.ComputeTaxSummary = exports.SumTaxComponents = exports.ExtractNetFromInclusive = exports.CalculateLineTax = exports.CalculateNetAmt = void 0;
+exports.GetPrintableTaxIds = exports.GetDefaultTaxIdLabels = exports.ConvertFlatToTaxes = exports.ValidateHSNSACLength = exports.ValidateTaxId = exports.RoundAmount = exports.CalculateWithholding = exports.FindTaxCodeByRateAndSupplyType = exports.DetermineSupplyType = exports.ComputeDocumentTotals = exports.ComputeTaxSummary = exports.SumTaxComponents = exports.ExtractNetFromInclusive = exports.CalculateLineTax = exports.CalculateNetAmt = exports.CalculateGrossAmt = void 0;
 var tax_calculator_1 = require("./tax-calculator");
+Object.defineProperty(exports, "CalculateGrossAmt", { enumerable: true, get: function () { return tax_calculator_1.CalculateGrossAmt; } });
 Object.defineProperty(exports, "CalculateNetAmt", { enumerable: true, get: function () { return tax_calculator_1.CalculateNetAmt; } });
 Object.defineProperty(exports, "CalculateLineTax", { enumerable: true, get: function () { return tax_calculator_1.CalculateLineTax; } });
 Object.defineProperty(exports, "ExtractNetFromInclusive", { enumerable: true, get: function () { return tax_calculator_1.ExtractNetFromInclusive; } });

package/dist/tax/tax-calculator.d.ts

@@ -15,6 +15,18 @@
  * precision issues. Never use plain JS arithmetic (* / + -) for money.
  */
 import { ITaxCode, ITaxComponent, ITaxSummary, ILineAmountFields, ITaxCalcLineInput, ITaxSummaryInput, IRoundingConfig, IDocumentTotalsInput, IDocumentTotals, ResolvedSupplyType, IWithholding, IWithholdingCalcInput, ITaxIdLabel, ITaxIdEntry } from "./tax.types";
+/**
+ * Computes the gross line amount before discounts and tax.
+ *
+ * Formula: GrossAmt = Qty × UnitPrice
+ *
+ * If `UnAmt` / `Amt` is already present on the line, that value is treated as
+ * the line's gross amount source of truth.
+ *
+ * This is the amount used for document `SubTotal` under the standard:
+ *   SubTotal = sum of line values before line/document discounts and before tax.
+ */
+export declare function CalculateGrossAmt(input: ILineAmountFields): number;
 /**
  * Computes the net taxable amount from line item fields.
  *
@@ -159,22 +171,27 @@ export declare function SumTaxComponents(taxes: ITaxComponent[] | undefined | nu
  */
 export declare function ComputeTaxSummary(input: ITaxSummaryInput): ITaxSummary;
 /**
- * Computes all document-level totals in one call: SubTotal, TaxTotal,
- * TaxSummary, Round, and Total.
+ * Computes all document-level totals in one call: SubTotal, Discount,
+ * TaxableAmount, TaxTotal, TaxSummary, Round, and Total.
  *
  * This is the primary function UI/API should call at save time to produce
  * the stored financial fields. All rounding is applied per the RoundingConfig.
  *
  * Flow:
- *   1. SubTotal = sum of line NetAmts
- *   2. TaxSummary = grouped by Code+Rate (rounded per TaxComponentTotal)
- *   3. TaxTotal = sum of TaxSummary Amts
- *   4. GrandTotal = SubTotal + TaxTotal
- *   5. If DocTotal ON: round GrandTotal, compute Round adjustment
- *   6. Total = GrandTotal + Round
+ *   1. SubTotal = sum of gross line values before discounts/tax
+ *   2. Discount = sum of line discount + prorated record discount allocations
+ *   3. TaxableAmount = sum of line NetAmts
+ *   4. TaxSummary = grouped by Code+Rate (rounded per TaxComponentTotal)
+ *   5. TaxTotal = sum of TaxSummary Amts
+ *   6. GrandTotal = TaxableAmount + TaxTotal
+ *   7. If DocTotal ON: round GrandTotal, compute Round adjustment
+ *   8. Total = GrandTotal + Round
  *
  * NOTE: Document-level Discount, Adjust, and Withholding are NOT handled here.
- * The caller applies those after this function returns:
+ * If a document-level discount exists (e.g. India GST invoice discount), the
+ * caller must prorate it into line `RecDisc` values before calling this
+ * function so each line's taxable base is correct.
+ * Additional final settlement adjustments are applied after this function:
  *   FinalPayable = Total + Adjust - Withholding.Amt
  *
  * @param input - Line items with Qty/UnitPrice/Disc/RecDisc and Taxes[], plus RoundingConfig
@@ -195,8 +212,8 @@ export declare function ComputeTaxSummary(input: ITaxSummaryInput): ITaxSummary;
  *     RegimeCode: "IN_GST",
  * });
  * // Returns: {
- * //   SubTotal: 8000, TaxTotal: 1440, Round: 0, Total: 9440,
- * //   GrandTotal: 9440,
+ * //   SubTotal: 8000, Discount: 0, TaxableAmount: 8000,
+ * //   TaxTotal: 1440, Round: 0, Total: 9440, GrandTotal: 9440,
  * //   TaxSummary: [
  * //     { Code: "CGST", Rate: 9, TaxableAmt: 8000, Amt: 720 },
  * //     { Code: "SGST", Rate: 9, TaxableAmt: 8000, Amt: 720 },

package/dist/tax/tax-calculator.js

@@ -19,6 +19,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CalculateGrossAmt = CalculateGrossAmt;
 exports.CalculateNetAmt = CalculateNetAmt;
 exports.CalculateLineTax = CalculateLineTax;
 exports.ExtractNetFromInclusive = ExtractNetFromInclusive;
@@ -40,6 +41,30 @@ const math_operations_1 = require("../shared/math-operations");
 // ============================================================
 // Net Amount Calculation
 // ============================================================
+/**
+ * Computes the gross line amount before discounts and tax.
+ *
+ * Formula: GrossAmt = Qty × UnitPrice
+ *
+ * If `UnAmt` / `Amt` is already present on the line, that value is treated as
+ * the line's gross amount source of truth.
+ *
+ * This is the amount used for document `SubTotal` under the standard:
+ *   SubTotal = sum of line values before line/document discounts and before tax.
+ */
+function CalculateGrossAmt(input) {
+    var _a, _b, _c;
+    const line = input;
+    if (line.UnAmt != null || line.Amt != null) {
+        return (0, util_1.GetNumber)((_a = line.UnAmt) !== null && _a !== void 0 ? _a : line.Amt);
+    }
+    const unitPrice = (_c = (_b = line.UnitPrice) !== null && _b !== void 0 ? _b : line.UnPr) !== null && _c !== void 0 ? _c : line.Pr;
+    if (unitPrice != null) {
+        const qty = input.Qty == null ? 1 : (0, util_1.GetNumber)(input.Qty);
+        return (0, math_operations_1.Multiply)(qty, (0, util_1.GetNumber)(unitPrice));
+    }
+    return 0;
+}
 /**
  * Computes the net taxable amount from line item fields.
  *
@@ -63,19 +88,9 @@ const math_operations_1 = require("../shared/math-operations");
  * // Returns: 3000
  */
 function CalculateNetAmt(input) {
-    var _a, _b, _c;
-    const line = input;
     const disc = (0, util_1.GetNumber)(input.Disc);
     const recDisc = (0, util_1.GetNumber)(input.RecDisc);
-    if (line.UnAmt != null || line.Amt != null) {
-        return (0, math_operations_1.Subtract)((0, util_1.GetNumber)((_a = line.UnAmt) !== null && _a !== void 0 ? _a : line.Amt), disc, recDisc);
-    }
-    const unitPrice = (_c = (_b = line.UnitPrice) !== null && _b !== void 0 ? _b : line.UnPr) !== null && _c !== void 0 ? _c : line.Pr;
-    if (unitPrice != null) {
-        const qty = input.Qty == null ? 1 : (0, util_1.GetNumber)(input.Qty);
-        return (0, math_operations_1.Subtract)((0, math_operations_1.Multiply)(qty, (0, util_1.GetNumber)(unitPrice)), disc, recDisc);
-    }
-    return 0;
+    return (0, math_operations_1.Subtract)(CalculateGrossAmt(input), disc, recDisc);
 }
 // ============================================================
 // Core Tax Calculation
@@ -433,22 +448,27 @@ function ComputeTaxSummary(input) {
 // Document Totals — Full document computation
 // ============================================================
 /**
- * Computes all document-level totals in one call: SubTotal, TaxTotal,
- * TaxSummary, Round, and Total.
+ * Computes all document-level totals in one call: SubTotal, Discount,
+ * TaxableAmount, TaxTotal, TaxSummary, Round, and Total.
  *
  * This is the primary function UI/API should call at save time to produce
  * the stored financial fields. All rounding is applied per the RoundingConfig.
  *
  * Flow:
- *   1. SubTotal = sum of line NetAmts
- *   2. TaxSummary = grouped by Code+Rate (rounded per TaxComponentTotal)
- *   3. TaxTotal = sum of TaxSummary Amts
- *   4. GrandTotal = SubTotal + TaxTotal
- *   5. If DocTotal ON: round GrandTotal, compute Round adjustment
- *   6. Total = GrandTotal + Round
+ *   1. SubTotal = sum of gross line values before discounts/tax
+ *   2. Discount = sum of line discount + prorated record discount allocations
+ *   3. TaxableAmount = sum of line NetAmts
+ *   4. TaxSummary = grouped by Code+Rate (rounded per TaxComponentTotal)
+ *   5. TaxTotal = sum of TaxSummary Amts
+ *   6. GrandTotal = TaxableAmount + TaxTotal
+ *   7. If DocTotal ON: round GrandTotal, compute Round adjustment
+ *   8. Total = GrandTotal + Round
  *
  * NOTE: Document-level Discount, Adjust, and Withholding are NOT handled here.
- * The caller applies those after this function returns:
+ * If a document-level discount exists (e.g. India GST invoice discount), the
+ * caller must prorate it into line `RecDisc` values before calling this
+ * function so each line's taxable base is correct.
+ * Additional final settlement adjustments are applied after this function:
  *   FinalPayable = Total + Adjust - Withholding.Amt
  *
  * @param input - Line items with Qty/UnitPrice/Disc/RecDisc and Taxes[], plus RoundingConfig
@@ -469,8 +489,8 @@ function ComputeTaxSummary(input) {
  *     RegimeCode: "IN_GST",
  * });
  * // Returns: {
- * //   SubTotal: 8000, TaxTotal: 1440, Round: 0, Total: 9440,
- * //   GrandTotal: 9440,
+ * //   SubTotal: 8000, Discount: 0, TaxableAmount: 8000,
+ * //   TaxTotal: 1440, Round: 0, Total: 9440, GrandTotal: 9440,
  * //   TaxSummary: [
  * //     { Code: "CGST", Rate: 9, TaxableAmt: 8000, Amt: 720 },
  * //     { Code: "SGST", Rate: 9, TaxableAmt: 8000, Amt: 720 },
@@ -479,10 +499,14 @@ function ComputeTaxSummary(input) {
  */
 function ComputeDocumentTotals(input) {
     const { Lines, Rounding, RegimeCode } = input;
-    // 1. SubTotal = sum of line NetAmts (computed from Qty × UnitPrice - Disc - RecDisc)
+    // 1. SubTotal = sum of gross line values before discounts/tax
     let subTotal = 0;
+    let discount = 0;
+    let taxableAmount = 0;
     for (const line of Lines) {
-        subTotal = (0, math_operations_1.Add)(subTotal, CalculateNetAmt(line));
+        subTotal = (0, math_operations_1.Add)(subTotal, CalculateGrossAmt(line));
+        discount = (0, math_operations_1.Add)(discount, (0, util_1.GetNumber)(line.Disc), (0, util_1.GetNumber)(line.RecDisc));
+        taxableAmount = (0, math_operations_1.Add)(taxableAmount, CalculateNetAmt(line));
     }
     // 2. TaxSummary (handles TaxComponentTotal rounding internally)
     const taxSummary = ComputeTaxSummary({
@@ -493,7 +517,7 @@ function ComputeDocumentTotals(input) {
     // 3. TaxTotal from the (potentially rounded) summary
     const taxTotal = taxSummary.TotalTax;
     // 4. GrandTotal before doc-level rounding
-    const grandTotal = (0, math_operations_1.Add)(subTotal, taxTotal);
+    const grandTotal = (0, math_operations_1.Add)(taxableAmount, taxTotal);
     // 5. DocTotal rounding
     let roundedTotal = grandTotal;
     let roundAdj = 0;
@@ -503,6 +527,8 @@ function ComputeDocumentTotals(input) {
     }
     return {
         SubTotal: subTotal,
+        Discount: discount,
+        TaxableAmount: taxableAmount,
         TaxTotal: taxTotal,
         TaxSummary: taxSummary.Lines,
         GrandTotal: grandTotal,

package/dist/tax/tax.types.d.ts

@@ -326,13 +326,17 @@ export interface IDocumentTotalsInput {
 }
 /** Result of full document totals computation */
 export interface IDocumentTotals {
-    /** Sum of all line NetAmts (before tax) */
+    /** Sum of all gross line values before discounts and tax */
     SubTotal: number;
+    /** Sum of line discounts + prorated record/document discount allocations */
+    Discount: number;
+    /** Sum of all line NetAmts after discount allocation, before tax */
+    TaxableAmount: number;
     /** Total tax amount — sum of rounded component Amts per RoundingConfig */
     TaxTotal: number;
     /** Rate-wise tax breakdown — grouped by Code+Rate, rounded per config */
     TaxSummary: ITaxSummaryLine[];
-    /** SubTotal + TaxTotal (before DocTotal rounding) */
+    /** TaxableAmount + TaxTotal (before DocTotal rounding) */
     GrandTotal: number;
     /** Rounding adjustment: RoundedTotal - GrandTotal (0 if DocTotal is off) */
     Round: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shareneus",
-  "version": "1.6.25",
+  "version": "1.6.26",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",