payservedb 8.7.0 → 8.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. package/.env +2 -2
  2. package/ZOHO_INTEGRATION_SCHEMA.md +644 -644
  3. package/index.js +319 -319
  4. package/package.json +17 -17
  5. package/src/models/account.js +52 -52
  6. package/src/models/agent_departments.js +59 -59
  7. package/src/models/agent_notifications.js +53 -53
  8. package/src/models/agent_performance.js +127 -127
  9. package/src/models/agent_roles.js +77 -77
  10. package/src/models/agents.js +154 -154
  11. package/src/models/apilog.js +18 -18
  12. package/src/models/approvalsWorkflows.js +49 -49
  13. package/src/models/archivedapilog.js +18 -18
  14. package/src/models/asset.js +92 -92
  15. package/src/models/assetsAssignment.js +64 -64
  16. package/src/models/auditTrail.js +346 -346
  17. package/src/models/bankdetails.js +47 -47
  18. package/src/models/billerAddress.js +124 -124
  19. package/src/models/booking_invoice.js +165 -165
  20. package/src/models/bookinganalytics.js +63 -63
  21. package/src/models/bookingconfig.js +45 -45
  22. package/src/models/bookingproperty.js +179 -179
  23. package/src/models/bookingreservation.js +239 -239
  24. package/src/models/bookingrevenuerecord.js +84 -84
  25. package/src/models/budget.js +95 -95
  26. package/src/models/budgetCategory.js +19 -19
  27. package/src/models/campaigns.js +108 -108
  28. package/src/models/cashpayment.js +291 -291
  29. package/src/models/combinedUnits.js +62 -62
  30. package/src/models/combined_invoice.js +424 -424
  31. package/src/models/common_area_electricity.js +38 -38
  32. package/src/models/common_area_generator.js +41 -41
  33. package/src/models/common_area_utility_alert.js +37 -37
  34. package/src/models/common_area_water.js +39 -39
  35. package/src/models/communication_status.js +33 -33
  36. package/src/models/communication_user_opt.js +32 -32
  37. package/src/models/community_guidelines.js +35 -35
  38. package/src/models/company.js +53 -53
  39. package/src/models/coreBaseSettings.js +16 -16
  40. package/src/models/coreInvoiceSettings.js +100 -100
  41. package/src/models/counter_schema.js +21 -21
  42. package/src/models/country_tax.js +42 -42
  43. package/src/models/currency_settings.js +39 -39
  44. package/src/models/customer.js +214 -214
  45. package/src/models/customer_satisfaction_survey.js +278 -278
  46. package/src/models/customer_surveys.js +139 -139
  47. package/src/models/customer_tickets.js +239 -239
  48. package/src/models/dailyChecklist.js +312 -312
  49. package/src/models/default_payment_details.js +17 -17
  50. package/src/models/deliveryTimeMarks.js +18 -18
  51. package/src/models/document_type.js +19 -19
  52. package/src/models/dutyRosterChecklist.js +250 -250
  53. package/src/models/dutyroster.js +136 -136
  54. package/src/models/email.js +37 -37
  55. package/src/models/email_sms_queue.js +61 -61
  56. package/src/models/entry_exit.js +53 -53
  57. package/src/models/expense.js +99 -99
  58. package/src/models/expense_category.js +45 -45
  59. package/src/models/facility.js +71 -71
  60. package/src/models/facilityBillingPrices.js +29 -29
  61. package/src/models/facilityInvoice.js +240 -240
  62. package/src/models/facilityInvoicePayment.js +52 -52
  63. package/src/models/facilityInvoiceRecipient.js +32 -32
  64. package/src/models/facilityWalletTransactionsMetadata.js +236 -236
  65. package/src/models/facility_departements.js +20 -20
  66. package/src/models/facility_payment_details.js +20 -20
  67. package/src/models/facility_rating.js +78 -78
  68. package/src/models/facilityasset.js +25 -25
  69. package/src/models/faq.js +14 -14
  70. package/src/models/gl_account_double_entries.js +25 -25
  71. package/src/models/gl_accounts.js +56 -56
  72. package/src/models/gl_entries.js +49 -49
  73. package/src/models/goodsReceivedNotes.js +115 -115
  74. package/src/models/guard.js +47 -47
  75. package/src/models/handover.js +258 -258
  76. package/src/models/inspection_category.js +38 -38
  77. package/src/models/invoice.js +480 -480
  78. package/src/models/invoice_generation_approval.js +86 -86
  79. package/src/models/invoicing_schedule.js +40 -40
  80. package/src/models/item_inspection.js +96 -96
  81. package/src/models/knowledge_base.js +109 -109
  82. package/src/models/knowledge_base_rating.js +44 -44
  83. package/src/models/leaseagreement.js +237 -237
  84. package/src/models/leasetemplate.js +17 -17
  85. package/src/models/levy.js +223 -223
  86. package/src/models/levy_invoice_settings.js +26 -26
  87. package/src/models/levycontract.js +210 -210
  88. package/src/models/levytype.js +23 -23
  89. package/src/models/maintenance_service_vendor.js +38 -38
  90. package/src/models/maintenance_services.js +17 -17
  91. package/src/models/maintenancerequisition.js +31 -31
  92. package/src/models/master_workplan.js +32 -32
  93. package/src/models/master_workplan_child.js +34 -34
  94. package/src/models/message.js +38 -38
  95. package/src/models/module.js +21 -21
  96. package/src/models/notification.js +44 -44
  97. package/src/models/paymentTermsMarks.js +19 -19
  98. package/src/models/penalty.js +76 -76
  99. package/src/models/pendingCredentials.js +32 -32
  100. package/src/models/powerMeterCommunicationProtocol.js +17 -17
  101. package/src/models/powerMeterCustomerAccount.js +78 -78
  102. package/src/models/powerMeterCustomerBand.js +14 -14
  103. package/src/models/powerMeterDailyReading.js +30 -30
  104. package/src/models/powerMeterGateways.js +40 -40
  105. package/src/models/powerMeterMonthlyReading.js +34 -34
  106. package/src/models/powerMeterPowerCharges.js +85 -85
  107. package/src/models/powerMeterSettings.js +159 -159
  108. package/src/models/powerMeterSingleDayReading.js +32 -32
  109. package/src/models/powerMeters.js +116 -116
  110. package/src/models/powerMetersManufacturer.js +14 -14
  111. package/src/models/power_meter_account.js +81 -81
  112. package/src/models/power_meter_command_logs.js +30 -30
  113. package/src/models/power_meter_command_queue.js +33 -33
  114. package/src/models/power_meter_negative_balance.js +44 -44
  115. package/src/models/power_prepaid_credits.js +47 -47
  116. package/src/models/power_prepaid_debits.js +53 -53
  117. package/src/models/power_prepaid_orders.js +78 -78
  118. package/src/models/power_sms_notification.js +26 -26
  119. package/src/models/privacy_policy.js +19 -19
  120. package/src/models/propertyManagerContract.js +556 -556
  121. package/src/models/propertyManagerRevenue.js +195 -195
  122. package/src/models/purchaseOrderInvoice.js +74 -74
  123. package/src/models/purchase_order.js +213 -213
  124. package/src/models/purchase_request.js +110 -110
  125. package/src/models/quickbooks_config.js +52 -41
  126. package/src/models/refresh_token.js +23 -23
  127. package/src/models/reminder.js +197 -197
  128. package/src/models/report.js +13 -13
  129. package/src/models/resident.js +121 -121
  130. package/src/models/rfq_details.js +131 -131
  131. package/src/models/rfq_response.js +153 -153
  132. package/src/models/service_charge_invoice_upload.js +42 -42
  133. package/src/models/service_charge_payments.js +27 -27
  134. package/src/models/servicerequest.js +55 -55
  135. package/src/models/settings.js +62 -62
  136. package/src/models/short_urls.js +21 -21
  137. package/src/models/smart_meter_daily_consumption.js +44 -44
  138. package/src/models/sms_africastalking.js +20 -20
  139. package/src/models/sms_balance_notification.js +26 -26
  140. package/src/models/sms_meliora.js +20 -20
  141. package/src/models/staff.js +36 -36
  142. package/src/models/stocksandspare.js +161 -161
  143. package/src/models/suppliers.js +74 -74
  144. package/src/models/terms_and_conditions.js +19 -19
  145. package/src/models/tickets.js +186 -186
  146. package/src/models/tickets_category.js +72 -72
  147. package/src/models/unitManagementTemplate.js +44 -44
  148. package/src/models/unitasset.js +25 -25
  149. package/src/models/units.js +118 -118
  150. package/src/models/user.js +185 -185
  151. package/src/models/valueaddedservices.js +50 -79
  152. package/src/models/vas_invoices_upload.js +50 -50
  153. package/src/models/vas_payments.js +24 -24
  154. package/src/models/vasinvoice.js +192 -192
  155. package/src/models/vasvendor.js +57 -57
  156. package/src/models/visitLog.js +95 -95
  157. package/src/models/visitor.js +67 -67
  158. package/src/models/waitlist.js +45 -45
  159. package/src/models/wallet.js +44 -44
  160. package/src/models/wallet_transactions.js +50 -50
  161. package/src/models/water_invoice.js +351 -351
  162. package/src/models/water_meter_Command_Queue.js +33 -33
  163. package/src/models/water_meter_account.js +86 -86
  164. package/src/models/water_meter_billing.js +58 -58
  165. package/src/models/water_meter_combined_accounts.js +92 -92
  166. package/src/models/water_meter_communication.js +17 -17
  167. package/src/models/water_meter_communication_logs.js +39 -39
  168. package/src/models/water_meter_concentrator.js +70 -70
  169. package/src/models/water_meter_daily_history.js +32 -32
  170. package/src/models/water_meter_high_risk.js +36 -36
  171. package/src/models/water_meter_iot_cards.js +34 -34
  172. package/src/models/water_meter_loan_deduction.js +134 -134
  173. package/src/models/water_meter_manufacturer.js +35 -35
  174. package/src/models/water_meter_monthly_history.js +36 -36
  175. package/src/models/water_meter_negative_amounts.js +44 -44
  176. package/src/models/water_meter_settings.js +290 -290
  177. package/src/models/water_meter_single_day_history.js +34 -34
  178. package/src/models/water_meter_size.js +15 -15
  179. package/src/models/water_meters.js +133 -133
  180. package/src/models/water_meters_delivery.js +76 -76
  181. package/src/models/water_prepaid_credit.js +47 -47
  182. package/src/models/water_prepaid_debit.js +50 -50
  183. package/src/models/workorder.js +49 -49
  184. package/src/models/zohoAccount.js +453 -453
  185. package/src/models/zohoIntegration.js +262 -262
  186. package/src/models/zohoItem.js +504 -504
