feat: item-level discount

2026-02-17 21:30:31 +00:00 · 2024-12-11 15:05:50 +02:00
parent 5a8d9cc7e8
commit 8cd1b36a02
23 changed files with 176 additions and 7 deletions
--- a/packages/server/src/api/controllers/Purchases/Bills.ts
+++ b/packages/server/src/api/controllers/Purchases/Bills.ts
@@ -127,6 +127,11 @@ export default class BillsController extends BaseController {
        .optional({ nullable: true })
        .isNumeric()
        .toFloat(),
+      check('entries.*.discount_type')
+        .default(DiscountType.Percentage)
+        .isString()
+        .isIn([DiscountType.Percentage, DiscountType.Amount]),
+
      check('entries.*.description').optional({ nullable: true }).trim(),
      check('entries.*.landed_cost')
        .optional({ nullable: true })
--- a/packages/server/src/api/controllers/Purchases/VendorCredit.ts
+++ b/packages/server/src/api/controllers/Purchases/VendorCredit.ts
@@ -176,6 +176,10 @@ export default class VendorCreditController extends BaseController {
        .optional({ nullable: true })
        .isNumeric()
        .toFloat(),
+      check('entries.*.discount_type')
+        .default(DiscountType.Percentage)
+        .isString()
+        .isIn([DiscountType.Percentage, DiscountType.Amount]),
      check('entries.*.description').optional({ nullable: true }).trim(),
      check('entries.*.warehouse_id')
        .optional({ nullable: true })
@@ -225,6 +229,10 @@ export default class VendorCreditController extends BaseController {
        .optional({ nullable: true })
        .isNumeric()
        .toFloat(),
+      check('entries.*.discount_type')
+        .default(DiscountType.Percentage)
+        .isString()
+        .isIn([DiscountType.Percentage, DiscountType.Amount]),
      check('entries.*.description').optional({ nullable: true }).trim(),
      check('entries.*.warehouse_id')
        .optional({ nullable: true })
--- a/packages/server/src/api/controllers/Sales/CreditNotes.ts
+++ b/packages/server/src/api/controllers/Sales/CreditNotes.ts
@@ -239,6 +239,10 @@ export default class PaymentReceivesController extends BaseController {
        .optional({ nullable: true })
        .isNumeric()
        .toFloat(),
+      check('entries.*.discount_type')
+        .default(DiscountType.Percentage)
+        .isString()
+        .isIn([DiscountType.Percentage, DiscountType.Amount]),
      check('entries.*.description').optional({ nullable: true }).trim(),
      check('entries.*.warehouse_id')
        .optional({ nullable: true })
--- a/packages/server/src/api/controllers/Sales/SalesEstimates.ts
+++ b/packages/server/src/api/controllers/Sales/SalesEstimates.ts
@@ -187,6 +187,11 @@ export default class SalesEstimatesController extends BaseController {
        .optional({ nullable: true })
        .isNumeric()
        .toFloat(),
+      check('entries.*.discount_type')
+        .default(DiscountType.Percentage)
+        .isString()
+        .isIn([DiscountType.Percentage, DiscountType.Amount]),
+
      check('entries.*.warehouse_id')
        .optional({ nullable: true })
        .isNumeric()
--- a/packages/server/src/api/controllers/Sales/SalesReceipts.ts
+++ b/packages/server/src/api/controllers/Sales/SalesReceipts.ts
@@ -164,6 +164,11 @@ export default class SalesReceiptsController extends BaseController {
        .optional({ nullable: true })
        .isNumeric()
        .toInt(),
+      check('entries.*.discount_type')
+        .default(DiscountType.Percentage)
+        .isString()
+        .isIn([DiscountType.Percentage, DiscountType.Amount]),
+
      check('entries.*.description').optional({ nullable: true }).trim(),
      check('entries.*.warehouse_id')
        .optional({ nullable: true })
--- a/packages/server/src/interfaces/ItemEntry.ts
+++ b/packages/server/src/interfaces/ItemEntry.ts
@@ -13,6 +13,7 @@ export interface IItemEntry {

  itemId: number;
  description: string;
+  discountType?: string;
  discount: number;
  quantity: number;
  rate: number;
--- a/packages/server/src/services/Sales/Estimates/utils.ts
+++ b/packages/server/src/services/Sales/Estimates/utils.ts
@@ -13,6 +13,7 @@ export const transformEstimateToPdfTemplate = (
      description: entry.description,
      rate: entry.rateFormatted,
      quantity: entry.quantityFormatted,
+      discount: entry.discountFormatted,
      total: entry.totalFormatted,
    })),
    total: estimate.totalFormatted,
@@ -21,6 +22,7 @@ export const transformEstimateToPdfTemplate = (
    customerNote: estimate.note,
    termsConditions: estimate.termsConditions,
    customerAddress: contactAddressTextFormat(estimate.customer),
+    showLineDiscount: estimate.entries.some((entry) => entry.discountFormatted),
    discount: estimate.discountAmountFormatted,
    discountLabel: estimate.discountPercentageFormatted
      ? `Discount [${estimate.discountPercentageFormatted}]`
--- a/packages/server/src/services/Sales/Invoices/ItemEntryTransformer.ts
+++ b/packages/server/src/services/Sales/Invoices/ItemEntryTransformer.ts
@@ -1,4 +1,4 @@
-import { IItemEntry } from '@/interfaces';
+import { DiscountType, IItemEntry } from '@/interfaces';
 import { Transformer } from '@/lib/Transformer/Transformer';
 import { formatNumber } from '@/utils';

@@ -8,7 +8,13 @@ export class ItemEntryTransformer extends Transformer {
   * @returns {Array}
   */
  public includeAttributes = (): string[] => {
-    return ['quantityFormatted', 'rateFormatted', 'totalFormatted'];
+    return [
+      'quantityFormatted',
+      'rateFormatted',
+      'totalFormatted',
+      'discountFormatted',
+      'discountAmountFormatted',
+    ];
  };

  /**
@@ -43,4 +49,34 @@ export class ItemEntryTransformer extends Transformer {
      money: false,
    });
  };
+
+  /**
+   * Retrieves the formatted discount of item entry.
+   * @param {IItemEntry} entry
+   * @returns {string}
+   */
+  protected discountFormatted = (entry: IItemEntry): string => {
+    if (!entry.discount) {
+      return '';
+    }
+    return entry.discountType === DiscountType.Percentage
+      ? `${entry.discount}%`
+      : formatNumber(entry.discount, {
+          currencyCode: this.context.currencyCode,
+          money: false,
+        });
+  };
+
+  /**
+   * Retrieves the formatted discount amount of item entry.
+   * @param {IItemEntry} entry
+   * @returns {string}
+   */
+  protected discountAmountFormatted = (entry: IItemEntry): string => {
+    return formatNumber(entry.discountAmount, {
+      currencyCode: this.context.currencyCode,
+      money: false,
+      excerptZero: true,
+    });
+  };
 }
--- a/packages/server/src/services/Sales/Invoices/utils.ts
+++ b/packages/server/src/services/Sales/Invoices/utils.ts
@@ -43,13 +43,14 @@ export const transformInvoiceToPdfTemplate = (
      description: entry.description,
      rate: entry.rateFormatted,
      quantity: entry.quantityFormatted,
+      discount: entry.discountFormatted,
      total: entry.totalFormatted,
    })),
    taxes: invoice.taxes.map((tax) => ({
      label: tax.name,
      amount: tax.taxRateAmountFormatted,
    })),
-
+    showLineDiscount: invoice.entries.some((entry) => entry.discountFormatted),
    customerAddress: contactAddressTextFormat(invoice.customer),
  };
 };
--- a/packages/server/src/services/Sales/Receipts/utils.ts
+++ b/packages/server/src/services/Sales/Receipts/utils.ts
@@ -1,9 +1,8 @@
-import { ISaleReceipt } from '@/interfaces';
 import { contactAddressTextFormat } from '@/utils/address-text-format';
 import { ReceiptPaperTemplateProps } from '@bigcapital/pdf-templates';

 export const transformReceiptToBrandingTemplateAttributes = (
-  saleReceipt: ISaleReceipt
+  saleReceipt
 ): Partial<ReceiptPaperTemplateProps> => {
  return {
    total: saleReceipt.totalFormatted,
@@ -13,6 +12,7 @@ export const transformReceiptToBrandingTemplateAttributes = (
      description: entry.description,
      rate: entry.rateFormatted,
      quantity: entry.quantityFormatted,
+      discount: entry.discountFormatted,
      total: entry.totalFormatted,
    })),
    receiptNumber: saleReceipt.receiptNumber,
@@ -21,6 +21,9 @@ export const transformReceiptToBrandingTemplateAttributes = (
    discountLabel: saleReceipt.discountPercentageFormatted
      ? `Discount [${saleReceipt.discountPercentageFormatted}]`
      : 'Discount',
+    showLineDiscount: saleReceipt.entries.some(
+      (entry) => entry.discountFormatted
+    ),
    adjustment: saleReceipt.adjustmentFormatted,
    customerAddress: contactAddressTextFormat(saleReceipt.customer),
  };