tango-api-schema 2.6.25 → 2.6.27

package/index.js

@@ -36,6 +36,7 @@ import paymentAccountModel from "./schema/paymentAccount.model.js";
 import externalParameterModel from "./schema/externalParameter.model.js";
 import transactionModel from "./schema/transaction.model.js";
 import estimateModel from "./schema/estimate.model.js";
+import paymentReminderModel from "./schema/paymentReminder.model.js";
 import bankTransactionModel from "./schema/bankTransaction.model.js";
 import dataMismatchDraftModel from "./schema/dataMismatchDraft.model.js";
 import traxAuditDataModel from "./schema/traxAuditData.model.js";
@@ -171,6 +172,7 @@ export default {
   externalParameterModel,
   transactionModel,
   estimateModel,
+  paymentReminderModel,
   bankTransactionModel,
   dataMismatchDraftModel,
   traxAuditDataModel,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tango-api-schema",
-  "version": "2.6.25",
+  "version": "2.6.27",
   "description": "tangoEye model schema",
   "main": "index.js",
   "type": "module",

package/schema/billing.model.js

@@ -1,130 +1,130 @@
-import mongoose from 'mongoose';
- 
-const billingSchema = new mongoose.Schema(
-    {
-        clientId: {
-        type: String,
-        required: true,
-      },
-      groupName: {
-        type: String,
-        default:'Default Group'
-      },
-      groupTag: {
-        type: String,
-        enum: ['store','gst'],
-        default: 'store'
-      },
-      registeredCompanyName: {
-        type: String,
-      },
-      gst: {
-        type: String,
-      },
-      addressLineOne: {
-        type: String,
-      },
-      addressLineTwo: {
-        type: String,
-      },
-      city: {
-        type: String,
-      },
-      state: {
-        type: String,
-      },
-      country: {
-        type: String,
-      },
-      pinCode: {
-        type: String,
-      },
-      placeOfSupply: {
-        type: String,
-      },
-      po: {
-        type: String,
-      },
-      stores: {
-        type: Array,
-      },
-      proRata: {
-        type: String,
-        // 'prorate' = bill for actual working days.
-        // 'flat'    = bill for the full month regardless of working days.
-        // Note: legacy values 'before15' / 'after15' were migrated out via
-        // scripts/migrate-billing-prorata-pricing.js. Don't reintroduce them.
-        enum: ['prorate','flat'],
-        default: 'prorate'
-      },
-      paymentCategory: {
-        type: String,
-        enum: ['pre','post'],
-        default: 'post'
-      },
-      currency: {
-        type: String,
-        enum: ['dollar','inr','singaporedollar','euro'],
-      },
-      // Drives invoice-generation tax behavior. 'domestic' runs the
-      // existing GST/IGST/CGST/SGST logic. 'international' suppresses
-      // tax lines entirely (the tax array is left empty so totalAmount
-      // equals subtotal). Defaults to 'domestic' so existing records
-      // keep their current behavior on read.
-      taxCalculationType: {
-        type: String,
-        enum: ['domestic','international'],
-        default: 'domestic'
-      },
-      isInstallationOneTime: {
-        type: Boolean,
-        default: false
-      },
-      installationFee: {
-        type: Number,
-      },
-      paymentCycle: {
-        type: String,
-        enum: ['monthly','quarter', 'halfYearly', 'yearly'],
-        default: 'monthly'
-      },
-      paymentTerm: {
-        type: Number,
-        enum: [30, 45, 60, 90],
-        default: 30
-      },
-      generateInvoiceTo: {
-        type: Array,
-      },
-      attachAnnexure: {
-        type: Boolean,
-        default:false
-      },
-      isPrimary: {
-        type: Boolean
-      },
-      advanceInvoice: {
-        type: Boolean,
-        default: false
-      },
-      products: [
-        {
-          productName: {
-            type: String,
-          },
-          billingMethod: {
-            type: String,
-            enum: ['eachStore', 'overallStore'],
-            default: 'overallStore'
-          }
-        }
-      ]
-    },
-    {
-      strict: true,
-      versionKey: false,
-      timestamps: true,
-    },
-);
- 
+import mongoose from 'mongoose';
+ 
+const billingSchema = new mongoose.Schema(
+    {
+        clientId: {
+        type: String,
+        required: true,
+      },
+      groupName: {
+        type: String,
+        default:'Default Group'
+      },
+      groupTag: {
+        type: String,
+        enum: ['store','gst'],
+        default: 'store'
+      },
+      registeredCompanyName: {
+        type: String,
+      },
+      gst: {
+        type: String,
+      },
+      addressLineOne: {
+        type: String,
+      },
+      addressLineTwo: {
+        type: String,
+      },
+      city: {
+        type: String,
+      },
+      state: {
+        type: String,
+      },
+      country: {
+        type: String,
+      },
+      pinCode: {
+        type: String,
+      },
+      placeOfSupply: {
+        type: String,
+      },
+      po: {
+        type: String,
+      },
+      stores: {
+        type: Array,
+      },
+      proRata: {
+        type: String,
+        // 'prorate' = bill for actual working days.
+        // 'flat'    = bill for the full month regardless of working days.
+        // Note: legacy values 'before15' / 'after15' were migrated out via
+        // scripts/migrate-billing-prorata-pricing.js. Don't reintroduce them.
+        enum: ['prorate','flat'],
+        default: 'prorate'
+      },
+      paymentCategory: {
+        type: String,
+        enum: ['pre','post'],
+        default: 'post'
+      },
+      currency: {
+        type: String,
+        enum: ['dollar','inr','singaporedollar','euro','aed'],
+      },
+      // Drives invoice-generation tax behavior. 'domestic' runs the
+      // existing GST/IGST/CGST/SGST logic. 'international' suppresses
+      // tax lines entirely (the tax array is left empty so totalAmount
+      // equals subtotal). Defaults to 'domestic' so existing records
+      // keep their current behavior on read.
+      taxCalculationType: {
+        type: String,
+        enum: ['domestic','international'],
+        default: 'domestic'
+      },
+      isInstallationOneTime: {
+        type: Boolean,
+        default: false
+      },
+      installationFee: {
+        type: Number,
+      },
+      paymentCycle: {
+        type: String,
+        enum: ['monthly','quarter', 'halfYearly', 'yearly'],
+        default: 'monthly'
+      },
+      paymentTerm: {
+        type: Number,
+        enum: [30, 45, 60, 90],
+        default: 30
+      },
+      generateInvoiceTo: {
+        type: Array,
+      },
+      attachAnnexure: {
+        type: Boolean,
+        default:false
+      },
+      isPrimary: {
+        type: Boolean
+      },
+      advanceInvoice: {
+        type: Boolean,
+        default: false
+      },
+      products: [
+        {
+          productName: {
+            type: String,
+          },
+          billingMethod: {
+            type: String,
+            enum: ['eachStore', 'overallStore'],
+            default: 'overallStore'
+          }
+        }
+      ]
+    },
+    {
+      strict: true,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+ 
 export default mongoose.model( 'billing', billingSchema);

package/schema/estimate.model.js

@@ -53,7 +53,7 @@ const estimateSchema = new mongoose.Schema(
         },
         currency: {
             type: String,
-            enum: [ 'dollar', 'inr', 'singaporedollar', 'euro' ],
+            enum: [ 'dollar', 'inr', 'singaporedollar', 'euro', 'aed' ],
             default: 'inr',
         },
         status: {

package/schema/paymentAccount.model.js

@@ -1,61 +1,61 @@
-import mongoose from 'mongoose';
- 
-const paymentAccountSchema = new mongoose.Schema(
-  {
-      clientId: {
-      type: String,
-      required: true,
-      unique: true,
-    },
-    customerId:{
-      type: String,
-      required: true,
-      unique: true,
-    },
-    virtualAccId:{
-      type: String,
-      required: true,
-      unique: true,
-    },
-    bankAccId:{
-      type: String,
-      required: true,
-      unique: true,
-    },
-    accountNumber:{
-      type: String,
-      required: true,
-      unique: true,
-    },
-    paymentType:{
-        type: String,
-      },
-    status:{
-      type: String,
-    },
-    ifsc: {
-      type: String,
-    },
-    swiftCode:{
-      type: String,
-    },
-    branch:{
-      type: String,
-    },
-    credit:{
-      type: Number,
-      default:0
-    },
-    currency: {
-      type: String,
-      enum: [ 'dollar', 'inr', 'singaporedollar', 'euro' ],
-    },
-  },
-  {
-    strict: true,
-    versionKey: false,
-    timestamps: true,
-  },
-);
- 
+import mongoose from 'mongoose';
+ 
+const paymentAccountSchema = new mongoose.Schema(
+  {
+      clientId: {
+      type: String,
+      required: true,
+      unique: true,
+    },
+    customerId:{
+      type: String,
+      required: true,
+      unique: true,
+    },
+    virtualAccId:{
+      type: String,
+      required: true,
+      unique: true,
+    },
+    bankAccId:{
+      type: String,
+      required: true,
+      unique: true,
+    },
+    accountNumber:{
+      type: String,
+      required: true,
+      unique: true,
+    },
+    paymentType:{
+        type: String,
+      },
+    status:{
+      type: String,
+    },
+    ifsc: {
+      type: String,
+    },
+    swiftCode:{
+      type: String,
+    },
+    branch:{
+      type: String,
+    },
+    credit:{
+      type: Number,
+      default:0
+    },
+    currency: {
+      type: String,
+      enum: [ 'dollar', 'inr', 'singaporedollar', 'euro', 'aed' ],
+    },
+  },
+  {
+    strict: true,
+    versionKey: false,
+    timestamps: true,
+  },
+);
+ 
   export default mongoose.model( 'paymentAccount', paymentAccountSchema);

package/schema/paymentReminder.model.js

@@ -0,0 +1,47 @@
+import mongoose from 'mongoose';
+
+// Payment reminder configuration per client (brand). One document per
+// clientId, driving which reminder emails go out and to whom. Stored in its
+// own `paymentreminders` collection.
+const paymentReminderSchema = new mongoose.Schema(
+    {
+        clientId: {
+            type: String,
+            index: true,
+        },
+        // Recipients for all reminder emails on this brand.
+        reminderEmails: {
+            type: [ String ],
+            default: [],
+        },
+        // Predefined reminder templates the team can toggle. preDue carries a
+        // configurable lead time; the rest fire on fixed rules.
+        templates: {
+            preDue: {
+                enabled: { type: Boolean, default: true },
+                daysBefore: { type: Number, default: 3, min: 1, max: 365 },
+            },
+            onDue: {
+                enabled: { type: Boolean, default: true },
+            },
+            onHold: {
+                enabled: { type: Boolean, default: true },
+            },
+            suspend: {
+                enabled: { type: Boolean, default: true },
+            },
+            deactivated: {
+                enabled: { type: Boolean, default: false },
+            },
+        },
+        updatedBy: {
+            type: String,
+        },
+    }, {
+    strict: true,
+    versionKey: false,
+    timestamps: true,
+}
+);
+
+export default mongoose.model( 'paymentreminder', paymentReminderSchema );

package/schema/transaction.model.js

@@ -1,55 +1,55 @@
-import mongoose from 'mongoose';
- 
-const transactionSchema = new mongoose.Schema(
-    {
-        clientId: {
-            type: String
-        },
-        orderId: {
-            type: String
-        },
-        paymentId: {
-            type: String
-        },
-        debtType: {
-            type: String,
-            enum: [ 'wallet', 'razor' ],
-        },
-        billingDate: {
-            type: Date
-        },
-        invoice: {
-            type: String
-        },
-        groupName: {
-            type: String
-        },
-        groupId: {
-            type: mongoose.Types.ObjectId
-        },
-        amount: {
-            type: Number
-        },
-        currency: {
-            type: String,
-            enum: [ 'dollar', 'inr', 'singaporedollar', 'euro' ],
-        },
-        transactionType: {
-            type: String,
-            enum: [ 'credit', 'debt' ],
-        },
-        balanceCredit: {
-            type: Number
-        },
-        balanceCreditCurrency: {
-            type: String,
-            enum: [ 'dollar', 'inr', 'singaporedollar', 'euro' ],
-        },
-    }, {
-    strict: true,
-    versionKey: false,
-    timestamps: true,
-}
-)
- 
+import mongoose from 'mongoose';
+ 
+const transactionSchema = new mongoose.Schema(
+    {
+        clientId: {
+            type: String
+        },
+        orderId: {
+            type: String
+        },
+        paymentId: {
+            type: String
+        },
+        debtType: {
+            type: String,
+            enum: [ 'wallet', 'razor' ],
+        },
+        billingDate: {
+            type: Date
+        },
+        invoice: {
+            type: String
+        },
+        groupName: {
+            type: String
+        },
+        groupId: {
+            type: mongoose.Types.ObjectId
+        },
+        amount: {
+            type: Number
+        },
+        currency: {
+            type: String,
+            enum: [ 'dollar', 'inr', 'singaporedollar', 'euro', 'aed' ],
+        },
+        transactionType: {
+            type: String,
+            enum: [ 'credit', 'debt' ],
+        },
+        balanceCredit: {
+            type: Number
+        },
+        balanceCreditCurrency: {
+            type: String,
+            enum: [ 'dollar', 'inr', 'singaporedollar', 'euro', 'aed' ],
+        },
+    }, {
+    strict: true,
+    versionKey: false,
+    timestamps: true,
+}
+)
+ 
 export default mongoose.model('transaction', transactionSchema);