payservedb 9.2.8 → 9.3.0

package/src/models/propertyManagerRevenue.js

@@ -1,196 +1,196 @@
-const mongoose = require('mongoose');
-
-const propertyManagerRevenue = new mongoose.Schema({
-    facility: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Facility',
-        required: true,
-        index: true
-    },
-    calculationDate: {
-        type: Date,
-        required: true,
-        index: true,
-        default: Date.now
-    },
-    dateRange: {
-        startDate: Date,
-        endDate: Date
-    },
-    // Direct revenue amounts - no calculations needed
-    totalRevenue: {
-        type: Number,
-        required: true,
-        default: 0
-    },
-    totalOwnerAmount: {
-        type: Number,
-        default: 0  // Usually 0 for direct PM invoices
-    },
-    totalPaidAmount: {
-        type: Number,
-        required: true,
-        default: 0
-    },
-    // Processing statistics
-    unitsProcessed: {
-        type: Number,
-        default: 0
-    },
-    invoicesProcessed: {
-        type: Number,
-        default: 0
-    },
-    contractsProcessed: {
-        type: Number,
-        default: 0
-    },
-    // CRITICAL: Track processed invoice numbers to prevent duplicates
-    processedInvoiceNumbers: [{
-        type: String,
-        required: false
-    }],
-    // Unit breakdown - simplified
-    unitBreakdown: [{
-        unit: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'Unit',
-            required: true
-        },
-        unitName: String,
-        contractId: {
-            type: mongoose.Schema.Types.ObjectId,
-            ref: 'PropertyManagerContract'
-        },
-        contractName: String,
-        propertyManager: {
-            id: {
-                type: mongoose.Schema.Types.ObjectId,
-                ref: 'User'
-            },
-            fullName: String,
-            email: String,
-            phoneNumber: String
-        },
-        // Revenue amounts for this unit
-        totalPaid: {
-            type: Number,
-            default: 0
-        },
-        managerRevenue: {
-            type: Number,
-            default: 0
-        },
-        ownerAmount: {
-            type: Number,
-            default: 0
-        },
-        invoiceCount: {
-            type: Number,
-            default: 0
-        },
-        // Invoice details
-        invoices: [{
-            invoice: {
-                type: mongoose.Schema.Types.ObjectId,
-                ref: 'Invoice',
-                required: true
-            },
-            invoiceNumber: {
-                type: String,
-                required: true,
-                index: true
-            },
-            invoiceType: String,
-            totalAmount: Number,
-            paidAmount: Number,
-            managerCommission: Number,
-            ownerAmount: Number,
-            paymentDate: Date,
-            contractId: {
-                type: mongoose.Schema.Types.ObjectId,
-                ref: 'PropertyManagerContract'
-            },
-            contractName: String,
-            revenueSource: {
-                type: String,
-                enum: ['DirectPropertyManagerInvoice', 'CalculatedFromTenantInvoice', 'PropertyManagementInvoice'],
-                default: 'PropertyManagementInvoice'
-            }
-        }]
-    }],
-    summary: {
-        totalUnits: Number,
-        totalInvoicesProcessed: Number,
-        contractsProcessed: Number,
-        calculationNote: String
-    },
-    status: {
-        type: String,
-        enum: ['calculated', 'paid', 'cancelled'],
-        default: 'calculated'
-    },
-    notes: String,
-    createdBy: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'User'
-    },
-    calculationType: {
-        type: String,
-        enum: [
-            'direct_revenue', 
-            'bulk_direct_revenue', 
-            'retroactive_direct',
-            'revenue_extraction',
-            'bulk_revenue_extraction'
-        ],
-        default: 'direct_revenue'
-    }
-}, {
-    timestamps: true
-});
-
-// Enhanced indexes for better performance and duplicate prevention
-propertyManagerRevenue.index({ facility: 1, calculationDate: -1 });
-propertyManagerRevenue.index({ facility: 1, 'unitBreakdown.unit': 1 });
-propertyManagerRevenue.index({ facility: 1, calculationType: 1 });
-propertyManagerRevenue.index({ createdAt: -1 });
-
-// CRITICAL: Compound index for fast duplicate checking by invoice number
-propertyManagerRevenue.index({ 
-    facility: 1, 
-    'unitBreakdown.invoices.invoiceNumber': 1 
-});
-
-// CRITICAL: Index for processed invoice numbers array
-propertyManagerRevenue.index({ 
-    facility: 1, 
-    processedInvoiceNumbers: 1 
-});
-
-// Simple pre-save middleware to auto-populate processedInvoiceNumbers
-propertyManagerRevenue.pre('save', function(next) {
-    try {
-        // Auto-populate processedInvoiceNumbers from unitBreakdown if not set
-        if (!this.processedInvoiceNumbers || this.processedInvoiceNumbers.length === 0) {
-            const invoiceNumbers = [];
-            this.unitBreakdown.forEach(unit => {
-                if (unit.invoices && Array.isArray(unit.invoices)) {
-                    unit.invoices.forEach(invoice => {
-                        if (invoice.invoiceNumber) {
-                            invoiceNumbers.push(invoice.invoiceNumber);
-                        }
-                    });
-                }
-            });
-            this.processedInvoiceNumbers = [...new Set(invoiceNumbers)];
-        }
-        next();
-    } catch (error) {
-        next(error);
-    }
-});
-
-const PropertyManagerRevenue = mongoose.model('PropertyManagerRevenue', propertyManagerRevenue);
-
+const mongoose = require('mongoose');
+
+const propertyManagerRevenue = new mongoose.Schema({
+    facility: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true,
+        index: true
+    },
+    calculationDate: {
+        type: Date,
+        required: true,
+        index: true,
+        default: Date.now
+    },
+    dateRange: {
+        startDate: Date,
+        endDate: Date
+    },
+    // Direct revenue amounts - no calculations needed
+    totalRevenue: {
+        type: Number,
+        required: true,
+        default: 0
+    },
+    totalOwnerAmount: {
+        type: Number,
+        default: 0  // Usually 0 for direct PM invoices
+    },
+    totalPaidAmount: {
+        type: Number,
+        required: true,
+        default: 0
+    },
+    // Processing statistics
+    unitsProcessed: {
+        type: Number,
+        default: 0
+    },
+    invoicesProcessed: {
+        type: Number,
+        default: 0
+    },
+    contractsProcessed: {
+        type: Number,
+        default: 0
+    },
+    // CRITICAL: Track processed invoice numbers to prevent duplicates
+    processedInvoiceNumbers: [{
+        type: String,
+        required: false
+    }],
+    // Unit breakdown - simplified
+    unitBreakdown: [{
+        unit: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'Unit',
+            required: true
+        },
+        unitName: String,
+        contractId: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'PropertyManagerContract'
+        },
+        contractName: String,
+        propertyManager: {
+            id: {
+                type: mongoose.Schema.Types.ObjectId,
+                ref: 'User'
+            },
+            fullName: String,
+            email: String,
+            phoneNumber: String
+        },
+        // Revenue amounts for this unit
+        totalPaid: {
+            type: Number,
+            default: 0
+        },
+        managerRevenue: {
+            type: Number,
+            default: 0
+        },
+        ownerAmount: {
+            type: Number,
+            default: 0
+        },
+        invoiceCount: {
+            type: Number,
+            default: 0
+        },
+        // Invoice details
+        invoices: [{
+            invoice: {
+                type: mongoose.Schema.Types.ObjectId,
+                ref: 'Invoice',
+                required: true
+            },
+            invoiceNumber: {
+                type: String,
+                required: true,
+                index: true
+            },
+            invoiceType: String,
+            totalAmount: Number,
+            paidAmount: Number,
+            managerCommission: Number,
+            ownerAmount: Number,
+            paymentDate: Date,
+            contractId: {
+                type: mongoose.Schema.Types.ObjectId,
+                ref: 'PropertyManagerContract'
+            },
+            contractName: String,
+            revenueSource: {
+                type: String,
+                enum: ['DirectPropertyManagerInvoice', 'CalculatedFromTenantInvoice', 'PropertyManagementInvoice'],
+                default: 'PropertyManagementInvoice'
+            }
+        }]
+    }],
+    summary: {
+        totalUnits: Number,
+        totalInvoicesProcessed: Number,
+        contractsProcessed: Number,
+        calculationNote: String
+    },
+    status: {
+        type: String,
+        enum: ['calculated', 'paid', 'cancelled'],
+        default: 'calculated'
+    },
+    notes: String,
+    createdBy: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User'
+    },
+    calculationType: {
+        type: String,
+        enum: [
+            'direct_revenue', 
+            'bulk_direct_revenue', 
+            'retroactive_direct',
+            'revenue_extraction',
+            'bulk_revenue_extraction'
+        ],
+        default: 'direct_revenue'
+    }
+}, {
+    timestamps: true
+});
+
+// Enhanced indexes for better performance and duplicate prevention
+propertyManagerRevenue.index({ facility: 1, calculationDate: -1 });
+propertyManagerRevenue.index({ facility: 1, 'unitBreakdown.unit': 1 });
+propertyManagerRevenue.index({ facility: 1, calculationType: 1 });
+propertyManagerRevenue.index({ createdAt: -1 });
+
+// CRITICAL: Compound index for fast duplicate checking by invoice number
+propertyManagerRevenue.index({ 
+    facility: 1, 
+    'unitBreakdown.invoices.invoiceNumber': 1 
+});
+
+// CRITICAL: Index for processed invoice numbers array
+propertyManagerRevenue.index({ 
+    facility: 1, 
+    processedInvoiceNumbers: 1 
+});
+
+// Simple pre-save middleware to auto-populate processedInvoiceNumbers
+propertyManagerRevenue.pre('save', function(next) {
+    try {
+        // Auto-populate processedInvoiceNumbers from unitBreakdown if not set
+        if (!this.processedInvoiceNumbers || this.processedInvoiceNumbers.length === 0) {
+            const invoiceNumbers = [];
+            this.unitBreakdown.forEach(unit => {
+                if (unit.invoices && Array.isArray(unit.invoices)) {
+                    unit.invoices.forEach(invoice => {
+                        if (invoice.invoiceNumber) {
+                            invoiceNumbers.push(invoice.invoiceNumber);
+                        }
+                    });
+                }
+            });
+            this.processedInvoiceNumbers = [...new Set(invoiceNumbers)];
+        }
+        next();
+    } catch (error) {
+        next(error);
+    }
+});
+
+const PropertyManagerRevenue = mongoose.model('PropertyManagerRevenue', propertyManagerRevenue);
+
 module.exports = PropertyManagerRevenue;

