All files / src/domains/hr/payroll/runs/schemas payroll-calculation-component.schema.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document, Schema as MongooseSchema } from 'mongoose';
 
@Schema({ collection: 'payroll_calculation_components', timestamps: true })
export class PayrollCalculationComponent extends Document {
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  tenantId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  resultId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  runId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  employeeId!: MongooseSchema.Types.ObjectId;
  @Prop({ type: MongooseSchema.Types.ObjectId, required: true })
  componentId!: MongooseSchema.Types.ObjectId;
  @Prop({ required: true }) componentCode!: string;
  @Prop({ required: true }) componentName!: string;
  @Prop({
    required: true,
    enum: [
      'earning',
      'deduction',
      'employer_contribution',
      'reimbursement',
      'tax',
      'statutory_deduction',
      'loan_recovery',
      'advance_recovery',
      'bonus',
      'incentive',
      'leave_encashment',
      'overtime',
    ],
  })
  category!: string;
  @Prop({ default: 0 }) amount!: number;
  @Prop({ default: 0 }) ytdAmount!: number;
  @Prop() formula?: string;
  @Prop({ type: MongooseSchema.Types.Mixed }) calculationTrace?: Record<
    string,
    unknown
  >;
}
export const PayrollCalculationComponentSchema = SchemaFactory.createForClass(
  PayrollCalculationComponent,
);
PayrollCalculationComponentSchema.index({ tenantId: 1, resultId: 1 });
PayrollCalculationComponentSchema.index({
  tenantId: 1,
  runId: 1,
  employeeId: 1,
});