gemcap-be-common 1.2.136 → 1.2.138

package/models/FinancialSpreadingSheet.model.js

@@ -0,0 +1,207 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FinancialSpreadingSheet = exports.financialSpreadingSheetViewValidationSchema = exports.FinancialSpreadingSheetDTO = exports.financeSpreadingLists = exports.financialSpreadingTotalDictionary = exports.financeSpreadingBSList = exports.EFinanceSpreadingBSTotal = exports.financeSpreadingPLList = exports.EFinanceSpreadingPLTotal = exports.EFinancialSpreadingType = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const joi_1 = __importDefault(require("joi"));
+const _models_1 = require("../models/_models");
+const db_data_helper_1 = require("../helpers/db-data.helper");
+var EFinancialSpreadingType;
+(function (EFinancialSpreadingType) {
+    EFinancialSpreadingType["PROFIT_LOSS"] = "PROFIT_LOSS";
+    EFinancialSpreadingType["BALANCE_SHEET"] = "BALANCE_SHEET";
+})(EFinancialSpreadingType || (exports.EFinancialSpreadingType = EFinancialSpreadingType = {}));
+var EFinanceSpreadingPLTotal;
+(function (EFinanceSpreadingPLTotal) {
+    EFinanceSpreadingPLTotal["SALES"] = "SALES";
+    EFinanceSpreadingPLTotal["COST_OF_SALES"] = "COST_OF_SALES";
+    EFinanceSpreadingPLTotal["GROSS_PROFIT"] = "GROSS_PROFIT";
+    EFinanceSpreadingPLTotal["GROSS_MARGIN"] = "GROSS_MARGIN";
+    EFinanceSpreadingPLTotal["OPERATING_EXPENSES"] = "OPERATING_EXPENSES";
+    EFinanceSpreadingPLTotal["INCOME_FROM_OPERATIONS"] = "INCOME_FROM_OPERATIONS";
+    EFinanceSpreadingPLTotal["OPERATING_MARGIN"] = "OPERATING_MARGIN";
+    EFinanceSpreadingPLTotal["NON_OPERATING_EXPENSES"] = "NON_OPERATING_EXPENSES";
+    EFinanceSpreadingPLTotal["NON_OPERATING_INCOME"] = "NON_OPERATING_INCOME";
+    EFinanceSpreadingPLTotal["FINANCING_COSTS"] = "FINANCING_COSTS";
+    EFinanceSpreadingPLTotal["DEPRECIATION_AMORTIZATION"] = "DEPRECIATION_AMORTIZATION";
+    EFinanceSpreadingPLTotal["PRE_TAX_INCOME"] = "PRE_TAX_INCOME";
+    EFinanceSpreadingPLTotal["TAX"] = "TAX";
+    EFinanceSpreadingPLTotal["NET_INCOME"] = "NET_INCOME";
+})(EFinanceSpreadingPLTotal || (exports.EFinanceSpreadingPLTotal = EFinanceSpreadingPLTotal = {}));
+exports.financeSpreadingPLList = {
+    [EFinanceSpreadingPLTotal.SALES]: false,
+    [EFinanceSpreadingPLTotal.COST_OF_SALES]: false,
+    [EFinanceSpreadingPLTotal.GROSS_PROFIT]: true,
+    [EFinanceSpreadingPLTotal.GROSS_MARGIN]: true,
+    [EFinanceSpreadingPLTotal.OPERATING_EXPENSES]: false,
+    [EFinanceSpreadingPLTotal.OPERATING_MARGIN]: true,
+    [EFinanceSpreadingPLTotal.INCOME_FROM_OPERATIONS]: true,
+    [EFinanceSpreadingPLTotal.NON_OPERATING_EXPENSES]: false,
+    [EFinanceSpreadingPLTotal.NON_OPERATING_INCOME]: false,
+    [EFinanceSpreadingPLTotal.FINANCING_COSTS]: false,
+    [EFinanceSpreadingPLTotal.DEPRECIATION_AMORTIZATION]: false,
+    [EFinanceSpreadingPLTotal.PRE_TAX_INCOME]: true,
+    [EFinanceSpreadingPLTotal.TAX]: false,
+    [EFinanceSpreadingPLTotal.NET_INCOME]: true,
+};
+var EFinanceSpreadingBSTotal;
+(function (EFinanceSpreadingBSTotal) {
+    EFinanceSpreadingBSTotal["CASH_EQUIVALENTS"] = "CASH_EQUIVALENTS";
+    EFinanceSpreadingBSTotal["TRADE_RECEIVABLES"] = "TRADE_RECEIVABLES";
+    EFinanceSpreadingBSTotal["INVENTORY"] = "INVENTORY";
+    EFinanceSpreadingBSTotal["OTHER_CURRENT_ASSETS"] = "OTHER_CURRENT_ASSETS";
+    EFinanceSpreadingBSTotal["TOTAL_CURRENT_ASSET"] = "TOTAL_CURRENT_ASSET";
+    EFinanceSpreadingBSTotal["FIXED_ASSETS"] = "FIXED_ASSETS";
+    EFinanceSpreadingBSTotal["OTHER_NON_CURRENT_ASSETS"] = "OTHER_NON_CURRENT_ASSETS";
+    EFinanceSpreadingBSTotal["TOTAL_NON_CURRENT_ASSETS"] = "TOTAL_NON_CURRENT_ASSETS";
+    EFinanceSpreadingBSTotal["TOTAL_ASSETS"] = "TOTAL_ASSETS";
+    EFinanceSpreadingBSTotal["ACCOUNTS_PAYABLE"] = "ACCOUNTS_PAYABLE";
+    EFinanceSpreadingBSTotal["OTHER_CURRENT_LIABILITIES"] = "OTHER_CURRENT_LIABILITIES";
+    EFinanceSpreadingBSTotal["TOTAL_CURRENT_LIABILITIES"] = "TOTAL_CURRENT_LIABILITIES";
+    EFinanceSpreadingBSTotal["COMPANY_DEBT"] = "COMPANY_DEBT";
+    EFinanceSpreadingBSTotal["OTHER_DEBT"] = "OTHER_DEBT";
+    EFinanceSpreadingBSTotal["OTHER_LONG_TERM_LIABILITIES"] = "OTHER_LONG_TERM_LIABILITIES";
+    EFinanceSpreadingBSTotal["LONG_TERM_LIABILITIES"] = "LONG_TERM_LIABILITIES";
+    EFinanceSpreadingBSTotal["TOTAL_LIABILITIES"] = "TOTAL_LIABILITIES";
+    EFinanceSpreadingBSTotal["RETAINED_EARNINGS"] = "RETAINED_EARNINGS";
+    EFinanceSpreadingBSTotal["EQUITY_RESERVES"] = "EQUITY_RESERVES";
+    EFinanceSpreadingBSTotal["CHECK"] = "CHECK";
+})(EFinanceSpreadingBSTotal || (exports.EFinanceSpreadingBSTotal = EFinanceSpreadingBSTotal = {}));
+exports.financeSpreadingBSList = {
+    [EFinanceSpreadingBSTotal.CASH_EQUIVALENTS]: false,
+    [EFinanceSpreadingBSTotal.TRADE_RECEIVABLES]: false,
+    [EFinanceSpreadingBSTotal.INVENTORY]: false,
+    [EFinanceSpreadingBSTotal.OTHER_CURRENT_ASSETS]: false,
+    [EFinanceSpreadingBSTotal.TOTAL_CURRENT_ASSET]: true,
+    [EFinanceSpreadingBSTotal.FIXED_ASSETS]: false,
+    [EFinanceSpreadingBSTotal.OTHER_NON_CURRENT_ASSETS]: false,
+    [EFinanceSpreadingBSTotal.TOTAL_NON_CURRENT_ASSETS]: true,
+    [EFinanceSpreadingBSTotal.TOTAL_ASSETS]: true,
+    [EFinanceSpreadingBSTotal.ACCOUNTS_PAYABLE]: false,
+    [EFinanceSpreadingBSTotal.OTHER_CURRENT_LIABILITIES]: false,
+    [EFinanceSpreadingBSTotal.TOTAL_CURRENT_LIABILITIES]: true,
+    [EFinanceSpreadingBSTotal.COMPANY_DEBT]: false,
+    [EFinanceSpreadingBSTotal.OTHER_DEBT]: false,
+    [EFinanceSpreadingBSTotal.OTHER_LONG_TERM_LIABILITIES]: false,
+    [EFinanceSpreadingBSTotal.LONG_TERM_LIABILITIES]: true,
+    [EFinanceSpreadingBSTotal.TOTAL_LIABILITIES]: true,
+    [EFinanceSpreadingBSTotal.RETAINED_EARNINGS]: false,
+    [EFinanceSpreadingBSTotal.EQUITY_RESERVES]: false,
+    [EFinanceSpreadingBSTotal.CHECK]: true,
+};
+exports.financialSpreadingTotalDictionary = {
+    [EFinanceSpreadingPLTotal.SALES]: 'Sales',
+    [EFinanceSpreadingPLTotal.COST_OF_SALES]: 'Cost of Sales',
+    [EFinanceSpreadingPLTotal.GROSS_PROFIT]: 'Gross Profit',
+    [EFinanceSpreadingPLTotal.GROSS_MARGIN]: 'Gross Margin',
+    [EFinanceSpreadingPLTotal.OPERATING_EXPENSES]: 'Operating Expenses',
+    [EFinanceSpreadingPLTotal.INCOME_FROM_OPERATIONS]: 'Income from Operations',
+    [EFinanceSpreadingPLTotal.OPERATING_MARGIN]: 'Operating Margin',
+    [EFinanceSpreadingPLTotal.NON_OPERATING_EXPENSES]: 'Non operating Expenses',
+    [EFinanceSpreadingPLTotal.NON_OPERATING_INCOME]: 'Non operating Income',
+    [EFinanceSpreadingPLTotal.FINANCING_COSTS]: 'Financing Costs',
+    [EFinanceSpreadingPLTotal.DEPRECIATION_AMORTIZATION]: 'Depreciation & Amortization',
+    [EFinanceSpreadingPLTotal.PRE_TAX_INCOME]: 'Pre-Tax Income',
+    [EFinanceSpreadingPLTotal.TAX]: 'Tax',
+    [EFinanceSpreadingPLTotal.NET_INCOME]: 'Net Income',
+    [EFinanceSpreadingBSTotal.CASH_EQUIVALENTS]: 'Cash & Equivalents',
+    [EFinanceSpreadingBSTotal.TRADE_RECEIVABLES]: 'Trade Receivables',
+    [EFinanceSpreadingBSTotal.INVENTORY]: 'Inventory',
+    [EFinanceSpreadingBSTotal.OTHER_CURRENT_ASSETS]: 'Other Current Assets',
+    [EFinanceSpreadingBSTotal.TOTAL_CURRENT_ASSET]: 'Total Current Assets',
+    [EFinanceSpreadingBSTotal.FIXED_ASSETS]: 'Fixed Assets',
+    [EFinanceSpreadingBSTotal.OTHER_NON_CURRENT_ASSETS]: 'Other Non Current Assets',
+    [EFinanceSpreadingBSTotal.TOTAL_NON_CURRENT_ASSETS]: 'Total Non Current Assets',
+    [EFinanceSpreadingBSTotal.ACCOUNTS_PAYABLE]: 'Accounts Payable',
+    [EFinanceSpreadingBSTotal.OTHER_CURRENT_LIABILITIES]: 'Other Current Liabilities',
+    [EFinanceSpreadingBSTotal.TOTAL_CURRENT_LIABILITIES]: 'Total Current Liabilities',
+    [EFinanceSpreadingBSTotal.COMPANY_DEBT]: 'Senior Debt',
+    [EFinanceSpreadingBSTotal.OTHER_DEBT]: 'Other Debt',
+    [EFinanceSpreadingBSTotal.OTHER_LONG_TERM_LIABILITIES]: 'Other Long Term Liabilities',
+    [EFinanceSpreadingBSTotal.LONG_TERM_LIABILITIES]: 'Long Term Liabilities',
+    [EFinanceSpreadingBSTotal.TOTAL_ASSETS]: 'Total Assets',
+    [EFinanceSpreadingBSTotal.TOTAL_LIABILITIES]: 'Total Liabilities',
+    [EFinanceSpreadingBSTotal.RETAINED_EARNINGS]: 'Retained Earnings',
+    [EFinanceSpreadingBSTotal.EQUITY_RESERVES]: 'Equity & Reserves',
+    [EFinanceSpreadingBSTotal.CHECK]: 'Check',
+};
+exports.financeSpreadingLists = {
+    [EFinancialSpreadingType.PROFIT_LOSS]: exports.financeSpreadingPLList,
+    [EFinancialSpreadingType.BALANCE_SHEET]: exports.financeSpreadingBSList,
+};
+class FinancialSpreadingSheetDTO extends db_data_helper_1.BasicDTO {
+    borrowerId;
+    financialSpreadingType;
+    rowType;
+    name;
+    order;
+    suborder;
+    isTotal;
+    isCalculated;
+}
+exports.FinancialSpreadingSheetDTO = FinancialSpreadingSheetDTO;
+exports.financialSpreadingSheetViewValidationSchema = joi_1.default.object({
+    _id: joi_1.default.string().required(),
+    name: joi_1.default.string().required(),
+    borrowerId: joi_1.default.string().required(),
+    financialSpreadingType: joi_1.default.string().required(),
+    rowType: joi_1.default.string().required(),
+    order: joi_1.default.number().integer().required(),
+    suborder: joi_1.default.number().integer().required(),
+    isTotal: joi_1.default.boolean().required(),
+    isCalculated: joi_1.default.boolean().required(),
+});
+const FinancialSpreadingSheetSchema = new mongoose_1.default.Schema({
+    borrowerId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.borrowers,
+        required: true,
+    },
+    financialSpreadingType: {
+        type: String,
+        enum: Object.values(EFinancialSpreadingType),
+        required: true,
+    },
+    rowType: {
+        type: String,
+        enum: [...Object.values(EFinanceSpreadingPLTotal), ...Object.values(EFinanceSpreadingBSTotal)],
+        required: true,
+        validate: {
+            validator: function (value) {
+                if (this.financialSpreadingType === EFinancialSpreadingType.PROFIT_LOSS && !(value in EFinanceSpreadingPLTotal)) {
+                    return false;
+                }
+                if (this.financialSpreadingType === EFinancialSpreadingType.BALANCE_SHEET && !(value in EFinanceSpreadingBSTotal)) {
+                    return false;
+                }
+                return true;
+            },
+            message: 'Invalid rowType for the provided financialSpreadingType',
+        },
+    },
+    name: {
+        type: String,
+        required: true,
+    },
+    order: {
+        type: Number,
+        required: true,
+    },
+    suborder: {
+        type: Number,
+        required: true,
+    },
+    isTotal: {
+        type: Boolean,
+        required: true,
+    },
+    isCalculated: {
+        type: Boolean,
+        required: true,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+});
+exports.FinancialSpreadingSheet = mongoose_1.default.model(_models_1.MODEL_NAMES.financialSpreadingSheets, FinancialSpreadingSheetSchema);