@@ -1,71 +1,71 @@
1
- const mongoose = require('mongoose');
2
- const concentratorSchema = new mongoose.Schema({
3
- serialNumber: {
4
- type: String,
5
- required: true,
6
- trim: true,
7
- unique: true
8
- },
9
- manufacturer: {
10
- type: mongoose.Schema.Types.ObjectId,
11
- ref: 'MeterManufacturer',
12
- },
13
- range: {
14
- type: Number,
15
- min: 0
16
- },
17
- isInstalled: {
18
- type: Boolean,
19
- default: false
20
- },
21
- isFaulty: {
22
- type: Boolean,
23
- default: false
24
- },
25
- inStock: {
26
- type: Boolean,
27
- default: true
28
- },
29
- status: {
30
- type: String,
31
- required: true,
32
- enum: ['online', 'offline', 'maintenance'],
33
- default: 'offline'
34
- },
35
- ipAddress: {
36
- type: String,
37
- trim: true
38
- },
39
- meter_fails: {
40
- type: Number,
41
- min: 0
42
- },
43
- facilityId: [{
44
- type: mongoose.Schema.Types.ObjectId,
45
- ref: 'Facility',
46
- }],
47
- location: {
48
- city: {
49
- type: String,
50
- trim: true
51
- },
52
- latitude: {
53
- type: Number,
54
- min: -90,
55
- max: 90
56
- },
57
- longitude: {
58
- type: Number,
59
- min: -180,
60
- max: 180
61
- }
62
- },
63
- lastUpdated: {
64
- type: String
65
- }
66
- }, {
67
- timestamps: true
68
- });
69
-
70
- const Concentrator = mongoose.model('Concentrator', concentratorSchema);
1
+ const mongoose = require('mongoose');
2
+ const concentratorSchema = new mongoose.Schema({
3
+ serialNumber: {
4
+ type: String,
5
+ required: true,
6
+ trim: true,
7
+ unique: true
8
+ },
9
+ manufacturer: {
10
+ type: mongoose.Schema.Types.ObjectId,
11
+ ref: 'MeterManufacturer',
12
+ },
13
+ range: {
14
+ type: Number,
15
+ min: 0
16
+ },
17
+ isInstalled: {
18
+ type: Boolean,
19
+ default: false
20
+ },
21
+ isFaulty: {
22
+ type: Boolean,
23
+ default: false
24
+ },
25
+ inStock: {
26
+ type: Boolean,
27
+ default: true
28
+ },
29
+ status: {
30
+ type: String,
31
+ required: true,
32
+ enum: ['online', 'offline', 'maintenance'],
33
+ default: 'offline'
34
+ },
35
+ ipAddress: {
36
+ type: String,
37
+ trim: true
38
+ },
39
+ meter_fails: {
40
+ type: Number,
41
+ min: 0
42
+ },
43
+ facilityId: [{
44
+ type: mongoose.Schema.Types.ObjectId,
45
+ ref: 'Facility',
46
+ }],
47
+ location: {
48
+ city: {
49
+ type: String,
50
+ trim: true
51
+ },
52
+ latitude: {
53
+ type: Number,
54
+ min: -90,
55
+ max: 90
56
+ },
57
+ longitude: {
58
+ type: Number,
59
+ min: -180,
60
+ max: 180
61
+ }
62
+ },
63
+ lastUpdated: {
64
+ type: String
65
+ }
66
+ }, {
67
+ timestamps: true
68
+ });
69
+
70
+ const Concentrator = mongoose.model('Concentrator', concentratorSchema);
71
71
  module.exports = Concentrator;
