add balance check to post and put voucher

package.json

@@ -1,6 +1,6 @@
 {
   "name": "iSunFA",
-  "version": "0.8.5+240",
+  "version": "0.8.5+241",
   "private": false,
   "scripts": {
     "dev": "next dev",

src/constants/status_code.ts

@@ -20,6 +20,7 @@ enum ErrorCode {
   UNSUPPORTED_FILE_TYPE = '400ISF0006',
   INVALID_TIMESTAMP = '400ISF0007',
   INVALID_TIMEZONE_FORMAT = '400ISF0008',
+  UNBALANCED_DEBIT_CREDIT = '400ISF0009',
   UNAUTHORIZED_ACCESS = '401ISF0000',
   FORBIDDEN = '403ISF0000',
   RESOURCE_NOT_FOUND = '404ISF0000',
@@ -79,6 +80,7 @@ enum ErrorMessage {
   UNSUPPORTED_FILE_TYPE = 'Unsupported file type',
   INVALID_TIMESTAMP = 'Invalid timestamp',
   INVALID_TIMEZONE_FORMAT = 'Invalid timezone format, should be +HHMM or -HHMM',
+  UNBALANCED_DEBIT_CREDIT = 'Debit Amount Must Equal Credit Amount',
   UNAUTHORIZED_ACCESS = 'Unauthorized access',
   RESOURCE_NOT_FOUND = 'Resource not found',
   FORBIDDEN = 'Forbidden',
@@ -141,6 +143,7 @@ export const STATUS_CODE = {
   [STATUS_MESSAGE.UNSUPPORTED_FILE_TYPE]: ErrorCode.UNSUPPORTED_FILE_TYPE,
   [STATUS_MESSAGE.INVALID_TIMESTAMP]: ErrorCode.INVALID_TIMESTAMP,
   [STATUS_MESSAGE.INVALID_TIMEZONE_FORMAT]: ErrorCode.INVALID_TIMEZONE_FORMAT,
+  [STATUS_MESSAGE.UNBALANCED_DEBIT_CREDIT]: ErrorCode.UNBALANCED_DEBIT_CREDIT,
   [STATUS_MESSAGE.UNAUTHORIZED_ACCESS]: ErrorCode.UNAUTHORIZED_ACCESS,
   [STATUS_MESSAGE.FORBIDDEN]: ErrorCode.FORBIDDEN,
   [STATUS_MESSAGE.RESOURCE_NOT_FOUND]: ErrorCode.RESOURCE_NOT_FOUND,

src/lib/utils/common.ts

@@ -20,6 +20,10 @@ import { FileFolder } from '@/constants/file';
 import { KYCFiles, UploadDocumentKeys } from '@/constants/kyc';
 import { ROCDate } from '@/interfaces/locale';
 
+export function isFloatsEqual(a: number, b: number, tolerance = Number.EPSILON): boolean {
+  return Math.abs(a - b) < tolerance;
+}
+
 export const cn = (...inputs: ClassValue[]) => {
   return twMerge(clsx(inputs));
 };

src/lib/utils/zod_schema/voucher.ts

@@ -194,9 +194,7 @@ const voucherGetAllQueryValidatorV2 = z.object({
   page: zodStringToNumberWithDefault(DEFAULT_PAGE_START_AT),
   pageSize: zodStringToNumberWithDefault(DEFAULT_PAGE_LIMIT),
   type: z.preprocess((input) => {
-    const result = (typeof input === 'string' && input.toLowerCase() === 'all') ?
-      undefined :
-      input;
+    const result = typeof input === 'string' && input.toLowerCase() === 'all' ? undefined : input;
     return result;
   }, z.nativeEnum(EventType).optional()),
   tab: z.nativeEnum(VoucherListTabV2),
@@ -386,7 +384,10 @@ const voucherPostBodyValidatorV2 = z.object({
     }),
 });
 
-const voucherPostOutputValidatorV2 = voucherEntityValidator.transform((data) => {
+const voucherPostOutputValidatorV2 = voucherEntityValidator.nullable().transform((data) => {
+  if (data === null) {
+    return null;
+  }
   return data.id;
 });
 const voucherPostFrontendValidatorV2 = z.number();
@@ -811,7 +812,15 @@ export const voucherPutSchema = {
     querySchema: voucherPutQueryValidatorV2,
     bodySchema: voucherPostBodyValidatorV2,
   },
-  outputSchema: z.number(),
+  outputSchema: z
+    .number()
+    .nullable()
+    .transform((data) => {
+      if (data === null) {
+        return null;
+      }
+      return data;
+    }),
   frontend: voucherNullSchema,
 };
 

src/pages/api/v2/company/[companyId]/voucher/[voucherId]/index.ts

@@ -190,6 +190,15 @@ export const handlePutRequest: IHandleRequest<APIName.VOUCHER_PUT_V2, number> =
       });
     }
 
+    // Info: (20241226 - Murky) Check if lineItems credit and debit are equal
+    const isLineItemsBalanced = postUtils.isLineItemsBalanced(lineItems);
+    if (!isLineItemsBalanced) {
+      postUtils.throwErrorAndLog(loggerBack, {
+        errorMessage: 'lineItems credit and debit should be equal',
+        statusMessage: STATUS_MESSAGE.UNBALANCED_DEBIT_CREDIT,
+      });
+    }
+
     if (!isVoucherInfoExist) {
       putUtils.throwErrorAndLog(loggerBack, {
         errorMessage: 'voucherInfo is required when post voucher',

src/pages/api/v2/company/[companyId]/voucher/[voucherId]/route_utils.ts

@@ -43,6 +43,7 @@ import { getImageUrlFromFileIdV1 } from '@/lib/utils/file';
 import { initInvoiceEntity } from '@/lib/utils/invoice';
 import { InvoiceTaxType, InvoiceTransactionDirection, InvoiceType } from '@/constants/invoice';
 import { CurrencyType } from '@/constants/currency';
+import { isFloatsEqual } from '@/lib/utils/common';
 
 export const voucherAPIGetOneUtils = {
   /**
@@ -416,6 +417,23 @@ export const voucherAPIGetOneUtils = {
   //   return undefined;
   // },
 
+  isLineItemsBalanced: (
+    lineItems: {
+      amount: number;
+      debit: boolean;
+    }[]
+  ) => {
+    let debit = 0;
+    let credit = 0;
+    lineItems.forEach((lineItem) => {
+      if (lineItem.debit) {
+        debit += lineItem.amount;
+      } else {
+        credit += lineItem.amount;
+      }
+    });
+    return isFloatsEqual(debit, credit);
+  },
   setLineItemIntoMap: (lineItems: ILineItemEntity, map: Map<string, ILineItemEntity>) => {
     if (!lineItems.account) return;
 

src/pages/api/v2/company/[companyId]/voucher/index.ts

@@ -263,6 +263,7 @@ export const handlePostRequest: IHandleRequest<APIName.VOUCHER_POST_V2, IVoucher
         });
       }
     }
+
     // Info: (20241025 - Murky) Early throw error if lineItems is empty and voucherInfo is empty
     if (!isLineItemsHasItems) {
       postUtils.throwErrorAndLog(loggerBack, {
@@ -271,6 +272,15 @@ export const handlePostRequest: IHandleRequest<APIName.VOUCHER_POST_V2, IVoucher
       });
     }
 
+    // Info: (20241226 - Murky) Check if lineItems credit and debit are equal
+    const isLineItemsBalanced = postUtils.isLineItemsBalanced(lineItems);
+    if (!isLineItemsBalanced) {
+      postUtils.throwErrorAndLog(loggerBack, {
+        errorMessage: 'lineItems credit and debit should be equal',
+        statusMessage: STATUS_MESSAGE.UNBALANCED_DEBIT_CREDIT,
+      });
+    }
+
     if (!isVoucherInfoExist) {
       postUtils.throwErrorAndLog(loggerBack, {
         errorMessage: 'voucherInfo is required when post voucher',
@@ -458,13 +468,13 @@ export const handlePostRequest: IHandleRequest<APIName.VOUCHER_POST_V2, IVoucher
 
     // Info: (20241111 - Murky) Output formatter 只要回傳新的voucherId就可以了
     payload = parsePrismaVoucherToVoucherEntity(createdVoucher);
+    statusMessage = STATUS_MESSAGE.CREATED;
   } catch (_error) {
     const error = _error as Error;
     statusMessage = error.message;
     loggerBack.error(error);
   }
 
-  statusMessage = STATUS_MESSAGE.CREATED;
   return {
     statusMessage,
     payload,

src/pages/api/v2/company/[companyId]/voucher/route_utils.ts

@@ -15,6 +15,7 @@ import { parsePrismaAssetToAssetEntity } from '@/lib/utils/formatter/asset.forma
 import {
   getDaysBetweenDates,
   getLastDatesOfMonthsBetweenDates,
+  isFloatsEqual,
   timestampInSeconds,
 } from '@/lib/utils/common';
 import { PUBLIC_COUNTER_PARTY } from '@/constants/counterparty';
@@ -393,6 +394,23 @@ export const voucherAPIPostUtils = {
     return !!asset;
   },
 
+  isLineItemsBalanced: (
+    lineItems: {
+      amount: number;
+      debit: boolean;
+    }[]
+  ) => {
+    let debit = 0;
+    let credit = 0;
+    lineItems.forEach((lineItem) => {
+      if (lineItem.debit) {
+        debit += lineItem.amount;
+      } else {
+        credit += lineItem.amount;
+      }
+    });
+    return isFloatsEqual(debit, credit);
+  },
   /**
    * Info: (20241025 - Murky)
    * @describe convert voucherId to IVoucherEntity