package/models/FinancialSpreadingSheet.model.ts

@@ -0,0 +1,240 @@
+import mongoose, { Model } from 'mongoose';
+import Joi from 'joi';
+
+import { MODEL_NAMES } from '../models/_models';
+import { BasicDTO } from '../helpers/db-data.helper';
+
+export enum EFinancialSpreadingType {
+  PROFIT_LOSS = 'PROFIT_LOSS',
+  BALANCE_SHEET = 'BALANCE_SHEET',
+}
+
+export enum EFinanceSpreadingPLTotal {
+  SALES = 'SALES',
+  COST_OF_SALES = 'COST_OF_SALES',
+  GROSS_PROFIT = 'GROSS_PROFIT',
+  GROSS_MARGIN = 'GROSS_MARGIN',
+  OPERATING_EXPENSES = 'OPERATING_EXPENSES',
+  INCOME_FROM_OPERATIONS = 'INCOME_FROM_OPERATIONS',
+  OPERATING_MARGIN = 'OPERATING_MARGIN',
+  NON_OPERATING_EXPENSES = 'NON_OPERATING_EXPENSES',
+  NON_OPERATING_INCOME = 'NON_OPERATING_INCOME',
+  FINANCING_COSTS = 'FINANCING_COSTS',
+  DEPRECIATION_AMORTIZATION = 'DEPRECIATION_AMORTIZATION',
+  PRE_TAX_INCOME = 'PRE_TAX_INCOME',
+  TAX = 'TAX',
+  NET_INCOME = 'NET_INCOME',
+}
+
+export const financeSpreadingPLList: { [type in EFinanceSpreadingPLTotal]?: boolean } = {
+  [EFinanceSpreadingPLTotal.SALES]: false,
+  [EFinanceSpreadingPLTotal.COST_OF_SALES]: false,
+  [EFinanceSpreadingPLTotal.GROSS_PROFIT]: true,
+  [EFinanceSpreadingPLTotal.GROSS_MARGIN]: true,
+  [EFinanceSpreadingPLTotal.OPERATING_EXPENSES]: false,
+  [EFinanceSpreadingPLTotal.OPERATING_MARGIN]: true,
+  [EFinanceSpreadingPLTotal.INCOME_FROM_OPERATIONS]: true,
+  [EFinanceSpreadingPLTotal.NON_OPERATING_EXPENSES]: false,
+  [EFinanceSpreadingPLTotal.NON_OPERATING_INCOME]: false,
+  [EFinanceSpreadingPLTotal.FINANCING_COSTS]: false,
+  [EFinanceSpreadingPLTotal.DEPRECIATION_AMORTIZATION]: false,
+  [EFinanceSpreadingPLTotal.PRE_TAX_INCOME]: true,
+  [EFinanceSpreadingPLTotal.TAX]: false,
+  [EFinanceSpreadingPLTotal.NET_INCOME]: true,
+};
+
+export enum EFinanceSpreadingBSTotal {
+  CASH_EQUIVALENTS = 'CASH_EQUIVALENTS',
+  TRADE_RECEIVABLES = 'TRADE_RECEIVABLES',
+  INVENTORY = 'INVENTORY',
+  OTHER_CURRENT_ASSETS = 'OTHER_CURRENT_ASSETS',
+  TOTAL_CURRENT_ASSET = 'TOTAL_CURRENT_ASSET',
+  FIXED_ASSETS = 'FIXED_ASSETS',
+  OTHER_NON_CURRENT_ASSETS = 'OTHER_NON_CURRENT_ASSETS',
+  TOTAL_NON_CURRENT_ASSETS = 'TOTAL_NON_CURRENT_ASSETS',
+  TOTAL_ASSETS = 'TOTAL_ASSETS',
+  ACCOUNTS_PAYABLE = 'ACCOUNTS_PAYABLE',
+  OTHER_CURRENT_LIABILITIES = 'OTHER_CURRENT_LIABILITIES',
+  TOTAL_CURRENT_LIABILITIES = 'TOTAL_CURRENT_LIABILITIES',
+  COMPANY_DEBT = 'COMPANY_DEBT',
+  OTHER_DEBT = 'OTHER_DEBT',
+  OTHER_LONG_TERM_LIABILITIES = 'OTHER_LONG_TERM_LIABILITIES',
+  LONG_TERM_LIABILITIES = 'LONG_TERM_LIABILITIES',
+  TOTAL_LIABILITIES = 'TOTAL_LIABILITIES',
+  RETAINED_EARNINGS = 'RETAINED_EARNINGS',
+  EQUITY_RESERVES = 'EQUITY_RESERVES',
+  CHECK = 'CHECK'
+}
+
+export const financeSpreadingBSList: { [type in EFinanceSpreadingBSTotal]?: boolean } = {
+  [EFinanceSpreadingBSTotal.CASH_EQUIVALENTS]: false,
+  [EFinanceSpreadingBSTotal.TRADE_RECEIVABLES]: false,
+  [EFinanceSpreadingBSTotal.INVENTORY]: false,
+  [EFinanceSpreadingBSTotal.OTHER_CURRENT_ASSETS]: false,
+  [EFinanceSpreadingBSTotal.TOTAL_CURRENT_ASSET]: true,
+  [EFinanceSpreadingBSTotal.FIXED_ASSETS]: false,
+  [EFinanceSpreadingBSTotal.OTHER_NON_CURRENT_ASSETS]: false,
+  [EFinanceSpreadingBSTotal.TOTAL_NON_CURRENT_ASSETS]: true,
+  [EFinanceSpreadingBSTotal.TOTAL_ASSETS]: true,
+  [EFinanceSpreadingBSTotal.ACCOUNTS_PAYABLE]: false,
+  [EFinanceSpreadingBSTotal.OTHER_CURRENT_LIABILITIES]: false,
+  [EFinanceSpreadingBSTotal.TOTAL_CURRENT_LIABILITIES]: true,
+  [EFinanceSpreadingBSTotal.COMPANY_DEBT]: false,
+  [EFinanceSpreadingBSTotal.OTHER_DEBT]: false,
+  [EFinanceSpreadingBSTotal.OTHER_LONG_TERM_LIABILITIES]: false,
+  [EFinanceSpreadingBSTotal.LONG_TERM_LIABILITIES]: true,
+  [EFinanceSpreadingBSTotal.TOTAL_LIABILITIES]: true,
+  [EFinanceSpreadingBSTotal.RETAINED_EARNINGS]: false,
+  [EFinanceSpreadingBSTotal.EQUITY_RESERVES]: false,
+  [EFinanceSpreadingBSTotal.CHECK]: true,
+};
+
+export const financialSpreadingTotalDictionary: Record<EFinanceSpreadingPLTotal | EFinanceSpreadingBSTotal, string> = {
+  [EFinanceSpreadingPLTotal.SALES]: 'Sales',
+  [EFinanceSpreadingPLTotal.COST_OF_SALES]: 'Cost of Sales',
+  [EFinanceSpreadingPLTotal.GROSS_PROFIT]: 'Gross Profit',
+  [EFinanceSpreadingPLTotal.GROSS_MARGIN]: 'Gross Margin',
+  [EFinanceSpreadingPLTotal.OPERATING_EXPENSES]: 'Operating Expenses',
+  [EFinanceSpreadingPLTotal.INCOME_FROM_OPERATIONS]: 'Income from Operations',
+  [EFinanceSpreadingPLTotal.OPERATING_MARGIN]: 'Operating Margin',
+  [EFinanceSpreadingPLTotal.NON_OPERATING_EXPENSES]: 'Non operating Expenses',
+  [EFinanceSpreadingPLTotal.NON_OPERATING_INCOME]: 'Non operating Income',
+  [EFinanceSpreadingPLTotal.FINANCING_COSTS]: 'Financing Costs',
+  [EFinanceSpreadingPLTotal.DEPRECIATION_AMORTIZATION]: 'Depreciation & Amortization',
+  [EFinanceSpreadingPLTotal.PRE_TAX_INCOME]: 'Pre-Tax Income',
+  [EFinanceSpreadingPLTotal.TAX]: 'Tax',
+  [EFinanceSpreadingPLTotal.NET_INCOME]: 'Net Income',
+  [EFinanceSpreadingBSTotal.CASH_EQUIVALENTS]: 'Cash & Equivalents',
+  [EFinanceSpreadingBSTotal.TRADE_RECEIVABLES]: 'Trade Receivables',
+  [EFinanceSpreadingBSTotal.INVENTORY]: 'Inventory',
+  [EFinanceSpreadingBSTotal.OTHER_CURRENT_ASSETS]: 'Other Current Assets',
+  [EFinanceSpreadingBSTotal.TOTAL_CURRENT_ASSET]: 'Total Current Assets',
+  [EFinanceSpreadingBSTotal.FIXED_ASSETS]: 'Fixed Assets',
+  [EFinanceSpreadingBSTotal.OTHER_NON_CURRENT_ASSETS]: 'Other Non Current Assets',
+  [EFinanceSpreadingBSTotal.TOTAL_NON_CURRENT_ASSETS]: 'Total Non Current Assets',
+  [EFinanceSpreadingBSTotal.ACCOUNTS_PAYABLE]: 'Accounts Payable',
+  [EFinanceSpreadingBSTotal.OTHER_CURRENT_LIABILITIES]: 'Other Current Liabilities',
+  [EFinanceSpreadingBSTotal.TOTAL_CURRENT_LIABILITIES]: 'Total Current Liabilities',
+  [EFinanceSpreadingBSTotal.COMPANY_DEBT]: 'Senior Debt',
+  [EFinanceSpreadingBSTotal.OTHER_DEBT]: 'Other Debt',
+  [EFinanceSpreadingBSTotal.OTHER_LONG_TERM_LIABILITIES]: 'Other Long Term Liabilities',
+  [EFinanceSpreadingBSTotal.LONG_TERM_LIABILITIES]: 'Long Term Liabilities',
+  [EFinanceSpreadingBSTotal.TOTAL_ASSETS]: 'Total Assets',
+  [EFinanceSpreadingBSTotal.TOTAL_LIABILITIES]: 'Total Liabilities',
+  [EFinanceSpreadingBSTotal.RETAINED_EARNINGS]: 'Retained Earnings',
+  [EFinanceSpreadingBSTotal.EQUITY_RESERVES]: 'Equity & Reserves',
+  [EFinanceSpreadingBSTotal.CHECK]: 'Check',
+};
+
+export const financeSpreadingLists = {
+  [EFinancialSpreadingType.PROFIT_LOSS]: financeSpreadingPLList,
+  [EFinancialSpreadingType.BALANCE_SHEET]: financeSpreadingBSList,
+};
+
+export interface IFinancialSpreadingSheetView {
+  _id: string;
+  name: string;
+  borrowerId: string;
+  financialSpreadingType: string;
+  rowType: string;
+  order: number;
+  suborder: number;
+  isTotal: boolean;
+  isCalculated: boolean;
+}
+
+export class FinancialSpreadingSheetDTO extends BasicDTO {
+  borrowerId: string;
+  financialSpreadingType: EFinancialSpreadingType;
+  rowType: EFinanceSpreadingPLTotal | EFinanceSpreadingBSTotal;
+  name: string;
+  order: number;
+  suborder: number;
+  isTotal: boolean;
+  isCalculated: boolean;
+}
+
+export const financialSpreadingSheetViewValidationSchema = Joi.object<IFinancialSpreadingSheetView>({
+  _id: Joi.string().required(),
+  name: Joi.string().required(),
+  borrowerId: Joi.string().required(),
+  financialSpreadingType: Joi.string().required(),
+  rowType: Joi.string().required(),
+  order: Joi.number().integer().required(),
+  suborder: Joi.number().integer().required(),
+  isTotal: Joi.boolean().required(),
+  isCalculated: Joi.boolean().required(),
+});
+
+export interface IFinancialSpreadingSheet {
+  _id?: mongoose.Types.ObjectId;
+  borrowerId: mongoose.Types.ObjectId;
+  financialSpreadingType: EFinancialSpreadingType;
+  rowType: EFinanceSpreadingPLTotal | EFinanceSpreadingBSTotal;
+  name: string;
+  order: number;
+  suborder: number;
+  isTotal: boolean;
+  isCalculated: boolean;
+}
+
+type IFinancialSpreadingSheetModel = Model<IFinancialSpreadingSheet, {}, {}>;
+
+const FinancialSpreadingSheetSchema = new mongoose.Schema<IFinancialSpreadingSheet, IFinancialSpreadingSheetModel>(
+  {
+    borrowerId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.borrowers,
+      required: true,
+    },
+    financialSpreadingType: {
+      type: String,
+      enum: Object.values(EFinancialSpreadingType),
+      required: true,
+    },
+    rowType: {
+      type: String,
+      enum: [...Object.values(EFinanceSpreadingPLTotal), ...Object.values(EFinanceSpreadingBSTotal)],
+      required: true,
+      validate: {
+        validator: function(this: any, value: string) {
+          if (this.financialSpreadingType === EFinancialSpreadingType.PROFIT_LOSS && !(value in EFinanceSpreadingPLTotal)) {
+            return false;
+          }
+
+          if (this.financialSpreadingType === EFinancialSpreadingType.BALANCE_SHEET && !(value in EFinanceSpreadingBSTotal)) {
+            return false;
+          }
+
+          return true;
+        },
+        message: 'Invalid rowType for the provided financialSpreadingType',
+      },
+    },
+    name: {
+      type: String,
+      required: true,
+    },
+    order: {
+      type: Number,
+      required: true,
+    },
+    suborder: {
+      type: Number,
+      required: true,
+    },
+    isTotal: {
+      type: Boolean,
+      required: true,
+    },
+    isCalculated: {
+      type: Boolean,
+      required: true,
+    },
+  },
+  {
+    timestamps: { createdAt: true, updatedAt: true },
+  },
+);
+
+export const FinancialSpreadingSheet = mongoose.model<IFinancialSpreadingSheet, IFinancialSpreadingSheetModel>(MODEL_NAMES.financialSpreadingSheets, FinancialSpreadingSheetSchema);