package/src/models/propertyManagerRevenueEntry.js

@@ -0,0 +1,108 @@
+const mongoose = require('mongoose');
+
+// One document per revenue event earned by a property manager.
+// Sources: booking commission, lease fee (first rent payment) and rent commission.
+const propertyManagerRevenueEntrySchema = new mongoose.Schema({
+    facility: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Facility',
+        required: true,
+        index: true
+    },
+    propertyManager: {
+        id: {
+            type: mongoose.Schema.Types.ObjectId,
+            ref: 'User',
+            required: true,
+            index: true
+        },
+        fullName: String,
+        email: String,
+        phoneNumber: String
+    },
+    contractId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'PropertyManagerContract'
+    },
+    contractName: String,
+    unit: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Unit',
+        required: true
+    },
+    unitName: String,
+    source: {
+        type: String,
+        enum: ['booking_commission', 'lease_fee', 'rent_commission'],
+        required: true,
+        index: true
+    },
+    // Amount the rate was applied to (paid amount of the invoice / booking)
+    baseAmount: {
+        type: Number,
+        default: 0
+    },
+    rate: {
+        type: {
+            type: String,
+            enum: ['percentage', 'amount']
+        },
+        value: {
+            type: Number,
+            default: 0
+        }
+    },
+    // Revenue earned by the property manager
+    amount: {
+        type: Number,
+        required: true,
+        default: 0
+    },
+    // Source document that generated this entry (dedupe key)
+    reference: {
+        kind: {
+            type: String,
+            enum: ['invoice', 'reservation'],
+            required: true
+        },
+        id: {
+            type: mongoose.Schema.Types.ObjectId,
+            required: true
+        },
+        number: String
+    },
+    // Tenant / guest the revenue relates to
+    client: {
+        id: mongoose.Schema.Types.ObjectId,
+        name: String
+    },
+    earnedDate: {
+        type: Date,
+        default: Date.now,
+        index: true
+    },
+    status: {
+        type: String,
+        enum: ['earned', 'cancelled'],
+        default: 'earned'
+    },
+    notes: String,
+    createdBy: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User'
+    }
+}, {
+    timestamps: true
+});
+
+// A source document can only generate one entry per revenue stream
+propertyManagerRevenueEntrySchema.index(
+    { facility: 1, source: 1, 'reference.id': 1 },
+    { unique: true }
+);
+propertyManagerRevenueEntrySchema.index({ facility: 1, 'propertyManager.id': 1, source: 1, earnedDate: -1 });
+propertyManagerRevenueEntrySchema.index({ facility: 1, earnedDate: -1 });
+
+const PropertyManagerRevenueEntry = mongoose.model('PropertyManagerRevenueEntry', propertyManagerRevenueEntrySchema);
+
+module.exports = PropertyManagerRevenueEntry;

