gemcap-be-common 1.5.81 → 1.5.82

package/models/LoanSnapshot.model.ts

@@ -0,0 +1,123 @@
+import mongoose from 'mongoose';
+import Joi from 'joi';
+
+import { MODEL_NAMES } from './_models';
+
+export interface ILoanSnapshot {
+  loanProductId: mongoose.Types.ObjectId;
+  effectiveDate: Date;
+  source: string;
+  balance: number;
+  floatedBalance: number;
+  statementBalance: number;
+  charges: {
+    chargeId: mongoose.Types.ObjectId;
+    chargeName: string;
+    amount: number;
+    amountPaid: number;
+  }[];
+}
+
+export type TLoanSnapshotDoc = mongoose.HydratedDocument<ILoanSnapshot>;
+
+export interface ILoanSnapshotLean extends ILoanSnapshot {
+  _id: mongoose.Types.ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface ILoanSnapshotPlain extends Omit<ILoanSnapshot, 'loanProductId' | 'charges'> {
+  _id: string;
+  loanProductId: string;
+  charges: {
+    chargeId: string;
+    chargeName: string;
+    amount: number;
+    amountPaid: number;
+  }[];
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+const LoanSnapshotChargeValidationSchema = Joi.object({
+  chargeId: Joi.string().required(),
+  chargeName: Joi.string().required(),
+  amount: Joi.number().required(),
+  amountPaid: Joi.number().required(),
+});
+
+export const LoanSnapshotValidationSchema = Joi.object({
+  _id: Joi.string(),
+  loanProductId: Joi.string(),
+  effectiveDate: Joi.date().required(),
+  source: Joi.string().required(),
+  balance: Joi.number().required(),
+  floatedBalance: Joi.number().required(),
+  statementBalance: Joi.number().required(),
+
+  charges: Joi.array()
+    .items(LoanSnapshotChargeValidationSchema)
+    .required(),
+});
+
+export type TLoanSnapshotModel = mongoose.Model<ILoanSnapshot>;
+
+export const LoanSnapshotSchema = new mongoose.Schema<ILoanSnapshot, TLoanSnapshotModel>(
+  {
+    loanProductId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.loanProducts,
+      required: true,
+    },
+    effectiveDate: {
+      type: Date,
+      required: true,
+    },
+    source: {
+      type: String,
+      required: true,
+    },
+    balance: {
+      type: Number,
+      required: true,
+    },
+    floatedBalance: {
+      type: Number,
+      required: true,
+    },
+    statementBalance: {
+      type: Number,
+      required: true,
+    },
+    charges: [{
+      chargeId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: MODEL_NAMES.loanCharges,
+        required: true,
+      },
+      chargeName: {
+        type: String,
+        required: true,
+      },
+      amount: {
+        type: Number,
+        required: true,
+      },
+      amountPaid: {
+        type: Number,
+        required: true,
+      },
+    }],
+  },
+  {
+    timestamps: { createdAt: true, updatedAt: true },
+    versionKey: false,
+  },
+);
+
+LoanSnapshotSchema.index(
+  { loanProductId: 1, effectiveDate: 1 },
+  { unique: true },
+);
+
+export const LoanSnapshot = mongoose.model<ILoanSnapshot, TLoanSnapshotModel>(MODEL_NAMES.loanSnapshots, LoanSnapshotSchema);

package/models/LoanStatementStatus.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/LoanStatementTransaction.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />
@@ -77,11 +81,11 @@ export declare const LoanStatementSchema: mongoose.Schema<any, mongoose.Model<an
     chargeId: mongoose.Types.ObjectId;
     isSystem: boolean;
     __v?: number;
-    memo?: string;
-    settlementCode?: string;
     amountPaid?: number;
+    settlementCode?: string;
     balance?: number;
     userId?: string;
+    memo?: string;
 }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
     createdAt: NativeDate;
     updatedAt: NativeDate;
@@ -92,11 +96,11 @@ export declare const LoanStatementSchema: mongoose.Schema<any, mongoose.Model<an
     chargeId: mongoose.Types.ObjectId;
     isSystem: boolean;
     __v?: number;
-    memo?: string;
-    settlementCode?: string;
     amountPaid?: number;
