gemcap-be-common 1.2.140 → 1.3.0

package/models/ReceivableAvailability.model.d.ts

@@ -184,13 +184,35 @@ 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;
+        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;
+        ARAvailability: number;
+    };
     userCalculatedId?: mongoose.Types.ObjectId;
     calculatedAt?: Date;
-    actual?: boolean;
     settings?: {
         excludedCustomers: mongoose.Types.DocumentArray<{
             limit?: number;
@@ -218,16 +240,21 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
         excludeFromTotal?: boolean;
         waiveInsuredCustomers?: boolean;
     };
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    borrowerId: mongoose.Types.ObjectId;
+    bbcDateId: mongoose.Types.ObjectId;
+    useManualInputs: boolean;
+    __v?: number;
+    actual?: boolean;
     summary?: {
         invoiceAmount: number;
-        insuredAvailability: number;
-        uninsuredAvailability: number;
+        ARReserves: number;
         creditNotes: number;
         excludedCustomerDeduction: number;
-        grossAR: number;
         permittedOver: number;
-        preliminaryEligibleBalance: number;
-        creditNotesNegative: number;
         deduction: number;
         partiallyPaidDeduction: number;
         contraDeduction: number;
@@ -235,22 +262,17 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
         waivedDeduction: number;
         balanceAfterCrossAge: number;
         finalResult: number;
+        grossAR: number;
         insuredComponent: number;
+        preliminaryEligibleBalance: number;
         uninsuredComponent: number;
-        ARReserves: number;
+        insuredAvailability: number;
+        uninsuredAvailability: number;
+        creditNotesNegative: number;
         ARAvailability: number;
     };
-}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
-    createdAt: NativeDate;
-    updatedAt: NativeDate;
-} & {
-    bbcDateId: mongoose.Types.ObjectId;
-    borrowerId: mongoose.Types.ObjectId;
-    useManualInputs: boolean;
-    __v?: number;
     userCalculatedId?: mongoose.Types.ObjectId;
     calculatedAt?: Date;
-    actual?: boolean;
     settings?: {
         excludedCustomers: mongoose.Types.DocumentArray<{
             limit?: number;
@@ -278,16 +300,21 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
         excludeFromTotal?: boolean;
         waiveInsuredCustomers?: boolean;
     };
+}>> & mongoose.FlatRecord<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    borrowerId: mongoose.Types.ObjectId;
+    bbcDateId: mongoose.Types.ObjectId;
+    useManualInputs: boolean;
+    __v?: number;
+    actual?: boolean;
     summary?: {
         invoiceAmount: number;
-        insuredAvailability: number;
-        uninsuredAvailability: number;
+        ARReserves: number;
         creditNotes: number;
         excludedCustomerDeduction: number;
-        grossAR: number;
         permittedOver: number;
-        preliminaryEligibleBalance: number;
-        creditNotesNegative: number;
         deduction: number;
         partiallyPaidDeduction: number;
         contraDeduction: number;
@@ -295,22 +322,17 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
         waivedDeduction: number;
         balanceAfterCrossAge: number;
         finalResult: number;
+        grossAR: number;
         insuredComponent: number;
+        preliminaryEligibleBalance: number;
         uninsuredComponent: number;
-        ARReserves: number;
+        insuredAvailability: number;
+        uninsuredAvailability: number;
+        creditNotesNegative: number;
         ARAvailability: number;
     };
-}>> & mongoose.FlatRecord<{
-    createdAt: NativeDate;
-    updatedAt: NativeDate;
-} & {
-    bbcDateId: mongoose.Types.ObjectId;
-    borrowerId: mongoose.Types.ObjectId;
-    useManualInputs: boolean;
-    __v?: number;
     userCalculatedId?: mongoose.Types.ObjectId;
     calculatedAt?: Date;
-    actual?: boolean;
     settings?: {
         excludedCustomers: mongoose.Types.DocumentArray<{
             limit?: number;
@@ -338,28 +360,6 @@ export declare const AvailabilitySchema: mongoose.Schema<any, mongoose.Model<any
         excludeFromTotal?: boolean;
         waiveInsuredCustomers?: boolean;
     };
-    summary?: {
-        invoiceAmount: number;
-        insuredAvailability: number;
-        uninsuredAvailability: number;
-        creditNotes: number;
-        excludedCustomerDeduction: number;
-        grossAR: number;
-        permittedOver: number;
-        preliminaryEligibleBalance: number;
-        creditNotesNegative: number;
-        deduction: number;
-        partiallyPaidDeduction: number;
-        contraDeduction: number;
-        crossAgeDeduction: number;
-        waivedDeduction: number;
-        balanceAfterCrossAge: number;
-        finalResult: number;
-        insuredComponent: number;
-        uninsuredComponent: number;
-        ARReserves: number;
-        ARAvailability: number;
-    };
 }> & {
     _id: mongoose.Types.ObjectId;
 }>;

package/models/ReceivableAvailabilityItem.model.d.ts

@@ -78,121 +78,121 @@ export declare const ReceivableAvailabilityItemSchema: mongoose.Schema<any, mong
     updatedAt: NativeDate;
 } & {
     order: number;
-    availabilityId: mongoose.Types.ObjectId;
     invoiceId: mongoose.Types.ObjectId;
+    availabilityId: mongoose.Types.ObjectId;
     __v?: number;
     creditNotes?: number;
     excludedCustomerDeduction?: number;
-    grossAR?: number;
     permittedOver?: number;
-    preliminaryEligibleBalance?: number;
     deduction?: number;
     partiallyPaidDeduction?: number;
     contraDeduction?: number;
     crossAgeDeduction?: number;
     waivedDeduction?: number;
+    actualDays?: number;
+    balanceAfterContra?: number;
     balanceAfterCrossAge?: number;
-    finalResult?: number;
-    insuredComponent?: number;
-    uninsuredComponent?: number;
-    bucketCurrent?: number;
+    balanceAfterDeduction?: number;
+    balanceAfterExclusion?: number;
+    balanceAfterPartially?: number;
     bucket30?: number;
     bucket60?: number;
-    actualDays?: number;
-    permittedDays?: number;
-    permitted60?: number;
-    permittedCustomerConcentration?: number;
+    bucketCurrent?: number;
+    contra?: number;
+    crossAge?: number;
     customerConcentration?: number;
+    customerGroupId?: mongoose.Types.ObjectId;
     deductionPercent?: number;
-    balanceAfterDeduction?: number;
-    partiallyPaidDifference?: boolean;
-    balanceAfterPartially?: number;
     excludedCustomer?: boolean;
-    balanceAfterExclusion?: number;
-    customerGroupId?: mongoose.Types.ObjectId;
-    contra?: number;
-    balanceAfterContra?: number;
-    crossAge?: number;
+    finalResult?: number;
+    grossAR?: number;
+    insuredComponent?: number;
+    partiallyPaidDifference?: boolean;
+    permitted60?: number;
+    permittedCustomerConcentration?: number;
+    permittedDays?: number;
+    preliminaryEligibleBalance?: number;
+    uninsuredComponent?: number;
 }, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
     order: number;