package/models/LoanTransaction.model.d.ts

@@ -74,6 +74,14 @@ export interface ILoanTransactionDoc extends ILoanTransaction, Document {
 export interface ILoanTransactionModel extends Model<ILoanTransaction> {
     findByIdAndDeleteWithUserId(id: string, userId: string): Promise<void>;
 }
+export interface ITransactionsFilter {
+    periodStart: Date;
+    periodEnd: Date;
+    borrowerId: string;
+    productId: string;
+    amount?: number;
+    reference?: string;
+}
 export declare const LoanTransactionSchema: mongoose.Schema<ILoanTransaction, ILoanTransactionModel, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, ILoanTransaction, mongoose.Document<unknown, {}, mongoose.FlatRecord<ILoanTransaction>> & mongoose.FlatRecord<ILoanTransaction> & {
     _id: mongoose.Types.ObjectId;
 }>;

package/models/LoanTransaction.model.ts

@@ -87,6 +87,15 @@ export interface ILoanTransactionModel extends Model<ILoanTransaction> {
   findByIdAndDeleteWithUserId(id: string, userId: string): Promise<void>;
 }
 
+export interface ITransactionsFilter {
+  periodStart: Date;
+  periodEnd: Date;
+  borrowerId: string;
+  productId: string;
+  amount?: number;
+  reference?: string;
+}
+
 export const LoanTransactionSchema = new mongoose.Schema<ILoanTransaction, ILoanTransactionModel>(
   {
     userId: {

package/models/PostponedTransactions.model.d.ts

@@ -38,18 +38,18 @@ export declare const PostponedTransactionSchema: mongoose.Schema<any, mongoose.M
     timestamps: false;
 }, {
     productId: mongoose.Types.ObjectId;
-    transactionId: mongoose.Types.ObjectId;
     postponedToDate: string;
+    transactionId: mongoose.Types.ObjectId;
     __v?: number;
 }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
     productId: mongoose.Types.ObjectId;
-    transactionId: mongoose.Types.ObjectId;
     postponedToDate: string;
+    transactionId: mongoose.Types.ObjectId;
     __v?: number;
 }>> & mongoose.FlatRecord<{
     productId: mongoose.Types.ObjectId;
-    transactionId: mongoose.Types.ObjectId;
     postponedToDate: string;
+    transactionId: mongoose.Types.ObjectId;
     __v?: number;
 }> & {
     _id: mongoose.Types.ObjectId;

package/models/ProspectIndustry.model.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import { Model } from 'mongoose';
+export interface ICRMProspectIndustry {
+    code: string;
+    name: string;
+    order: number;
+}
+export interface ICRMProspectIndustryWithId extends ICRMProspectIndustry {
+    _id: string;
+}
+export type CRMProspectIndustryModel = Model<ICRMProspectIndustry, object, object>;
+export declare const CRMProspectIndustry: CRMProspectIndustryModel;

package/models/ProspectIndustry.model.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRMProspectIndustry = void 0;
+const mongoose_1 = __importDefault(require("mongoose"));
+const _models_1 = require("../models/_models");
+const CRMProspectIndustrySchema = new mongoose_1.default.Schema({
+    code: {
+        type: String,
+        required: true,
+    },
+    name: {
+        type: String,
+        required: true,
+    },
+    order: {
+        type: Number,
+        required: true,
+    },
+}, {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+});
+exports.CRMProspectIndustry = mongoose_1.default.model(_models_1.MODEL_NAMES.CRMProspectIndustries, CRMProspectIndustrySchema);

package/models/ProspectIndustry.model.ts

@@ -0,0 +1,38 @@
+import mongoose, { Model } from 'mongoose';
+
+import { MODEL_NAMES } from '../models/_models';
+
+export interface ICRMProspectIndustry {
+  code: string;
+  name: string;
+  order: number;
+}
+
+export interface ICRMProspectIndustryWithId extends ICRMProspectIndustry {
+  _id: string;
+}
+
+export type CRMProspectIndustryModel = Model<ICRMProspectIndustry, object, object>;
+
+const CRMProspectIndustrySchema = new mongoose.Schema<ICRMProspectIndustry, CRMProspectIndustryModel>(
+  {
+    code: {
+      type: String,
+      required: true,
+    },
+    name: {
+      type: String,
+      required: true,
+    },
+    order: {
+      type: Number,
+      required: true,
+    },
+  },
+  {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+  },
+);
+
+export const CRMProspectIndustry = mongoose.model<ICRMProspectIndustry, CRMProspectIndustryModel>(MODEL_NAMES.CRMProspectIndustries, CRMProspectIndustrySchema);

package/models/Yield.model.d.ts

@@ -26,6 +26,52 @@ import Joi from 'joi';
 import mongoose, { Model } from 'mongoose';
 import { ISelectedMonth } from '../helpers/date.helper';
 export declare const yieldParamsValidationSchema: Joi.ObjectSchema<IYieldParams>;
+export declare enum ETotalType {
+    AVERAGE_BALANCE = "AVERAGE_BALANCE",
+    AVERAGE_LIFE_BALANCE = "AVERAGE_LIFE_BALANCE",
+    BROKER = "BROKER",
+    GROSS = "GROSS",
+    NET = "NET",
+    APR_GROSS = "APR_GROSS",
+    APR_LIFE_GROSS = "APR_LIFE_GROSS"
+}
+export declare const YIELD_TOTALS_MAP: {
+    AVERAGE_BALANCE: {
+        order: number;
+        title: string;
+        class: string;
+    };
+    AVERAGE_LIFE_BALANCE: {
+        order: number;
+        title: string;
+        class: string;
+    };
+    GROSS: {
+        order: number;
+        title: string;
+        class: string;
+    };
+    BROKER: {
+        order: number;
+        title: string;
+        class: string;
+    };
+    NET: {
+        order: number;
+        title: string;
+        class: string;
+    };
+    APR_GROSS: {
+        order: number;
+        title: string;
+        class: string;
+    };
+    APR_LIFE_GROSS: {
+        order: number;
+        title: string;
+        class: string;
+    };
+};
 export interface IYieldParams {
     periodStart?: ISelectedMonth;
     periodEnd?: ISelectedMonth;