@@ -1,33 +1,33 @@
1
- const mongoose = require('mongoose');
2
-
3
- const dailyWaterMeterHistorySchema = new mongoose.Schema({
4
- meterId: {
5
- type: mongoose.Schema.Types.ObjectId,
6
- ref: 'WaterMeter',
7
- required: true,
8
- index: true
9
- },
10
- date: {
11
- type: Date,
12
- required: true,
13
- index: true
14
- },
15
- reading: {
16
- type: Number,
17
- required: true,
18
- min: 0
19
- },
20
- status: {
21
- type: String,
22
- enum: ['opened', 'closed', 'maintenance', 'faulty'],
23
- default: 'opened',
24
- }
25
- }, {
26
- timestamps: true
27
- });
28
-
29
- dailyWaterMeterHistorySchema.index({ meterId: 1, date: 1 });
30
-
31
- const DailyWaterMeterHistory = mongoose.model('DailyWaterMeterHistory', dailyWaterMeterHistorySchema);
32
-
1
+ const mongoose = require('mongoose');
2
+
3
+ const dailyWaterMeterHistorySchema = new mongoose.Schema({
4
+ meterId: {
5
+ type: mongoose.Schema.Types.ObjectId,
6
+ ref: 'WaterMeter',
7
+ required: true,
8
+ index: true
9
+ },
10
+ date: {
11
+ type: Date,
12
+ required: true,
13
+ index: true
14
+ },
15
+ reading: {
16
+ type: Number,
17
+ required: true,
18
+ min: 0
19
+ },
20
+ status: {
21
+ type: String,
22
+ enum: ['opened', 'closed', 'maintenance', 'faulty'],
23
+ default: 'opened',
24
+ }
25
+ }, {
26
+ timestamps: true
27
+ });
28
+
29
+ dailyWaterMeterHistorySchema.index({ meterId: 1, date: 1 });
30
+
31
+ const DailyWaterMeterHistory = mongoose.model('DailyWaterMeterHistory', dailyWaterMeterHistorySchema);
32
+
33
33
  module.exports = DailyWaterMeterHistory;
