tango-api-schema 2.6.48 → 2.6.49

package/schema/invoice.model.js

@@ -1,157 +1,157 @@
-import mongoose from 'mongoose';
- 
-const invoiceSchema = new mongoose.Schema(
-    {
-        clientId: {
-            type:String
-        },
-        invoice: {
-            type:String,
-        },
-        invoiceIndex: {
-            type:String,
-        },
-        stores: {
-            type:Number
-        },
-        // For TINV (advance quarterly/half-yearly/yearly) invoices: the actual
-        // list of stores covered, captured at generation time, with each store's
-        // products and their working days.
-        storeDetails: [
-            {
-                storeId: { type: String },
-                storeName: { type: String },
-                products: [
-                    {
-                        productName: { type: String },
-                        workingdays: { type: Number },
-                    },
-                ],
-            },
-        ],
-        companyName:{
-            type:String,
-        },
-        monthOfbilling:{
-            type:String,  
-        },
-        companyAddress:{
-            type:String,   
-        },
-        PlaceOfSupply: {
-            type:String,   
-        },
-        GSTNumber: {
-            type:String,   
-        },
-        products:{
-            type:Array
-        },
-        tax:{
-            type:Array
-        },
-        amount:{
-            type:Number
-        },
-        totalAmount:{
-            type:Number
-        },
-        paymentMethod:{
-            type:String 
-        },
-        status:{
-            type:String,
-            default:'pendingCsm',
-            enum:['pendingCsm','pendingFinance','pendingApproval','approved']
-        },
-        receivedAmount:{
-            type:Number
-        },
-        billingDate:{
-            type:Date
-        },
-        dueDate:{
-            type:Date
-        },
-        paymentTerm:{
-            type:Number
-        },
-        paidDate:{
-            type:Date
-        }, 
-        paymentType: {
-            type:String,
-            enum: ['online','banktransfer']
-        },
-        paymentReferenceId: {
-            type:String
-        },
-        fromDate:{
-            type:Date
-        },
-        toDate:{
-            type:Date
-        },
-        currency: {
-            type:String
-        },
-        orderId: {
-            type:String
-        },
-        groupName: {
-            type:String
-        },
-        groupId: {
-            type:String
-        },
-        // Purchase order this invoice is mapped to (reduces the PO's remaining
-        // balance). Empty when the invoice isn't tied to a PO.
-        purchaseOrderNumber: {
-            type:String
-        },
-        discountAmount: {
-            type:Number
-        },
-        discountPercentage: {
-            type:Number
-        },
-        paymentStatus:{
-            type:String,
-            default:'unpaid',
-            // 'partial' = paidAmount > 0 && paidAmount < totalAmount.
-            // Server derives this in recordPayment so the value stays in sync.
-            enum: ['paid','unpaid','partial']
-        },
-        // Running total of all payments recorded against this invoice. Sum of
-        // paymentHistory[].amount; persisted for easy querying / display so
-        // the frontend doesn't need to re-sum every render.
-        paidAmount:{
-            type:Number,
-            default:0
-        },
-        // Append-only audit trail. Each entry is one payment received from
-        // the client. recordedAt is server-set; the rest comes from the form.
-        paymentHistory:[{
-            amount:{type:Number, required:true},
-            date:{type:Date, required:true},
-            method:{type:String, enum:['banktransfer','upi','cheque','card','cash','other']},
-            reference:{type:String},
-            notes:{type:String},
-            recordedBy:{type:String},
-            recordedAt:{type:Date, default:Date.now}
-        }],
-        advanceInvoice:{
-            type:Boolean,
-            default:false
-        },
-        tempIndex:{ type:Number },
-        advancePeriod:{ type:String },
-        advanceMonths:{ type:Number },
-    },{
-        strict: true,
-        versionKey: false,
-        timestamps: true,
-    }
-)
- 
+import mongoose from 'mongoose';
+ 
+const invoiceSchema = new mongoose.Schema(
+    {
+        clientId: {
+            type:String
+        },
+        invoice: {
+            type:String,
+        },
+        invoiceIndex: {
+            type:String,
+        },
+        stores: {
+            type:Number
+        },
+        // For TINV (advance quarterly/half-yearly/yearly) invoices: the actual
+        // list of stores covered, captured at generation time, with each store's
+        // products and their working days.
+        storeDetails: [
+            {
+                storeId: { type: String },
+                storeName: { type: String },
+                products: [
+                    {
+                        productName: { type: String },
+                        workingdays: { type: Number },
+                    },
+                ],
+            },
+        ],
+        companyName:{
+            type:String,
+        },
+        monthOfbilling:{
+            type:String,  
+        },
+        companyAddress:{
+            type:String,   
+        },
+        PlaceOfSupply: {
+            type:String,   
+        },
+        GSTNumber: {
+            type:String,   
+        },
+        products:{
+            type:Array
+        },
+        tax:{
+            type:Array
+        },
+        amount:{
+            type:Number
+        },
+        totalAmount:{
+            type:Number
+        },
+        paymentMethod:{
+            type:String 
+        },
+        status:{
+            type:String,
+            default:'pendingCsm',
+            enum:['pendingCsm','pendingFinance','pendingApproval','approved']
+        },
+        receivedAmount:{
+            type:Number
+        },
+        billingDate:{
+            type:Date
+        },
+        dueDate:{
+            type:Date
+        },
+        paymentTerm:{
+            type:Number
+        },
+        paidDate:{
+            type:Date
+        }, 
+        paymentType: {
+            type:String,
+            enum: ['online','banktransfer']
+        },
+        paymentReferenceId: {
+            type:String
+        },
+        fromDate:{
+            type:Date
+        },
+        toDate:{
+            type:Date
+        },
+        currency: {
+            type:String
+        },
+        orderId: {
+            type:String
+        },
+        groupName: {
+            type:String
+        },
+        groupId: {
+            type:String
+        },
+        // Purchase order this invoice is mapped to (reduces the PO's remaining
+        // balance). Empty when the invoice isn't tied to a PO.
+        purchaseOrderNumber: {
+            type:String
+        },
+        discountAmount: {
+            type:Number
+        },
+        discountPercentage: {
+            type:Number
+        },
+        paymentStatus:{
+            type:String,
+            default:'unpaid',
+            // 'partial' = paidAmount > 0 && paidAmount < totalAmount.
+            // Server derives this in recordPayment so the value stays in sync.
+            enum: ['paid','unpaid','partial']
+        },
+        // Running total of all payments recorded against this invoice. Sum of
+        // paymentHistory[].amount; persisted for easy querying / display so
+        // the frontend doesn't need to re-sum every render.
+        paidAmount:{
+            type:Number,
+            default:0
+        },
+        // Append-only audit trail. Each entry is one payment received from
+        // the client. recordedAt is server-set; the rest comes from the form.
+        paymentHistory:[{
+            amount:{type:Number, required:true},
+            date:{type:Date, required:true},
+            method:{type:String, enum:['banktransfer','upi','cheque','card','cash','other']},
+            reference:{type:String},
+            notes:{type:String},
+            recordedBy:{type:String},
+            recordedAt:{type:Date, default:Date.now}
+        }],
+        advanceInvoice:{
+            type:Boolean,
+            default:false
+        },
+        tempIndex:{ type:Number },
+        advancePeriod:{ type:String },
+        advanceMonths:{ type:Number },
+    },{
+        strict: true,
+        versionKey: false,
+        timestamps: true,
+    }
+)
+ 
 export default mongoose.model('invoice', invoiceSchema);

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', 'aed' ],
-    },
-  },
-  {
-    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

@@ -1,47 +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,
-}
-);
-
+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/purchaseOrder.model.js

