cloud-ide-model-schema 1.1.140 → 1.1.141

package/lib/schema/fees/fee_payment.d.ts

@@ -0,0 +1,23 @@
+import mongoose from "mongoose";
+declare const CFeePayment: mongoose.Model<{
+    [x: string]: unknown;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    [x: string]: unknown;
+}, {}> & {
+    [x: string]: unknown;
+} & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
+    [x: string]: unknown;
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    [x: string]: unknown;
+}>, {}> & mongoose.FlatRecord<{
+    [x: string]: unknown;
+}> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>>;
+export { CFeePayment };

package/lib/schema/fees/fee_payment.js

@@ -0,0 +1,221 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CFeePayment = void 0;
+var mongoose_1 = require("mongoose");
+/**
+ * Fee Payment Schema
+ *
+ * Purpose: Payment records for student fees
+ * Used by: Fees, Accounts modules
+ *
+ * BUSINESS LOGIC:
+ * 1. Records all fee payments made by students
+ * 2. Supports multiple payment methods (Cash, Cheque, Online, etc.)
+ * 3. Links to fee assignments being paid
+ * 4. Tracks payment status and reconciliation
+ * 5. Generates receipts automatically
+ * 6. Supports partial payments
+ * 7. Integrates with payment gateways
+ */
+/* SCHEMA START */
+var fee_payment = new mongoose_1.Schema({
+    feepay_receipt_number: {
+        type: String,
+        required: false,
+        unique: true,
+        sparse: true,
+        maxlength: 50,
+        trim: true,
+        comment: "Unique receipt number (auto-generated)"
+    },
+    feepay_student_id: {
+        type: String,
+        required: true,
+        comment: "Student ID (from admission form admap_student_id) - will be ObjectId when student schema exists"
+    },
+    feepay_academic_year_id_acayr: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "aca_academic_year",
+        required: true,
+        comment: "Academic year"
+    },
+    feepay_entity_id_syen: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "core_system_entity",
+        required: true,
+        comment: "Entity/Organization"
+    },
+    feepay_payment_date: {
+        type: Date,
+        required: true,
+        default: Date.now,
+        comment: "Payment date"
+    },
+    feepay_payment_mode: {
+        type: String,
+        required: true,
+        enum: ['CASH', 'CHEQUE', 'DD', 'ONLINE', 'CARD', 'UPI', 'NET_BANKING', 'BANK_TRANSFER', 'NEFT', 'RTGS', 'OTHER'],
+        comment: "Payment mode/method"
+    },
+    feepay_payment_reference: {
+        type: String,
+        maxlength: 100,
+        trim: true,
+        default: null,
+        comment: "Payment reference (cheque number, transaction ID, etc.)"
+    },
+    feepay_bank_name: {
+        type: String,
+        maxlength: 100,
+        trim: true,
+        default: null,
+        comment: "Bank name (if cheque/bank transfer)"
+    },
+    feepay_bank_branch_name: {
+        type: String,
+        maxlength: 100,
+        trim: true,
+        default: null,
+        comment: "Bank branch name (if cheque/bank transfer)"
+    },
+    feepay_bank_ifsc_code: {
+        type: String,
+        maxlength: 11,
+        trim: true,
+        default: null,
+        comment: "Bank IFSC code (if cheque/bank transfer)"
+    },
+    feepay_instrument_date: {
+        type: Date,
+        default: null,
+        comment: "Instrument date (cheque date, DD date, etc.)"
+    },
+    feepay_cheque_number: {
+        type: String,
+        maxlength: 50,
+        trim: true,
+        default: null,
+        comment: "Cheque number (if cheque payment)"
+    },
+    feepay_cheque_date: {
+        type: Date,
+        default: null,
+        comment: "Cheque date (if cheque payment)"
+    },
+    feepay_bank_account_number: {
+        type: String,
+        maxlength: 50,
+        trim: true,
+        default: null,
+        comment: "Bank account number (if bank transfer)"
+    },
+    feepay_transaction_reference: {
+        type: String,
+        maxlength: 100,
+        trim: true,
+        default: null,
+        comment: "Transaction reference number (for online payments)"
+    },
+    feepay_gateway_transaction_id: {
+        type: String,
+        maxlength: 100,
+        trim: true,
+        default: null,
+        comment: "Payment gateway transaction ID"
+    },
+    feepay_gateway_reference_id: {
+        type: String,
+        maxlength: 100,
+        trim: true,
+        default: null,
+        comment: "Payment gateway reference ID"
+    },
+    feepay_discount_percentage: {
+        type: Number,
+        default: 0,
+        min: 0,
+        max: 100,
+        comment: "Discount percentage applied"
+    },
+    feepay_discount_on: {
+        type: String,
+        enum: ['SUB_TOTAL', 'FEE_HEAD', 'TOTAL', 'INSTALLMENT'],
+        default: null,
+        comment: "Discount applied on: Sub Total, Fee Head, Total, or Installment"
+    },
+    feepay_discount_reason: {
+        type: String,
+        maxlength: 500,
+        trim: true,
+        default: null,
+        comment: "Reason for discount"
+    },
+    feepay_total_amount: {
+        type: Number,
+        required: true,
+        min: 0,
+        comment: "Total payment amount"
+    },
+    feepay_late_fee_amount: {
+        type: Number,
+        required: true,
+        default: 0,
+        min: 0,
+        comment: "Amount paid towards late fees"
+    },
+    feepay_discount_amount: {
+        type: Number,
+        required: true,
+        default: 0,
+        min: 0,
+        comment: "Discount amount applied"
+    },
+    feepay_remarks: {
+        type: String,
+        maxlength: 1000,
+        trim: true,
+        default: null,
+        comment: "Additional remarks/notes"
+    },
+    feepay_status: {
+        type: String,
+        required: true,
+        enum: ['SUCCESS', 'PENDING', 'FAILED', 'CANCELLED', 'REFUNDED'],
+        default: 'PENDING',
+        comment: "Payment status"
+    },
+    feepay_receipt_template_id_feert: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "fee_receipt_templates",
+        default: null,
+        comment: "Receipt template used (if custom)"
+    },
+    feepay_created_by_user: {
+        type: mongoose_1.default.Schema.Types.ObjectId,
+        ref: "auth_user_mst",
+        required: false,
+        default: null,
+        comment: "User who created the payment"
+    },
+    feepay_isactive: {
+        type: Boolean,
+        default: true,
+        comment: "Active status flag"
+    }
+}, {
+    collection: 'fee_payments',
+    timestamps: true // Adds created_at and updated_at
+});
+// Indexes for performance
+fee_payment.index({ feepay_receipt_number: 1 }, { unique: true, sparse: true });
+fee_payment.index({ feepay_student_id: 1, feepay_payment_date: -1 });
+fee_payment.index({ feepay_payment_date: -1 });
+fee_payment.index({ feepay_status: 1, feepay_payment_date: -1 });
+fee_payment.index({ feepay_entity_id_syen: 1, feepay_academic_year_id_acayr: 1 });
+fee_payment.index({ feepay_transaction_reference: 1 });
+fee_payment.index({ feepay_gateway_transaction_id: 1 });
+/* SCHEMA END */
+// Note: Interface will be defined in cloud-ide-lms-model
+// For now, export the schema model
+var CFeePayment = mongoose_1.default.model("fee_payments", fee_payment);
+exports.CFeePayment = CFeePayment;

package/lib/schema/fees/index.d.ts

@@ -2,3 +2,4 @@ export * from './fee_assignment';
 export * from './fee_structure';
 export * from './fee_structure_item';
 export * from './fee_receipt_template';
+export * from './fee_payment';

package/lib/schema/fees/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./fee_assignment"), exports);
 __exportStar(require("./fee_structure"), exports);
 __exportStar(require("./fee_structure_item"), exports);
 __exportStar(require("./fee_receipt_template"), exports);
+__exportStar(require("./fee_payment"), exports);

package/package.json

@@ -9,7 +9,7 @@
     "typescript": "^5.8.3"
   },
   "name": "cloud-ide-model-schema",
-  "version": "1.1.140",
+  "version": "1.1.141",
   "description": "Pachage for schema management of Cloud IDEsys LMS",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",