fix: refund credit notes

This commit is contained in:
Ahmed Bouhuolia
2026-01-01 17:03:27 +02:00
parent a91a7c612f
commit ead4fc9b97
6 changed files with 102 additions and 56 deletions

View File

@@ -1,5 +1,6 @@
import { ApiProperty } from '@nestjs/swagger';
import { IsNotEmpty, IsOptional, IsPositive, IsString } from 'class-validator';
import { ToNumber, IsOptional } from '@/common/decorators/Validators';
import { IsDateString, IsNotEmpty, IsPositive, IsString } from 'class-validator';
import { IsDate } from 'class-validator';
import { IsNumber } from 'class-validator';
@@ -10,8 +11,13 @@ export class CreditNoteRefundDto {
description: 'The id of the from account',
example: 1,
})
@ApiProperty({
description: 'The id of the from account',
example: 1,
})
fromAccountId: number;
@ToNumber()
@IsNumber()
@IsPositive()
@IsNotEmpty()
@@ -21,6 +27,7 @@ export class CreditNoteRefundDto {
})
amount: number;
@ToNumber()
@IsNumber()
@IsOptional()
@IsPositive()
@@ -30,23 +37,23 @@ export class CreditNoteRefundDto {
})
exchangeRate?: number;
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiProperty({
description: 'The reference number of the credit note refund',
example: '123456',
})
referenceNo: string;
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiProperty({
description: 'The description of the credit note refund',
example: 'Credit note refund',
})
description: string;
@IsDate()
@IsDateString()
@IsNotEmpty()
@ApiProperty({
description: 'The date of the credit note refund',
@@ -54,6 +61,7 @@ export class CreditNoteRefundDto {
})
date: Date;
@ToNumber()
@IsNumber()
@IsOptional()
@ApiProperty({

View File

@@ -2,19 +2,35 @@ import { Injectable } from '@nestjs/common';
import { DeleteRefundVendorCreditService } from './commands/DeleteRefundVendorCredit.service';
import { RefundVendorCredit } from './models/RefundVendorCredit';
import { CreateRefundVendorCredit } from './commands/CreateRefundVendorCredit.service';
import { IRefundVendorCreditDTO } from './types/VendorCreditRefund.types';
import { RefundVendorCreditDto } from './dtos/RefundVendorCredit.dto';
import { GetRefundVendorCreditsService } from './queries/GetRefundVendorCredits.service';
import { IRefundVendorCreditPOJO } from './types/VendorCreditRefund.types';
@Injectable()
export class VendorCreditsRefundApplication {
/**
* @param {CreateRefundVendorCredit} createRefundVendorCreditService
* @param {DeleteRefundVendorCreditService} deleteRefundVendorCreditService
* @param {GetRefundVendorCreditsService} getRefundVendorCreditsService
*/
constructor(
private readonly createRefundVendorCreditService: CreateRefundVendorCredit,
private readonly deleteRefundVendorCreditService: DeleteRefundVendorCreditService,
) {}
private readonly getRefundVendorCreditsService: GetRefundVendorCreditsService,
) { }
/**
* Retrieve the vendor credit refunds graph.
* @param {number} vendorCreditId - Vendor credit id.
* @returns {Promise<IRefundVendorCreditPOJO[]>}
*/
public getVendorCreditRefunds(
vendorCreditId: number,
): Promise<IRefundVendorCreditPOJO[]> {
return this.getRefundVendorCreditsService.getVendorCreditRefunds(
vendorCreditId,
);
}
/**
* Creates a refund vendor credit.

View File

@@ -1,4 +1,4 @@
import { Body, Controller, Delete, Param, Post } from '@nestjs/common';
import { Body, Controller, Delete, Get, Param, Post } from '@nestjs/common';
import { VendorCreditsRefundApplication } from './VendorCreditsRefund.application';
import { RefundVendorCredit } from './models/RefundVendorCredit';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
@@ -9,7 +9,22 @@ import { RefundVendorCreditDto } from './dtos/RefundVendorCredit.dto';
export class VendorCreditsRefundController {
constructor(
private readonly vendorCreditsRefundApplication: VendorCreditsRefundApplication,
) {}
) { }
/**
* Retrieve the vendor credit refunds graph.
* @param {number} vendorCreditId - Vendor credit id.
* @returns {Promise<IRefundVendorCreditPOJO[]>}
*/
@Get(':vendorCreditId/refund')
@ApiOperation({ summary: 'Retrieve the vendor credit refunds graph.' })
public getVendorCreditRefunds(
@Param('vendorCreditId') vendorCreditId: string,
) {
return this.vendorCreditsRefundApplication.getVendorCreditRefunds(
Number(vendorCreditId),
);
}
/**
* Creates a refund vendor credit.
@@ -17,7 +32,7 @@ export class VendorCreditsRefundController {
* @param {IRefundVendorCreditDTO} refundVendorCreditDTO
* @returns {Promise<RefundVendorCredit>}
*/
@Post(':vendorCreditId/refunds')
@Post(':vendorCreditId/refund')
@ApiOperation({ summary: 'Create a refund for the given vendor credit.' })
public async createRefundVendorCredit(
@Param('vendorCreditId') vendorCreditId: string,

View File

@@ -1,10 +1,12 @@
import { IsOptional, ToNumber } from '@/common/decorators/Validators';
import { ApiProperty } from '@nestjs/swagger';
import { Min } from 'class-validator';
import { IsDateString, Min } from 'class-validator';
import { IsString } from 'class-validator';
import { IsDate } from 'class-validator';
import { IsNotEmpty, IsNumber, IsOptional, IsPositive } from 'class-validator';
import { IsNotEmpty, IsNumber, IsPositive } from 'class-validator';
export class RefundVendorCreditDto {
@ToNumber()
@IsNumber()
@IsNotEmpty()
@Min(0)
@@ -32,6 +34,7 @@ export class RefundVendorCreditDto {
})
depositAccountId: number;
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiProperty({
@@ -40,7 +43,7 @@ export class RefundVendorCreditDto {
})
description: string;
@IsDate()
@IsDateString()
@IsNotEmpty()
@ApiProperty({
description: 'The date of the refund',