refactor(nestjs): bank transactions matching

packages/server/src/modules/BankingTransactions/dtos/CreateBankTransaction.dto.ts

@@ -8,67 +8,145 @@ import {
   IsOptional,
   IsString,
 } from 'class-validator';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 
 export class CreateBankTransactionDto {
+  @ApiProperty({
+    description: 'The date of the bank transaction',
+    type: Date,
+    example: '2023-01-01T00:00:00.000Z',
+  })
   @IsDateString()
   @IsNotEmpty()
   date: Date;
 
+  @ApiPropertyOptional({
+    description: 'Optional transaction number or reference',
+    type: String,
+    example: 'TRX-001',
+  })
   @IsString()
   @IsOptional()
   transactionNumber?: string;
 
+  @ApiPropertyOptional({
+    description: 'Optional external reference number',
+    type: String,
+    example: 'REF-001',
+  })
   @IsString()
   @IsOptional()
   referenceNo?: string;
 
+  @ApiProperty({
+    description: 'Type of bank transaction (e.g., deposit, withdrawal)',
+    type: String,
+    example: 'deposit',
+  })
   @IsNotEmpty()
   @IsString()
   transactionType: string;
 
+  @ApiProperty({
+    description: 'Description of the bank transaction',
+    type: String,
+    example: 'Monthly rent payment',
+  })
   @IsString()
   description: string;
 
+  @ApiProperty({
+    description: 'Transaction amount',
+    type: Number,
+    example: 1000.5,
+  })
   @IsNotEmpty()
   @ToNumber()
   @IsNumber()
   amount: number;
 
+  @ApiProperty({
+    description: 'Exchange rate for currency conversion',
+    type: Number,
+    default: 1,
+    example: 1.15,
+  })
   @ToNumber()
   @IsNumber()
   exchangeRate: number = 1;
 
+  @ApiPropertyOptional({
+    description: 'Currency code for the transaction',
+    type: String,
+    example: 'USD',
+  })
   @IsString()
   @IsOptional()
   currencyCode: string;
 
+  @ApiProperty({
+    description: 'ID of the credit account associated with this transaction',
+    type: Number,
+    example: 1001,
+  })
   @IsNotEmpty()
   @ToNumber()
-  @IsInt()  
+  @IsInt()
   creditAccountId: number;
 
+  @ApiProperty({
+    description: 'ID of the cashflow account associated with this transaction',
+    type: Number,
+    example: 2001,
+  })
   @IsNotEmpty()
   @ToNumber()
-  @IsInt()  
+  @IsInt()
   cashflowAccountId: number;
 
+  @ApiProperty({
+    description: 'Whether the transaction should be published',
+    type: Boolean,
+    default: true,
+  })
   @IsBoolean()
   @IsOptional()
   publish: boolean = true;
 
+  @ApiPropertyOptional({
+    description: 'ID of the branch where the transaction occurred',
+    type: Number,
+    example: 101,
+  })
   @IsOptional()
   @ToNumber()
   @IsInt()
   branchId?: number;
 
+  @ApiPropertyOptional({
+    description: 'Plaid transaction ID if imported from Plaid',
+    type: String,
+    example: 'plaid_trx_12345',
+  })
   @IsOptional()
   @IsString()
   plaidTransactionId?: string;
 
+  @ApiPropertyOptional({
+    description: 'Plaid account ID if imported from Plaid',
+    type: String,
+    example: 'plaid_acc_67890',
+  })
   @IsOptional()
   @IsString()
   plaidAccountId?: string;
 
+  @ApiPropertyOptional({
+    description:
+      'ID of the uncategorized transaction if this is categorizing an existing transaction',
+    type: Number,
+    example: 5001,
+  })
   @IsOptional()
   @IsInt()
   uncategorizedTransactionId?: number;