wip

packages/server/src/modules/Customers/CustomerGLEntriesStorage.ts

@@ -5,6 +5,7 @@ import { AccountRepository } from '@/modules/Accounts/repositories/Account.repos
 import { CustomerGLEntries } from './CustomerGLEntries';
 import { Customer } from './models/Customer';
 import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
+import { Account } from '../Accounts/models/Account.model';
 
 @Injectable()
 export class CustomerGLEntriesStorage {
@@ -13,6 +14,9 @@ export class CustomerGLEntriesStorage {
     private readonly accountRepository: AccountRepository,
     private readonly customerGLEntries: CustomerGLEntries,
 
+    @Inject(Account.name)
+    private readonly accountModel: TenantModelProxy<typeof Account>,
+
     @Inject(Customer.name)
     private readonly customerModel: TenantModelProxy<typeof Customer>,
   ) { }
@@ -29,9 +33,10 @@ export class CustomerGLEntriesStorage {
       .findById(customerId);
 
     // Finds the income account.
-    const incomeAccount = await this.accountRepository.findOne({
-      slug: 'other-income',
-    });
+    const incomeAccount = await this.accountModel()
+      .query(trx)
+      .findOne({ slug: 'other-income' });
+
     // Find or create the A/R account.
     const ARAccount =
       await this.accountRepository.findOrCreateAccountReceivable(

packages/server/src/modules/Customers/Customers.controller.ts

@@ -9,10 +9,7 @@ import {
   Query,
 } from '@nestjs/common';
 import { CustomersApplication } from './CustomersApplication.service';
-import {
-  ICustomerOpeningBalanceEditDTO,
-  ICustomersFilter,
-} from './types/Customers.types';
+import { CustomerOpeningBalanceEditDto } from './dtos/CustomerOpeningBalanceEdit.dto';
 import {
   ApiOperation,
   ApiResponse,
@@ -106,7 +103,7 @@ export class CustomersController {
   })
   editOpeningBalance(
     @Param('id') customerId: number,
-    @Body() openingBalanceDTO: ICustomerOpeningBalanceEditDTO,
+    @Body() openingBalanceDTO: CustomerOpeningBalanceEditDto,
   ) {
     return this.customersApplication.editOpeningBalance(
       customerId,

packages/server/src/modules/Customers/Customers.module.ts

@@ -25,7 +25,12 @@ import { CustomerGLEntriesStorage } from './CustomerGLEntriesStorage';
 import { CustomerWriteGLOpeningBalanceSubscriber } from './subscribers/CustomerGLEntriesSubscriber';
 
 @Module({
-  imports: [TenancyDatabaseModule, DynamicListModule, LedgerModule, AccountsModule],
+  imports: [
+    TenancyDatabaseModule,
+    DynamicListModule,
+    LedgerModule,
+    AccountsModule,
+  ],
   controllers: [CustomersController],
   providers: [
     ActivateCustomer,
@@ -51,4 +56,4 @@ import { CustomerWriteGLOpeningBalanceSubscriber } from './subscribers/CustomerG
     CustomerWriteGLOpeningBalanceSubscriber,
   ],
 })
-export class CustomersModule { }
+export class CustomersModule {}

packages/server/src/modules/Customers/CustomersApplication.service.ts

@@ -4,10 +4,7 @@ import { CreateCustomer } from './commands/CreateCustomer.service';
 import { EditCustomer } from './commands/EditCustomer.service';
 import { DeleteCustomer } from './commands/DeleteCustomer.service';
 import { EditOpeningBalanceCustomer } from './commands/EditOpeningBalanceCustomer.service';
-import {
-  ICustomerOpeningBalanceEditDTO,
-  ICustomersFilter,
-} from './types/Customers.types';
+import { CustomerOpeningBalanceEditDto } from './dtos/CustomerOpeningBalanceEdit.dto';
 import { CreateCustomerDto } from './dtos/CreateCustomer.dto';
 import { EditCustomerDto } from './dtos/EditCustomer.dto';
 import { GetCustomers } from './queries/GetCustomers.service';
@@ -18,12 +15,12 @@ import { ValidateBulkDeleteCustomersService } from './ValidateBulkDeleteCustomer
 @Injectable()
 export class CustomersApplication {
   constructor(
-    private getCustomerService: GetCustomerService,
-    private createCustomerService: CreateCustomer,
-    private editCustomerService: EditCustomer,
-    private deleteCustomerService: DeleteCustomer,
-    private editOpeningBalanceService: EditOpeningBalanceCustomer,
-    private getCustomersService: GetCustomers,
+    private readonly getCustomerService: GetCustomerService,
+    private readonly createCustomerService: CreateCustomer,
+    private readonly editCustomerService: EditCustomer,
+    private readonly deleteCustomerService: DeleteCustomer,
+    private readonly editOpeningBalanceService: EditOpeningBalanceCustomer,
+    private readonly getCustomersService: GetCustomers,
     private readonly bulkDeleteCustomersService: BulkDeleteCustomersService,
     private readonly validateBulkDeleteCustomersService: ValidateBulkDeleteCustomersService,
   ) {}
@@ -72,7 +69,7 @@ export class CustomersApplication {
    */
   public editOpeningBalance = (
     customerId: number,
-    openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO,
+    openingBalanceEditDTO: CustomerOpeningBalanceEditDto,
   ) => {
     return this.editOpeningBalanceService.changeOpeningBalance(
       customerId,
@@ -82,7 +79,7 @@ export class CustomersApplication {
 
   /**
    * Retrieve customers paginated list.
-   * @param {ICustomersFilter} filter - Cusotmers filter.
+   * @param {GetCustomersQueryDto} filter - Cusotmers filter.
    */
   public getCustomers = (filterDTO: GetCustomersQueryDto) => {
     return this.getCustomersService.getCustomersList(filterDTO);

packages/server/src/modules/Customers/commands/CreateCustomer.service.ts

@@ -31,7 +31,7 @@ export class CreateCustomer {
 
   /**
    * Creates a new customer.
-   * @param  {ICustomerNewDTO} customerDTO
+   * @param {CreateCustomerDto} customerDTO
    * @return {Promise<ICustomer>}
    */
   public async createCustomer(

packages/server/src/modules/Customers/commands/EditOpeningBalanceCustomer.service.ts

@@ -1,10 +1,10 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { Knex } from 'knex';
 import {
-  ICustomerOpeningBalanceEditDTO,
   ICustomerOpeningBalanceEditedPayload,
   ICustomerOpeningBalanceEditingPayload,
 } from '../types/Customers.types';
+import { CustomerOpeningBalanceEditDto } from '../dtos/CustomerOpeningBalanceEdit.dto';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
 import { Customer } from '../models/Customer';
@@ -29,11 +29,11 @@ export class EditOpeningBalanceCustomer {
   /**
    * Changes the opening balance of the given customer.
    * @param {number} customerId - Customer ID.
-   * @param {ICustomerOpeningBalanceEditDTO} openingBalanceEditDTO
+   * @param {CustomerOpeningBalanceEditDto} openingBalanceEditDTO
    */
   public async changeOpeningBalance(
     customerId: number,
-    openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO,
+    openingBalanceEditDTO: CustomerOpeningBalanceEditDto,
   ): Promise<Customer> {
     // Retrieves the old customer or throw not found error.
     const oldCustomer = await this.customerModel()

packages/server/src/modules/Customers/dtos/CreateCustomer.dto.ts

@@ -4,6 +4,7 @@ import {
   IsNotEmpty,
   IsNumber,
   IsString,
+  ValidateIf,
 } from 'class-validator';
 import { ApiProperty } from '@nestjs/swagger';
 import { IsOptional, ToNumber } from '@/common/decorators/Validators';
@@ -40,10 +41,11 @@ export class CreateCustomerDto extends ContactAddressDto {
 
   @ApiProperty({
     required: false,
-    description: 'Opening balance date',
+    description: 'Opening balance date (required when openingBalance is provided)',
     example: '2024-01-01',
   })
-  @IsOptional()
+  @ValidateIf((o) => o.openingBalance != null)
+  @IsNotEmpty({ message: 'openingBalanceAt is required when openingBalance is provided' })
   @IsString()
   openingBalanceAt?: string;
 

packages/server/src/modules/Customers/dtos/CustomerOpeningBalanceEdit.dto.ts

@@ -0,0 +1,44 @@
+import { IsNotEmpty, IsNumber, IsString } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { IsOptional, ToNumber } from '@/common/decorators/Validators';
+
+export class CustomerOpeningBalanceEditDto {
+  @ApiProperty({
+    required: true,
+    description: 'Opening balance',
+    example: 5000.0,
+  })
+  @IsNumber()
+  @IsNotEmpty()
+  @ToNumber()
+  openingBalance: number;
+
+  @ApiProperty({
+    required: false,
+    description: 'Opening balance date',
+    example: '2024-01-01',
+  })
+  @IsOptional()
+  @IsString()
+  openingBalanceAt?: string;
+
+  @ApiProperty({
+    required: false,
+    description: 'Opening balance exchange rate',
+    example: 1.0,
+  })
+  @IsOptional()
+  @IsNumber()
+  @ToNumber()
+  openingBalanceExchangeRate?: number;
+
+  @ApiProperty({
+    required: false,
+    description: 'Opening balance branch ID',
+    example: 101,
+  })
+  @IsOptional()
+  @IsNumber()
+  @ToNumber()
+  openingBalanceBranchId?: number;
+}

packages/server/src/modules/Customers/types/Customers.types.ts

@@ -4,6 +4,7 @@ import { IContactAddressDTO } from '@/modules/Contacts/types/Contacts.types';
 import { IDynamicListFilter } from '@/modules/DynamicListing/DynamicFilter/DynamicFilter.types';
 import { IFilterMeta, IPaginationMeta } from '@/interfaces/Model';
 import { CreateCustomerDto } from '../dtos/CreateCustomer.dto';
+import { CustomerOpeningBalanceEditDto } from '../dtos/CustomerOpeningBalanceEdit.dto';
 import { EditCustomerDto } from '../dtos/EditCustomer.dto';
 
 // Customer Interfaces.
@@ -113,23 +114,16 @@ export enum VendorAction {
   View = 'View',
 }
 
-export interface ICustomerOpeningBalanceEditDTO {
-  openingBalance: number;
-  openingBalanceAt: Date | string;
-  openingBalanceExchangeRate: number;
-  openingBalanceBranchId?: number;
-}
-
 export interface ICustomerOpeningBalanceEditingPayload {
   oldCustomer: Customer;
-  openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO;
+  openingBalanceEditDTO: CustomerOpeningBalanceEditDto;
   trx?: Knex.Transaction;
 }
 
 export interface ICustomerOpeningBalanceEditedPayload {
   customer: Customer;
   oldCustomer: Customer;
-  openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO;
+  openingBalanceEditDTO: CustomerOpeningBalanceEditDto;
   trx: Knex.Transaction;
 }