-    availabilityId: mongoose.Types.ObjectId;
     invoiceId: mongoose.Types.ObjectId;
+    availabilityId: mongoose.Types.ObjectId;
     __v?: number;
     creditNotes?: number;
     excludedCustomerDeduction?: number;
-    grossAR?: number;
     permittedOver?: number;
-    preliminaryEligibleBalance?: number;
     deduction?: number;
     partiallyPaidDeduction?: number;
     contraDeduction?: number;
     crossAgeDeduction?: number;
     waivedDeduction?: number;
+    actualDays?: number;
+    balanceAfterContra?: number;
     balanceAfterCrossAge?: number;
-    finalResult?: number;
-    insuredComponent?: number;
-    uninsuredComponent?: number;
-    bucketCurrent?: number;
+    balanceAfterDeduction?: number;
+    balanceAfterExclusion?: number;
+    balanceAfterPartially?: number;
     bucket30?: number;
     bucket60?: number;
-    actualDays?: number;
-    permittedDays?: number;
-    permitted60?: number;
-    permittedCustomerConcentration?: number;
+    bucketCurrent?: number;
+    contra?: number;
+    crossAge?: number;
     customerConcentration?: number;
+    customerGroupId?: mongoose.Types.ObjectId;
     deductionPercent?: number;
-    balanceAfterDeduction?: number;
-    partiallyPaidDifference?: boolean;
-    balanceAfterPartially?: number;
     excludedCustomer?: boolean;