package/src/models/purchaseOrderInvoice.js

@@ -1,74 +1,74 @@
-const mongoose = require('mongoose');
-
-const purchaseOrderInvoiceSchema = new mongoose.Schema({
-    date: {
-        type: Date,
-        required: true,
-        default: Date.now
-    },
-    purchaseOrderId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'PurchaseOrder',
-        required: true,
-        index: true
-    },
-    grnId: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'GoodsReceivedNote',
-        required: true,
-        index: true
-    },
-    quantity: {
-        type: Number,
-        required: true,
-        min: 0
-    },
-    quantityReceived: {
-        type: Number,
-        min: 0
-    },
-     quantityBalance: {
-        type: Number,
-         min: 0
-    },
-    totalAmount: {
-        type: Number,
-        required: true,
-        min: 0
-    },
-    paymentStatus: {
-        type: String,
-        enum: ['unpaid', 'partial', 'paid'],
-        default: 'unpaid',
-        index: true
-    },
-    notes: {
-        type: String,
-        trim: true
-    },
-    supplier: {
-        type: mongoose.Schema.Types.ObjectId,
-        ref: 'Supplier',
-        required: true
-    },
-    files: [{
-        fileName: {
-            type: String,
-            required: true
-        },
-        fileType: {
-            type: String,
-            required: true
-        },
-        fileUrl: {
-            type: String,
-            required: true
-        }
-    }],
-}, {
-    timestamps: true
-});
-
-const PurchaseOrderInvoice = mongoose.model('PurchaseOrderInvoice', purchaseOrderInvoiceSchema);
-
-module.exports = PurchaseOrderInvoice;
+const mongoose = require('mongoose');
+
+const purchaseOrderInvoiceSchema = new mongoose.Schema({
+    date: {
+        type: Date,
+        required: true,
+        default: Date.now
+    },
+    purchaseOrderId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'PurchaseOrder',
+        required: true,
+        index: true
+    },
+    grnId: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'GoodsReceivedNote',
+        required: true,
+        index: true
+    },
+    quantity: {
+        type: Number,
+        required: true,
+        min: 0
+    },
+    quantityReceived: {
+        type: Number,
+        min: 0
+    },
+     quantityBalance: {
+        type: Number,
+         min: 0
+    },
+    totalAmount: {
+        type: Number,
+        required: true,
+        min: 0
+    },
+    paymentStatus: {
+        type: String,
+        enum: ['unpaid', 'partial', 'paid'],
+        default: 'unpaid',
+        index: true
+    },
+    notes: {
+        type: String,
+        trim: true
+    },
+    supplier: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'Supplier',
+        required: true
+    },
+    files: [{
+        fileName: {
+            type: String,
+            required: true
+        },
+        fileType: {
+            type: String,
+            required: true
+        },
+        fileUrl: {
+            type: String,
+            required: true
+        }
+    }],
+}, {
+    timestamps: true
+});
+
+const PurchaseOrderInvoice = mongoose.model('PurchaseOrderInvoice', purchaseOrderInvoiceSchema);
+
+module.exports = PurchaseOrderInvoice;