All files / src/domains/procurement/vendor-bills/schemas vendor-bill.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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document, Types } from 'mongoose';
 
@Schema({ _id: false })
export class VendorBillLine {
  @Prop({ required: true })
  description: string;
 
  @Prop({ required: true })
  quantity: number;
 
  @Prop({ required: true })
  unitPrice: number;
 
  @Prop({ required: true })
  total: number;
}
 
@Schema({ _id: false })
export class BillMatch {
  @Prop({ default: null })
  purchaseOrderId: string;
 
  @Prop({ default: null })
  goodsReceiptId: string;
 
  @Prop({ default: null })
  serviceReceiptId: string;
 
  @Prop({ required: true, default: 'matched', enum: ['matched', 'variance_held', 'unmatched'] })
  status: string;
 
  @Prop({ default: null })
  varianceReason: string;
}
 
@Schema({ timestamps: true })
export class VendorBill extends Document {
  @Prop({ required: true, index: true })
  tenantId: string;
 
  @Prop({ required: true, index: true })
  billNumber: string;
 
  @Prop({ required: true, index: true })
  vendorId: string;
 
  @Prop({ required: true })
  vendorInvoiceNumber: string; // unique for the vendor
 
  @Prop({ type: [VendorBillLine], default: [] })
  lines: VendorBillLine[];
 
  @Prop({ required: true })
  subtotal: number;
 
  @Prop({ required: true })
  tax: number;
 
  @Prop({ required: true })
  totalAmount: number;
 
  @Prop({ required: true, default: 'USD' })
  currency: string;
 
  @Prop({
    required: true,
    default: 'draft',
    enum: ['draft', 'approval_pending', 'approved', 'paid', 'void'],
  })
  status: string;
 
  @Prop({ type: BillMatch, default: {} })
  match: BillMatch;
 
  @Prop({ default: false })
  held: boolean;
 
  @Prop({ default: null })
  holdReason: string;
}
 
export const VendorBillSchema = SchemaFactory.createForClass(VendorBill);
VendorBillSchema.index({ tenantId: 1, billNumber: 1 }, { unique: true });
VendorBillSchema.index({ tenantId: 1, vendorId: 1, vendorInvoiceNumber: 1 }, { unique: true });
VendorBillSchema.index({ tenantId: 1, status: 1 });