payservedb 9.2.6 → 9.2.8

package/src/models/levy_invoice_settings.js

@@ -1,27 +1,27 @@
-const mongoose = require('mongoose');
-
-const InvoiceSettingsSchema = new mongoose.Schema({
-    facilityId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Facility',
-        required: [true, 'Facility ID is required']
-    },
-    termsAndConditions: {
-        type: String,
-        default: 'Payment is due within 15 days'
-    },
-    bankName: {
-        type: String,
-        required: [true, 'Bank name is required']
-    },
-    accountNumber: {
-        type: String,
-        required: [true, 'Account number is required']
-    }
-}, {
-    timestamps: true
-});
-
-const InvoiceSettings = mongoose.model('InvoiceSettings', InvoiceSettingsSchema);
-
+const mongoose = require('mongoose');
+
+const InvoiceSettingsSchema = new mongoose.Schema({
+    facilityId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: [true, 'Facility ID is required']
+    },
+    termsAndConditions: {
+        type: String,
+        default: 'Payment is due within 15 days'
+    },
+    bankName: {
+        type: String,
+        required: [true, 'Bank name is required']
+    },
+    accountNumber: {
+        type: String,
+        required: [true, 'Account number is required']
+    }
+}, {
+    timestamps: true
+});
+
+const InvoiceSettings = mongoose.model('InvoiceSettings', InvoiceSettingsSchema);
+
 module.exports = InvoiceSettings;

package/src/models/levy_payment_receipt.js

@@ -0,0 +1,157 @@
+const mongoose = require('mongoose');
+const Schema = mongoose.Schema;
+
+const ContractPaymentReceiptSchema = new Schema(
+    {
+        contractId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'LevyContract',
+            required: [true, 'Contract ID is required']
+        },
+        customerId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Customer',
+            required: [true, 'Customer ID is required']
+        },
+        unitId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Unit',
+            required: [true, 'Unit ID is required']
+        },
+        facilityId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Facility',
+            required: [true, 'Facility ID is required']
+        },
+
+        receiptNumber: {
+            type: String,
+            required: [true, 'Receipt number is required'],
+            unique: true,
+            trim: true
+        },
+        paymentReference: {
+            type: String,
+            trim: true
+        },
+        datePaid: {
+            type: Date,
+            required: [true, 'Date paid is required']
+        },
+        paymentMethod: {
+            type: String,
+            trim: true
+            // e.g. 'mpesa', 'bank', 'cash' — not currently captured on the
+            // contract form, left optional until that's wired up
+        },
+
+        lineItems: [
+            {
+                lineType: {
+                    type: String,
+                    enum: ['Deposit', 'UpfrontPayment'],
+                    required: true
+                },
+                description: {
+                    type: String,
+                    required: true
+                },
+                quantity: {
+                    type: Number,
+                    default: 1
+                },
+                unitAmount: {
+                    type: Number,
+                    required: true,
+                    min: [0, 'Unit amount cannot be negative']
+                },
+                taxRate: {
+                    type: Number,
+                    default: 0
+                },
+                taxAmount: {
+                    type: Number,
+                    default: 0
+                },
+                lineTotal: {
+                    type: Number,
+                    required: true
+                },
+                depositId: {
+                    type: mongoose.Schema.Types.ObjectId,
+                    ref: 'Deposit'
+                }
+            }
+        ],
+
+        subTotal: {
+            type: Number,
+            required: true,
+            default: 0
+        },
+        taxTotal: {
+            type: Number,
+            required: true,
+            default: 0
+        },
+        totalCharges: {
+            type: Number,
+            required: true,
+            default: 0
+        },
+        amountPaid: {
+            type: Number,
+            required: true,
+            default: 0
+        },
+        balanceDue: {
+            type: Number,
+            required: true,
+            default: 0
+            // positive = still owed, negative = overpaid
+        },
+        overpaymentAmount: {
+            type: Number,
+            default: 0
+        },
+
+        createdBy: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User'
+        }
+    },
+    {
+        timestamps: true,
+        toJSON: { virtuals: true },
+        toObject: { virtuals: true }
+    }
+);
+
+ContractPaymentReceiptSchema.virtual('contract', {
+    ref: 'LevyContract',
+    localField: 'contractId',
+    foreignField: '_id',
+    justOne: true
+});
+
+ContractPaymentReceiptSchema.virtual('customer', {
+    ref: 'Customer',
+    localField: 'customerId',
+    foreignField: '_id',
+    justOne: true
+});
+
+ContractPaymentReceiptSchema.virtual('unit', {
+    ref: 'Unit',
+    localField: 'unitId',
+    foreignField: '_id',
+    justOne: true
+});
+
+ContractPaymentReceiptSchema.index({ facilityId: 1, receiptNumber: 1 });
+ContractPaymentReceiptSchema.index({ contractId: 1 });
+
+module.exports = {
+    schema: ContractPaymentReceiptSchema,
+    name: 'ContractPaymentReceipt'
+};