-    balanceAfterExclusion?: number;
-    customerGroupId?: mongoose.Types.ObjectId;
-    contra?: number;
-    balanceAfterContra?: number;
-    crossAge?: number;
+    finalResult?: number;
+    grossAR?: number;
+    insuredComponent?: number;
+    partiallyPaidDifference?: boolean;
+    permitted60?: number;
+    permittedCustomerConcentration?: number;
+    permittedDays?: number;
+    preliminaryEligibleBalance?: number;
+    uninsuredComponent?: number;
 }>> & mongoose.FlatRecord<{
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
     order: number;
-    availabilityId: mongoose.Types.ObjectId;
     invoiceId: mongoose.Types.ObjectId;
+    availabilityId: mongoose.Types.ObjectId;
     __v?: number;
     creditNotes?: number;
     excludedCustomerDeduction?: number;
-    grossAR?: number;
     permittedOver?: number;
-    preliminaryEligibleBalance?: number;
     deduction?: number;
     partiallyPaidDeduction?: number;
     contraDeduction?: number;
     crossAgeDeduction?: number;
     waivedDeduction?: number;
+    actualDays?: number;
+    balanceAfterContra?: number;
     balanceAfterCrossAge?: number;
-    finalResult?: number;
-    insuredComponent?: number;
-    uninsuredComponent?: number;
-    bucketCurrent?: number;
+    balanceAfterDeduction?: number;
+    balanceAfterExclusion?: number;
+    balanceAfterPartially?: number;
     bucket30?: number;
     bucket60?: number;
-    actualDays?: number;
-    permittedDays?: number;
-    permitted60?: number;
-    permittedCustomerConcentration?: number;
+    bucketCurrent?: number;
+    contra?: number;
+    crossAge?: number;
     customerConcentration?: number;
+    customerGroupId?: mongoose.Types.ObjectId;
     deductionPercent?: number;
-    balanceAfterDeduction?: number;
-    partiallyPaidDifference?: boolean;
-    balanceAfterPartially?: number;
     excludedCustomer?: boolean;
-    balanceAfterExclusion?: number;
-    customerGroupId?: mongoose.Types.ObjectId;
-    contra?: number;
-    balanceAfterContra?: number;
-    crossAge?: number;
+    finalResult?: number;
+    grossAR?: number;
+    insuredComponent?: number;
+    partiallyPaidDifference?: boolean;
+    permitted60?: number;
+    permittedCustomerConcentration?: number;
+    permittedDays?: number;
+    preliminaryEligibleBalance?: number;
+    uninsuredComponent?: number;
 }> & {
     _id: mongoose.Types.ObjectId;
 }>;

package/models/ReceivableItem.model.d.ts

@@ -50,12 +50,12 @@ export declare const ReceivableItemSchema: mongoose.Schema<any, mongoose.Model<a
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    bbcSheetId: mongoose.Types.ObjectId;
+    order: number;
     invoiceDate: Date;
     invoiceNumber: string;
     customerTitle: string;
     invoiceAmount: number;
-    order: number;
+    bbcSheetId: mongoose.Types.ObjectId;
     __v?: number;
     dueDate?: Date;
     originalAmount?: number;
@@ -66,12 +66,12 @@ export declare const ReceivableItemSchema: mongoose.Schema<any, mongoose.Model<a
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    bbcSheetId: mongoose.Types.ObjectId;
+    order: number;
     invoiceDate: Date;
     invoiceNumber: string;
     customerTitle: string;
     invoiceAmount: number;
-    order: number;
+    bbcSheetId: mongoose.Types.ObjectId;
     __v?: number;
     dueDate?: Date;
     originalAmount?: number;
