bigcapital/packages/server/src/modules/TransactionItemEntry/dto/ItemEntry.dto.ts

import { DiscountType } from '@/common/types/Discount';
import { ApiProperty } from '@nestjs/swagger';
import {
  IsEnum,
  IsIn,
  IsInt,
  IsNotEmpty,
  IsNumber,
  IsOptional,
  IsString,
} from 'class-validator';

export class ItemEntryDto {
  @IsInt()
  @ApiProperty({
    description: 'The index of the item entry',
    example: 1,
  })
  index: number;

  @IsInt()
  @IsNotEmpty()
  @ApiProperty({
    description: 'The id of the item',
    example: 1,
  })
  itemId: number;

  @IsNumber()
  @IsNotEmpty()
  @ApiProperty({
    description: 'The rate of the item entry',
    example: 1,
  })
  rate: number;

  @IsNumber()
  @IsNotEmpty()
  @ApiProperty({
    description: 'The quantity of the item entry',
    example: 1,
  })
  quantity: number;

  @IsOptional()
  @IsNumber()
  @ApiProperty({
    description: 'The discount of the item entry',
    example: 1,
  })
  discount?: number;

  @IsOptional()
  @IsEnum(DiscountType)
  @ApiProperty({
    description: 'The type of the discount',
    example: DiscountType.Percentage,
  })
  discountType?: DiscountType = DiscountType.Percentage;

  @IsOptional()
  @IsString()
  @ApiProperty({
    description: 'The description of the item entry',
    example: 'This is a description',
  })
  description?: string;

  @IsOptional()
  @IsString()
  @ApiProperty({
    description: 'The tax code of the item entry',
    example: '123456',
  })
  taxCode?: string;

  @IsOptional()
  @IsInt()
  @ApiProperty({
    description: 'The tax rate id of the item entry',
    example: 1,
  })
  taxRateId?: number;

  @IsOptional()
  @IsInt()
  @ApiProperty({
    description: 'The warehouse id of the item entry',
    example: 1,
  })
  warehouseId?: number;

  @IsOptional()
  @IsInt()
  @ApiProperty({
    description: 'The project id of the item entry',
    example: 1,
  })
  projectId?: number;

  @IsOptional()
  @IsInt()
  @ApiProperty({
    description: 'The project ref id of the item entry',
    example: 1,
  })
  projectRefId?: number;

  @IsOptional()
  @IsString()
  @IsIn(['TASK', 'BILL', 'EXPENSE'])
  @ApiProperty({
    description: 'The project ref type of the item entry',
    example: 'TASK',
  })
  projectRefType?: string;

  @IsOptional()
  @IsNumber()
  @ApiProperty({
    description: 'The project ref invoiced amount of the item entry',
    example: 100,
  })
  projectRefInvoicedAmount?: number;

  @IsOptional()
  @IsInt()
  @ApiProperty({
    description: 'The sell account id of the item entry',
    example: 1020,
  })
  sellAccountId?: number;

  @IsOptional()
  @IsInt()
  @ApiProperty({
    description: 'The cost account id of the item entry',
    example: 1021,
  })
  costAccountId?: number;
}