package/src/models/levycontract.js

@@ -1,227 +1,227 @@
-const mongoose = require('mongoose');
-const Schema = mongoose.Schema;
-
-const LevyContractSchema = new Schema(
-    {
-        contractName: {
-            type: String,
-            required: [true, 'Contract name is required']
-        },
-        levyId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'Levy',
-            required: [true, 'Levy ID is required']
-        },
-        customerId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'Customer',
-            required: [true, 'Customer ID is required']
-        },
-        unitId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'Unit',
-            required: [true, 'Unit ID is required']
-        },
-        amount: {
-            type: Number,
-            required: [true, 'Amount is required'],
-            min: [0, 'Amount cannot be negative']
-        },
-        startDate: {
-            type: Date,
-        },
-        endDate: {
-            type: Date,
-        },
-        status: {
-            type: String,
-            enum: ['Active', 'Inactive', 'Completed', 'Suspended', 'Terminated'],
-            default: 'Active',
-            required: [true, 'Status is required']
-        },
-        balanceBroughtForward: {
-            type: Number,
-            default: 0
-        },
-        taxEnabled: {
-            type: Boolean
-        },
-        enabledTaxes: [
-            {
-                type: mongoose.Schema.Types.ObjectId,
-                ref: 'CountryTaxRate'
-            }
-        ],
-        paymentFrequency: {
-            type: String,
-            enum: ['Daily', 'Weekly', 'Bi-Weekly', 'Monthly', 'Quarterly', 'Semi-Annually', 'Annually'],
-            default: 'Monthly'
-        },
-        facilityId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'Facility',
-            required: [true, 'Facility ID is required']
-        },
-        lastInvoiceDate: {
-            type: Date
-        },
-        createdBy: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'User'
-        },
-        updatedBy: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'User'
-        },
-        // New termination-specific fields
-        terminationDate: {
-            type: Date
-        },
-        terminationReason: {
-            type: String
-        },
-        terminatedBy: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'User'
-        },
-        // Disable/reactivation tracking
-        disabledDate: {
-            type: Date
-        },
-        disabledBy: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'User'
-        },
-        disabledReason: {
-            type: String
-        },
-        reactivatedDate: {
-            type: Date
-        },
-        reactivatedBy: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'User'
-        },
-        lastInvoiceYearMonth: {
-            type: String,
-            default: null
-            // Format: "2025-09", "2025-10", etc.
-        },
-        // Upfront payment fields
-        upfrontPayment: {
-            enabled: {
-                type: Boolean,
-                default: false
-            },
-            amount: {
-                type: Number,
-                default: 0,
-                min: [0, 'Upfront amount cannot be negative']
-            },
-            numberOfMonths: {
-                type: Number,
-                min: [1, 'Number of months must be at least 1']
-            },
-            amountPerMonth: {
-                type: Number,
-                min: [0, 'Amount per month cannot be negative']
-            },
-            calculationMode: {
-                type: String,
-                enum: ['auto', 'custom'],
-                default: 'auto'
-            },
-            billingPeriods: {
-                type: [String],
-                default: []
-            },
-            collectionFrequency: {
-                type: String,
-                enum: ['Monthly', 'Quarterly', 'Semi-Annually', 'Annually'],
-                default: 'Monthly'
-            },
-            remainingAmount: {
-                type: Number,
-                default: 0
-            },
-            processedPeriods: {
-                type: [String],
-                default: []
-            },
-            createdAt: {
-                type: Date,
-                default: Date.now
-            }
-        }
-    },
-    {
-        timestamps: true,
-        toJSON: { virtuals: true },
-        toObject: { virtuals: true }
-    }
-);
-
-// Virtual populate for Levy details
-LevyContractSchema.virtual('levy', {
-    ref: 'Levy',
-    localField: 'levyId',
-    foreignField: '_id',
-    justOne: true
-});
-
-// Virtual populate for Customer details
-LevyContractSchema.virtual('customer', {
-    ref: 'Customer',
-    localField: 'customerId',
-    foreignField: '_id',
-    justOne: true
-});
-
-// Virtual populate for Unit details
-LevyContractSchema.virtual('unit', {
-    ref: 'Unit',
-    localField: 'unitId',
-    foreignField: '_id',
-    justOne: true
-});
-
-// Pre-save middleware to ensure endDate is after startDate
-LevyContractSchema.pre('save', function (next) {
-    if (this.startDate && this.endDate && this.startDate >= this.endDate) {
-        next(new Error('End date must be after start date'));
-    } else {
-        next();
-    }
-});
-
-// Pre-save middleware to handle termination and disable date logic
-LevyContractSchema.pre('save', function (next) {
-    // Set termination date when status changes to Terminated
-    if (this.status === 'Terminated' && !this.terminationDate) {
-        this.terminationDate = new Date();
-    }
-
-    // Set disabled date when status changes to Inactive
-    if (this.status === 'Inactive' && !this.disabledDate && this.isModified('status')) {
-        this.disabledDate = new Date();
-    }
-
-    // Set reactivated date when status changes from Inactive to Active
-    if (this.status === 'Active' && this.isModified('status') && this.disabledDate) {
-        this.reactivatedDate = new Date();
-    }
-
-    next();
-});
-
-// Index for efficient queries
-LevyContractSchema.index({ levyId: 1, unitId: 1, status: 1 });
-LevyContractSchema.index({ facilityId: 1 });
-LevyContractSchema.index({ customerId: 1 });
-LevyContractSchema.index({ status: 1 });
-LevyContractSchema.index({ terminationDate: 1 });
-
-module.exports = {
-    schema: LevyContractSchema,
-    name: 'LevyContract'
+const mongoose = require('mongoose');
+const Schema = mongoose.Schema;
+
+const LevyContractSchema = new Schema(
+    {
+        contractName: {
+            type: String,
+            required: [true, 'Contract name is required']
+        },
+        levyId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Levy',
+            required: [true, 'Levy ID is required']
+        },
+        customerId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Customer',
+            required: [true, 'Customer ID is required']
+        },
+        unitId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Unit',
+            required: [true, 'Unit ID is required']
+        },
+        amount: {
+            type: Number,
+            required: [true, 'Amount is required'],
+            min: [0, 'Amount cannot be negative']
+        },
+        startDate: {
+            type: Date,
+        },
+        endDate: {
+            type: Date,
+        },
+        status: {
+            type: String,
+            enum: ['Active', 'Inactive', 'Completed', 'Suspended', 'Terminated'],
+            default: 'Active',
+            required: [true, 'Status is required']
+        },
+        balanceBroughtForward: {
+            type: Number,
+            default: 0
+        },
+        taxEnabled: {
+            type: Boolean
+        },
+        enabledTaxes: [
+            {
+                type: mongoose.Schema.Types.ObjectId,
+                ref: 'CountryTaxRate'
+            }
+        ],
+        paymentFrequency: {
+            type: String,
+            enum: ['Daily', 'Weekly', 'Bi-Weekly', 'Monthly', 'Quarterly', 'Semi-Annually', 'Annually'],
+            default: 'Monthly'
+        },
+        facilityId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Facility',
+            required: [true, 'Facility ID is required']
+        },
+        lastInvoiceDate: {
+            type: Date
+        },
+        createdBy: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User'
+        },
+        updatedBy: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User'
+        },
+        // New termination-specific fields
+        terminationDate: {
+            type: Date
+        },
+        terminationReason: {
+            type: String
+        },
+        terminatedBy: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User'
+        },
+        // Disable/reactivation tracking
+        disabledDate: {
+            type: Date
+        },
+        disabledBy: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User'
+        },
+        disabledReason: {
+            type: String
+        },
+        reactivatedDate: {
+            type: Date
+        },
+        reactivatedBy: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User'
+        },
+        lastInvoiceYearMonth: {
+            type: String,
+            default: null
+            // Format: "2025-09", "2025-10", etc.
+        },
+        // Upfront payment fields
+        upfrontPayment: {
+            enabled: {
+                type: Boolean,
+                default: false
+            },
+            amount: {
+                type: Number,
+                default: 0,
+                min: [0, 'Upfront amount cannot be negative']
+            },
+            numberOfMonths: {
+                type: Number,
+                min: [1, 'Number of months must be at least 1']
+            },
+            amountPerMonth: {
+                type: Number,
+                min: [0, 'Amount per month cannot be negative']
+            },
+            calculationMode: {
+                type: String,
+                enum: ['auto', 'custom'],
+                default: 'auto'
+            },
+            billingPeriods: {
+                type: [String],
+                default: []
+            },
+            collectionFrequency: {
+                type: String,
+                enum: ['Monthly', 'Quarterly', 'Semi-Annually', 'Annually'],
+                default: 'Monthly'
+            },
+            remainingAmount: {
+                type: Number,
+                default: 0
+            },
+            processedPeriods: {
+                type: [String],
+                default: []
+            },
+            createdAt: {
+                type: Date,
+                default: Date.now
+            }
+        }
+    },
+    {
+        timestamps: true,
+        toJSON: { virtuals: true },
+        toObject: { virtuals: true }
+    }
+);
+
+// Virtual populate for Levy details
+LevyContractSchema.virtual('levy', {
+    ref: 'Levy',
+    localField: 'levyId',
+    foreignField: '_id',
+    justOne: true
+});
+
+// Virtual populate for Customer details
+LevyContractSchema.virtual('customer', {
+    ref: 'Customer',
+    localField: 'customerId',
+    foreignField: '_id',
+    justOne: true
+});
+
+// Virtual populate for Unit details
+LevyContractSchema.virtual('unit', {
+    ref: 'Unit',
+    localField: 'unitId',
+    foreignField: '_id',
+    justOne: true
+});
+
+// Pre-save middleware to ensure endDate is after startDate
+LevyContractSchema.pre('save', function (next) {
+    if (this.startDate && this.endDate && this.startDate >= this.endDate) {
+        next(new Error('End date must be after start date'));
+    } else {
+        next();
+    }
+});
+
+// Pre-save middleware to handle termination and disable date logic
+LevyContractSchema.pre('save', function (next) {
+    // Set termination date when status changes to Terminated
+    if (this.status === 'Terminated' && !this.terminationDate) {
+        this.terminationDate = new Date();
+    }
+
+    // Set disabled date when status changes to Inactive
+    if (this.status === 'Inactive' && !this.disabledDate && this.isModified('status')) {
+        this.disabledDate = new Date();
+    }
+
+    // Set reactivated date when status changes from Inactive to Active
+    if (this.status === 'Active' && this.isModified('status') && this.disabledDate) {
+        this.reactivatedDate = new Date();
+    }
+
+    next();
+});
+
+// Index for efficient queries
+LevyContractSchema.index({ levyId: 1, unitId: 1, status: 1 });
+LevyContractSchema.index({ facilityId: 1 });
+LevyContractSchema.index({ customerId: 1 });
+LevyContractSchema.index({ status: 1 });
+LevyContractSchema.index({ terminationDate: 1 });
+
+module.exports = {
+    schema: LevyContractSchema,
+    name: 'LevyContract'
 };