@@ -82,12 +82,12 @@ export declare const ReceivableItemSchema: mongoose.Schema<any, mongoose.Model<a
     createdAt: NativeDate;
     updatedAt: NativeDate;
 } & {
-    bbcSheetId: mongoose.Types.ObjectId;
+    order: number;
     invoiceDate: Date;
     invoiceNumber: string;
     customerTitle: string;
     invoiceAmount: number;
-    order: number;
+    bbcSheetId: mongoose.Types.ObjectId;
     __v?: number;
     dueDate?: Date;
     originalAmount?: number;

package/models/Reserve.model.d.ts

@@ -0,0 +1,51 @@
+/// <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 mongoose, { Document } from 'mongoose';
+export interface IReserveSummaryItem {
+    amount: number;
+    advanceRate: number;
+    availability: number;
+}
+export interface IReserveSummary {
+    [summaryField: string]: IReserveSummaryItem;
+}
+export interface IReserveItem {
+    active: boolean;
+    reserveName: string;
+    type: string;
+    amount: number;
+}
+export interface IReserve {
+    bbcDateId: mongoose.Types.ObjectId;
+    summary: IReserveSummary;
+    items: IReserveItem[];
+    notes: string;
+}
+export interface IReserveDoc extends IReserve, Document {
+}
+declare const _default: mongoose.Model<IReserveDoc, {}, {}, {}, mongoose.Document<unknown, {}, IReserveDoc> & IReserveDoc & {
+    _id: mongoose.Types.ObjectId;
+}, any>;
+export default _default;

package/models/Reserve.model.js

@@ -0,0 +1,96 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongoose_1 = __importDefault(require("mongoose"));
+const reserve_types_enum_1 = require("../enums/reserve-types.enum");
+const _models_1 = require("./_models");
+const mongooseLeanId = require('../plugins/id.plugin');
+const ReserveSchema = new mongoose_1.default.Schema({
+    bbcDateId: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: _models_1.MODEL_NAMES.BBCDates,
+        required: true,
+    },
+    summary: {
+        [reserve_types_enum_1.EReserveTypes.RENT]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+        [reserve_types_enum_1.EReserveTypes.PAYROLL]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+        [reserve_types_enum_1.EReserveTypes.INSURANCE]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+        [reserve_types_enum_1.EReserveTypes.TAX]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+        [reserve_types_enum_1.EReserveTypes.OTHER]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+        [reserve_types_enum_1.EReserveTypes.INVENTORY]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+        [reserve_types_enum_1.EReserveTypes.RECEIVABLES]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+        [reserve_types_enum_1.EReserveTypes.EQUIPMENT]: {
+            amount: {
+                type: Number,
+                required: true,
+            }
+        },
+    },
+    items: [
+        {
+            active: {
+                type: Boolean,
+                required: true,
+            },
+            reserveName: {
+                type: String,
+                trim: true,
+                required: true,
+            },
+            type: {
+                type: String,
+                required: true,
+                trim: true,
+            },
+            amount: {
+                type: Number,
+                required: true,
+            },
+        },
+    ],
+    notes: {
+        type: String,
+        required: false,
+        trim: true,
+    },
+    __v: { type: Number, select: false },
+}, { timestamps: true });
+ReserveSchema.plugin(mongooseLeanId);
+exports.default = mongoose_1.default.model(_models_1.MODEL_NAMES.reserves, ReserveSchema);

package/models/Reserve.model.ts

@@ -0,0 +1,125 @@
+import mongoose, { Document } from 'mongoose';
+import { EReserveTypes } from '../enums/reserve-types.enum';
+import { MODEL_NAMES } from './_models';
+
+const mongooseLeanId = require('../plugins/id.plugin');
+
+export interface IReserveSummaryItem {
+  amount: number;
+  advanceRate: number;
+  availability: number;
+}
+
+export interface IReserveSummary {
+  [summaryField: string]: IReserveSummaryItem
+}
+
+export interface IReserveItem {
+  active: boolean;
+  reserveName: string;
+  type: string;
+  amount: number;
+}
+
+export interface IReserve {
+  bbcDateId: mongoose.Types.ObjectId;
+  summary: IReserveSummary;
+  items: IReserveItem[];
+  notes: string;
+}
+
+export interface IReserveDoc extends IReserve, Document {
+}
+
+const ReserveSchema = new mongoose.Schema(
+  {
+    bbcDateId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: MODEL_NAMES.BBCDates,
+      required: true,
+    },
+    summary: {
+      [EReserveTypes.RENT]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+      [EReserveTypes.PAYROLL]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+      [EReserveTypes.INSURANCE]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+      [EReserveTypes.TAX]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+      [EReserveTypes.OTHER]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+      [EReserveTypes.INVENTORY]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+      [EReserveTypes.RECEIVABLES]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+      [EReserveTypes.EQUIPMENT]: {
+        amount: {
+          type: Number,
+          required: true,
+        }
+      },
+    },
+    items: [
+      {
+        active: {
+          type: Boolean,
+          required: true,
+        },
+        reserveName: {
+          type: String,
+          trim: true,
+          required: true,
+        },
+        type: {
+          type: String,
+          required: true,
+          trim: true,
+        },
+        amount: {
+          type: Number,
+          required: true,
+        },
+      },
+    ],
+    notes: {
+      type: String,
+      required: false,
+      trim: true,
+    },
+    __v: { type: Number, select: false },
+  },
+  { timestamps: true }
+);
+
+ReserveSchema.plugin(mongooseLeanId);
+
+export default mongoose.model<IReserveDoc>(MODEL_NAMES.reserves, ReserveSchema);