@@ -1,37 +1,37 @@
1
- const mongoose = require('mongoose');
2
-
3
- const highRiskMeterSchema = new mongoose.Schema({
4
- meterNumber: {
5
- type: String,
6
- required: true,
7
- unique: true,
8
- trim: true,
9
- index: true
10
- },
11
- concentratorSerialNumber: {
12
- type: String,
13
- required: true,
14
- trim: true
15
- },
16
- customerName: {
17
- type: String,
18
- required: true,
19
- trim: true
20
- },
21
- facilityName: {
22
- type: String,
23
- required: true,
24
- trim: true
25
- },
26
- unitName: {
27
- type: String,
28
- required: true,
29
- trim: true
30
- }
31
- }, {
32
- timestamps: true
33
- });
34
-
35
- const HighRiskMeter = mongoose.model('HighRiskMeter', highRiskMeterSchema);
36
-
1
+ const mongoose = require('mongoose');
2
+
3
+ const highRiskMeterSchema = new mongoose.Schema({
4
+ meterNumber: {
5
+ type: String,
6
+ required: true,
7
+ unique: true,
8
+ trim: true,
9
+ index: true
10
+ },
11
+ concentratorSerialNumber: {
12
+ type: String,
13
+ required: true,
14
+ trim: true
15
+ },
16
+ customerName: {
17
+ type: String,
18
+ required: true,
19
+ trim: true
20
+ },
21
+ facilityName: {
22
+ type: String,
23
+ required: true,
24
+ trim: true
25
+ },
26
+ unitName: {
27
+ type: String,
28
+ required: true,
29
+ trim: true
30
+ }
31
+ }, {
32
+ timestamps: true
33
+ });
34
+
35
+ const HighRiskMeter = mongoose.model('HighRiskMeter', highRiskMeterSchema);
36
+
37
37
  module.exports = HighRiskMeter;