+    settlementCode?: string;
     balance?: number;
     userId?: string;
+    memo?: string;
 }>> & mongoose.FlatRecord<{
     createdAt: NativeDate;
     updatedAt: NativeDate;
@@ -107,11 +111,11 @@ export declare const LoanStatementSchema: mongoose.Schema<any, mongoose.Model<an
     chargeId: mongoose.Types.ObjectId;
     isSystem: boolean;
     __v?: number;
-    memo?: string;
-    settlementCode?: string;
     amountPaid?: number;
+    settlementCode?: string;
     balance?: number;
     userId?: string;
+    memo?: string;
 }> & {
     _id: mongoose.Types.ObjectId;
 }>;

package/models/LoanTransaction.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/LoanTransactionFile.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/MappedGroup.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />
@@ -38,27 +42,27 @@ export declare const MappedGroupSchema: mongoose.Schema<any, mongoose.Model<any,
     updatedAt: NativeDate;
 } & {
     borrowerId: mongoose.Types.ObjectId;
+    groupType: string;
     group1: string;
     group2: string;
-    groupType: string;
     __v?: number;
 }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
     borrowerId: mongoose.Types.ObjectId;
+    groupType: string;
     group1: string;
     group2: string;
-    groupType: string;
     __v?: number;
 }>> & mongoose.FlatRecord<{
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
     borrowerId: mongoose.Types.ObjectId;
+    groupType: string;
     group1: string;
     group2: string;
-    groupType: string;
     __v?: number;
 }> & {
     _id: mongoose.Types.ObjectId;

package/models/MicroserviceTask.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/types" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/MonthEndData.Model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/Organization.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/OrganizationEmails.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/Participation.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/PostponedTransactions.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProductBroker.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />
@@ -65,10 +69,10 @@ export declare const ProductBrokerSchema: mongoose.Schema<any, mongoose.Model<an
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    order: number;
-    active: boolean;
     borrowerId: mongoose.Types.ObjectId;
     productId: mongoose.Types.ObjectId;
+    order: number;
+    active: boolean;
     PLCode: string;
     loanBrokerId: mongoose.Types.ObjectId;
     BSCode: string;
@@ -80,10 +84,10 @@ export declare const ProductBrokerSchema: mongoose.Schema<any, mongoose.Model<an
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    order: number;
-    active: boolean;
     borrowerId: mongoose.Types.ObjectId;
     productId: mongoose.Types.ObjectId;
+    order: number;
+    active: boolean;
     PLCode: string;
     loanBrokerId: mongoose.Types.ObjectId;
     BSCode: string;
@@ -95,10 +99,10 @@ export declare const ProductBrokerSchema: mongoose.Schema<any, mongoose.Model<an
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    order: number;
-    active: boolean;
     borrowerId: mongoose.Types.ObjectId;
     productId: mongoose.Types.ObjectId;
+    order: number;
+    active: boolean;
     PLCode: string;
     loanBrokerId: mongoose.Types.ObjectId;
     BSCode: string;

package/models/Prospect.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectExternalUpdate.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectFile.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectIndustry.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectInternalUpdate.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectLink.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectNotification.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectSharepoint.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/ProspectSource.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/types" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/QueryResult.model.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="mongoose/types/types" />
 /// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
 /// <reference types="mongoose/types/schemaoptions" />
 /// <reference types="mongoose/types/utility" />
-/// <reference types="mongoose/types/models" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/QuickbooksAccount.model.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/utility" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />

package/models/Receivable.model.d.ts

@@ -1,3 +1,7 @@
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/types" />
 /// <reference types="mongoose/types/aggregate" />
 /// <reference types="mongoose/types/callback" />
 /// <reference types="mongoose/types/collection" />
@@ -56,8 +60,8 @@ export declare const ReceivableSchema: mongoose.Schema<any, mongoose.Model<any,
     bbcDate: Date;
     invoices: mongoose.Types.DocumentArray<{
         bbcDate: Date;
-        invoiceNumber: string;
         invoiceDate: Date;
+        invoiceNumber: string;
         customerTitle: string;
         invoiceAmount: number;
         dueDate?: Date;
@@ -79,8 +83,8 @@ export declare const ReceivableSchema: mongoose.Schema<any, mongoose.Model<any,
     bbcDate: Date;
     invoices: mongoose.Types.DocumentArray<{
         bbcDate: Date;
-        invoiceNumber: string;
         invoiceDate: Date;
+        invoiceNumber: string;
         customerTitle: string;
         invoiceAmount: number;
         dueDate?: Date;
@@ -102,8 +106,8 @@ export declare const ReceivableSchema: mongoose.Schema<any, mongoose.Model<any,
     bbcDate: Date;
     invoices: mongoose.Types.DocumentArray<{
         bbcDate: Date;
-        invoiceNumber: string;
         invoiceDate: Date;
+        invoiceNumber: string;
         customerTitle: string;
         invoiceAmount: number;
         dueDate?: Date;

package/models/ReceivableAvailability.model.d.ts

@@ -188,31 +188,31 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    bbcDateId: mongoose.Types.ObjectId;
     borrowerId: mongoose.Types.ObjectId;
+    bbcDateId: mongoose.Types.ObjectId;
     useManualInputs: boolean;
     __v?: number;
     actual?: boolean;
     summary?: {
         invoiceAmount: number;
-        ARReserves: number;
+        grossAR: number;
+        balanceAfterCrossAge: number;
+        permittedOver: number;
         creditNotes: number;
         excludedCustomerDeduction: number;
-        permittedOver: number;
         deduction: number;
         partiallyPaidDeduction: number;
         contraDeduction: number;
         crossAgeDeduction: number;
         waivedDeduction: number;
-        balanceAfterCrossAge: number;
         finalResult: number;
-        grossAR: number;
         insuredComponent: number;
         preliminaryEligibleBalance: number;
         uninsuredComponent: number;
         insuredAvailability: number;
         uninsuredAvailability: number;
         creditNotesNegative: number;
+        ARReserves: number;
         ARAvailability: number;
     };
     userCalculatedId?: string;
@@ -248,31 +248,31 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    bbcDateId: mongoose.Types.ObjectId;
     borrowerId: mongoose.Types.ObjectId;
+    bbcDateId: mongoose.Types.ObjectId;
     useManualInputs: boolean;
     __v?: number;
     actual?: boolean;
     summary?: {
         invoiceAmount: number;
-        ARReserves: number;
+        grossAR: number;
+        balanceAfterCrossAge: number;
+        permittedOver: number;
         creditNotes: number;
         excludedCustomerDeduction: number;
-        permittedOver: number;
         deduction: number;
         partiallyPaidDeduction: number;
         contraDeduction: number;
         crossAgeDeduction: number;
         waivedDeduction: number;
-        balanceAfterCrossAge: number;
         finalResult: number;
-        grossAR: number;
         insuredComponent: number;
         preliminaryEligibleBalance: number;
         uninsuredComponent: number;
         insuredAvailability: number;
         uninsuredAvailability: number;
         creditNotesNegative: number;
+        ARReserves: number;
         ARAvailability: number;
     };
     userCalculatedId?: string;
@@ -308,31 +308,31 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    bbcDateId: mongoose.Types.ObjectId;
     borrowerId: mongoose.Types.ObjectId;
+    bbcDateId: mongoose.Types.ObjectId;
     useManualInputs: boolean;
     __v?: number;
     actual?: boolean;
     summary?: {
         invoiceAmount: number;
-        ARReserves: number;
+        grossAR: number;
+        balanceAfterCrossAge: number;
+        permittedOver: number;
         creditNotes: number;
         excludedCustomerDeduction: number;
-        permittedOver: number;
         deduction: number;
         partiallyPaidDeduction: number;
         contraDeduction: number;
         crossAgeDeduction: number;
         waivedDeduction: number;
-        balanceAfterCrossAge: number;
         finalResult: number;
-        grossAR: number;
         insuredComponent: number;
         preliminaryEligibleBalance: number;
         uninsuredComponent: number;
         insuredAvailability: number;
         uninsuredAvailability: number;
         creditNotesNegative: number;
+        ARReserves: number;
         ARAvailability: number;
     };
     userCalculatedId?: string;