@@ -1,60 +1,60 @@
-import mongoose from 'mongoose';
-
-// Purchase Orders per brand (clientId). totalAmount is the original PO value and
-// never changes; remainingAmount decreases as invoices are mapped to this PO.
-// `usage` keeps an audit trail of which invoices consumed how much.
-const purchaseOrderSchema = new mongoose.Schema(
-    {
-        clientId: {
-            type: String,
-            index: true,
-        },
-        companyName: {
-            type: String,
-        },
-        purchaseOrderNumber: {
-            type: String,
-        },
-        // Original PO value (immutable once created).
-        totalAmount: {
-            type: Number,
-            default: 0,
-        },
-        // Decreases as invoices are mapped; starts equal to totalAmount.
-        remainingAmount: {
-            type: Number,
-            default: 0,
-        },
-        date: {
-            type: Date,
-        },
-        // Stored S3 path (assets bucket) of the uploaded PO PDF, if any.
-        pdfPath: {
-            type: String,
-        },
-        // open -> partiallyUsed -> fullyUsed (derived from remainingAmount).
-        status: {
-            type: String,
-            enum: [ 'open', 'partiallyUsed', 'fullyUsed' ],
-            default: 'open',
-        },
-        // Invoices that consumed this PO. One entry per mapping.
-        usage: [
-            {
-                invoice: { type: String },
-                amount: { type: Number },
-                mappedAt: { type: Date },
-                mappedBy: { type: String },
-            },
-        ],
-        createdBy: {
-            type: String,
-        },
-    }, {
-        strict: true,
-        versionKey: false,
-        timestamps: true,
-    },
-);
-
+import mongoose from 'mongoose';
+
+// Purchase Orders per brand (clientId). totalAmount is the original PO value and
+// never changes; remainingAmount decreases as invoices are mapped to this PO.
+// `usage` keeps an audit trail of which invoices consumed how much.
+const purchaseOrderSchema = new mongoose.Schema(
+    {
+        clientId: {
+            type: String,
+            index: true,
+        },
+        companyName: {
+            type: String,
+        },
+        purchaseOrderNumber: {
+            type: String,
+        },
+        // Original PO value (immutable once created).
+        totalAmount: {
+            type: Number,
+            default: 0,
+        },
+        // Decreases as invoices are mapped; starts equal to totalAmount.
+        remainingAmount: {
+            type: Number,
+            default: 0,
+        },
+        date: {
+            type: Date,
+        },
+        // Stored S3 path (assets bucket) of the uploaded PO PDF, if any.
+        pdfPath: {
+            type: String,
+        },
+        // open -> partiallyUsed -> fullyUsed (derived from remainingAmount).
+        status: {
+            type: String,
+            enum: [ 'open', 'partiallyUsed', 'fullyUsed' ],
+            default: 'open',
+        },
+        // Invoices that consumed this PO. One entry per mapping.
+        usage: [
+            {
+                invoice: { type: String },
+                amount: { type: Number },
+                mappedAt: { type: Date },
+                mappedBy: { type: String },
+            },
+        ],
+        createdBy: {
+            type: String,
+        },
+    }, {
+        strict: true,
+        versionKey: false,
+        timestamps: true,
+    },
+);
+
 export default mongoose.model( 'purchaseorder', purchaseOrderSchema );