@@ -1,35 +1,35 @@
1
- const mongoose = require('mongoose');
2
-
3
- const iotCardSchema = new mongoose.Schema({
4
- serialNumber: {
5
- type: String,
6
- required: true,
7
- unique: true,
8
- trim: true
9
- },
10
- provider: {
11
- type: String,
12
- required: true,
13
- trim: true
14
- },
15
- concentrator: {
16
- type: mongoose.Schema.Types.ObjectId,
17
- ref: 'Concentrator'
18
- },
19
- location: {
20
- type: String,
21
- trim: true
22
- },
23
- status: {
24
- type: String,
25
- required: true,
26
- enum: ['active', 'inactive', 'suspended'],
27
- default: 'inactive'
28
- }
29
- }, {
30
- timestamps: true
31
- });
32
-
33
- const MeterIotCard = mongoose.model('MeterIotCard', iotCardSchema);
34
-
1
+ const mongoose = require('mongoose');
2
+
3
+ const iotCardSchema = new mongoose.Schema({
4
+ serialNumber: {
5
+ type: String,
6
+ required: true,
7
+ unique: true,
8
+ trim: true
9
+ },
10
+ provider: {
11
+ type: String,
12
+ required: true,
13
+ trim: true
14
+ },
15
+ concentrator: {
16
+ type: mongoose.Schema.Types.ObjectId,
17
+ ref: 'Concentrator'
18
+ },
19
+ location: {
20
+ type: String,
21
+ trim: true
22
+ },
23
+ status: {
24
+ type: String,
25
+ required: true,
26
+ enum: ['active', 'inactive', 'suspended'],
27
+ default: 'inactive'
28
+ }
29
+ }, {
30
+ timestamps: true
31
+ });
32
+
33
+ const MeterIotCard = mongoose.model('MeterIotCard', iotCardSchema);
34
+
35
35
  module.exports = MeterIotCard;
@@ -1,135 +1,135 @@
1
- const mongoose = require('mongoose');
2
-
3
- const waterMeterLoanDeductionSchema = new mongoose.Schema({
4
- customerId: {
5
- type: mongoose.Schema.Types.ObjectId,
6
- ref: 'Customer',
7
- required: true,
8
- index: true
9
- },
10
- accountId: {
11
- type: mongoose.Schema.Types.ObjectId,
12
- ref: 'WaterMeterAccount',
13
- required: true,
14
- index: true
15
- },
16
- meterId: {
17
- type: mongoose.Schema.Types.ObjectId,
18
- ref: 'WaterMeter',
19
- required: true,
20
- index: true
21
- },
22
- amount: {
23
- type: Number,
24
- required: true,
25
- min: 0
26
- },
27
- yearMonth: {
28
- type: String,
29
- required: true,
30
- index: true,
31
- // Format: YYYY-MM (e.g., "2026-01")
32
- validate: {
33
- validator: function(v) {
34
- return /^\d{4}-(0[1-9]|1[0-2])$/.test(v);
35
- },
36
- message: "yearMonth must be in YYYY-MM format"
37
- }
38
- },
39
- deductionDate: {
40
- type: Date,
41
- required: true,
42
- default: Date.now
43
- },
44
- status: {
45
- type: String,
46
- enum: ['pending', 'completed', 'insufficient_balance'],
47
- required: true,
48
- default: 'pending',
49
- index: true
50
- },
51
- debitRecordId: {
52
- type: mongoose.Schema.Types.ObjectId,
53
- ref: 'WaterPrepaidDebit',
54
- // Will be populated when deduction is completed
55
- },
56
- balanceAtAttempt: {
57
- type: Number,
58
- // Store balance when deduction was attempted
59
- },
60
- attempts: {
61
- type: Number,
62
- default: 0,
63
- min: 0
64
- },
65
- lastAttemptDate: {
66
- type: Date
67
- },
68
- completedDate: {
69
- type: Date
70
- },
71
- notes: {
72
- type: String,
73
- trim: true
74
- }
75
- }, {
76
- timestamps: true
77
- });
78
-
79
- // Compound index to ensure one deduction per customer per month
80
- waterMeterLoanDeductionSchema.index(
81
- { customerId: 1, yearMonth: 1 },
82
- { unique: true }
83
- );
84
-
85
- // Index for finding pending deductions
86
- waterMeterLoanDeductionSchema.index({ status: 1, yearMonth: 1 });
87
-
88
- // Index for finding deductions by account
89
- waterMeterLoanDeductionSchema.index({ accountId: 1, yearMonth: 1 });
90
-
91
- // Static method to check if deduction exists for a customer in a given month
92
- waterMeterLoanDeductionSchema.statics.deductionExists = async function(customerId, yearMonth) {
93
- const count = await this.countDocuments({ customerId, yearMonth });
94
- return count > 0;
95
- };
96
-
97
- // Static method to get pending deductions
98
- waterMeterLoanDeductionSchema.statics.getPendingDeductions = async function() {
99
- return this.find({ status: 'pending' })
100
- .populate('accountId')
101
- .populate('meterId')
102
- .sort({ createdAt: 1 });
103
- };
104
-
105
- // Static method to get pending deductions for a specific month
106
- waterMeterLoanDeductionSchema.statics.getPendingDeductionsForMonth = async function(yearMonth) {
107
- return this.find({
108
- status: 'pending',
109
- yearMonth: yearMonth
110
- })
111
- .populate('accountId')
112
- .populate('meterId')
113
- .sort({ createdAt: 1 });
114
- };
115
-
116
- // Instance method to mark as completed
117
- waterMeterLoanDeductionSchema.methods.markCompleted = async function(debitRecordId) {
118
- this.status = 'completed';
119
- this.debitRecordId = debitRecordId;
120
- this.completedDate = new Date();
121
- return this.save();
122
- };
123
-
124
- // Instance method to mark as insufficient balance
125
- waterMeterLoanDeductionSchema.methods.markInsufficientBalance = async function(balance) {
126
- this.status = 'insufficient_balance';
127
- this.balanceAtAttempt = balance;
128
- this.attempts += 1;
129
- this.lastAttemptDate = new Date();
130
- return this.save();
131
- };
132
-
133
- const WaterMeterLoanDeduction = mongoose.model('WaterMeterLoanDeduction', waterMeterLoanDeductionSchema);
134
-
1
+ const mongoose = require('mongoose');
2
+
3
+ const waterMeterLoanDeductionSchema = new mongoose.Schema({
4
+ customerId: {
5
+ type: mongoose.Schema.Types.ObjectId,
6
+ ref: 'Customer',
7
+ required: true,
8
+ index: true
9
+ },
10
+ accountId: {
11
+ type: mongoose.Schema.Types.ObjectId,
12
+ ref: 'WaterMeterAccount',
13
+ required: true,
14
+ index: true
15
+ },
16
+ meterId: {
17
+ type: mongoose.Schema.Types.ObjectId,
18
+ ref: 'WaterMeter',
19
+ required: true,
20
+ index: true
21
+ },
22
+ amount: {
23
+ type: Number,
24
+ required: true,
25
+ min: 0
26
+ },
27
+ yearMonth: {
28
+ type: String,
29
+ required: true,
30
+ index: true,
31
+ // Format: YYYY-MM (e.g., "2026-01")
32
+ validate: {
33
+ validator: function(v) {
34
+ return /^\d{4}-(0[1-9]|1[0-2])$/.test(v);
35
+ },
36
+ message: "yearMonth must be in YYYY-MM format"
37
+ }
38
+ },
39
+ deductionDate: {
40
+ type: Date,
41
+ required: true,
42
+ default: Date.now
43
+ },
44
+ status: {
45
+ type: String,
46
+ enum: ['pending', 'completed', 'insufficient_balance'],
47
+ required: true,
48
+ default: 'pending',
49
+ index: true
50
+ },
51
+ debitRecordId: {
52
+ type: mongoose.Schema.Types.ObjectId,
53
+ ref: 'WaterPrepaidDebit',
54
+ // Will be populated when deduction is completed
55
+ },
56
+ balanceAtAttempt: {
57
+ type: Number,
58
+ // Store balance when deduction was attempted
59
+ },
60
+ attempts: {
61
+ type: Number,
62
+ default: 0,
63
+ min: 0
64
+ },
65
+ lastAttemptDate: {
66
+ type: Date
67
+ },
68
+ completedDate: {
69
+ type: Date
70
+ },
71
+ notes: {
72
+ type: String,
73
+ trim: true
74
+ }
75
+ }, {
76
+ timestamps: true
77
+ });
78
+
79
+ // Compound index to ensure one deduction per customer per month
80
+ waterMeterLoanDeductionSchema.index(
81
+ { customerId: 1, yearMonth: 1 },
82
+ { unique: true }
83
+ );
84
+
85
+ // Index for finding pending deductions
86
+ waterMeterLoanDeductionSchema.index({ status: 1, yearMonth: 1 });
87
+
88
+ // Index for finding deductions by account
89
+ waterMeterLoanDeductionSchema.index({ accountId: 1, yearMonth: 1 });
90
+
91
+ // Static method to check if deduction exists for a customer in a given month
92
+ waterMeterLoanDeductionSchema.statics.deductionExists = async function(customerId, yearMonth) {
93
+ const count = await this.countDocuments({ customerId, yearMonth });
94
+ return count > 0;
95
+ };
96
+
97
+ // Static method to get pending deductions
98
+ waterMeterLoanDeductionSchema.statics.getPendingDeductions = async function() {
99
+ return this.find({ status: 'pending' })
100
+ .populate('accountId')
101
+ .populate('meterId')
102
+ .sort({ createdAt: 1 });
103
+ };
104
+
105
+ // Static method to get pending deductions for a specific month
106
+ waterMeterLoanDeductionSchema.statics.getPendingDeductionsForMonth = async function(yearMonth) {
107
+ return this.find({
108
+ status: 'pending',
109
+ yearMonth: yearMonth
110
+ })
111
+ .populate('accountId')
112
+ .populate('meterId')
113
+ .sort({ createdAt: 1 });
114
+ };
115
+
116
+ // Instance method to mark as completed
117
+ waterMeterLoanDeductionSchema.methods.markCompleted = async function(debitRecordId) {
118
+ this.status = 'completed';
119
+ this.debitRecordId = debitRecordId;
120
+ this.completedDate = new Date();
121
+ return this.save();
122
+ };
123
+
124
+ // Instance method to mark as insufficient balance
125
+ waterMeterLoanDeductionSchema.methods.markInsufficientBalance = async function(balance) {
126
+ this.status = 'insufficient_balance';
127
+ this.balanceAtAttempt = balance;
128
+ this.attempts += 1;
129
+ this.lastAttemptDate = new Date();
130
+ return this.save();
131
+ };
132
+
133
+ const WaterMeterLoanDeduction = mongoose.model('WaterMeterLoanDeduction', waterMeterLoanDeductionSchema);
134
+
135
135
  module.exports = WaterMeterLoanDeduction;