fix: bank transactions report

packages/server/src/interfaces/Account.ts

@@ -66,7 +66,9 @@ export interface IAccountTransaction {
   referenceId: number;
 
   referenceNumber?: string;
+
   transactionNumber?: string;
+  transactionType?: string;
 
   note?: string;
 

packages/server/src/interfaces/FinancialReports/CashflowAccountTransactions/index.ts

@@ -29,4 +29,9 @@ export interface ICashflowAccountTransaction {
 
   date: Date;
   formattedDate: string;
+
+  status: string;
+  formattedStatus: string;
+
+  uncategorizedTransactionId: number;
 }

packages/server/src/interfaces/Ledger.ts

@@ -40,6 +40,8 @@ export interface ILedgerEntry {
   date: Date | string;
 
   transactionType: string;
+  transactionSubType: string;
+
   transactionId: number;
 
   transactionNumber?: string;

packages/server/src/loaders/eventEmitter.ts

@@ -111,6 +111,7 @@ import { ValidateMatchingOnCashflowDelete } from '@/services/Banking/Matching/ev
 import { RecognizeSyncedBankTranasctions } from '@/services/Banking/Plaid/subscribers/RecognizeSyncedBankTransactions';
 import { UnlinkBankRuleOnDeleteBankRule } from '@/services/Banking/Rules/events/UnlinkBankRuleOnDeleteBankRule';
 import { DecrementUncategorizedTransactionOnMatching } from '@/services/Banking/Matching/events/DecrementUncategorizedTransactionsOnMatch';
+import { DecrementUncategorizedTransactionOnExclude } from '@/services/Banking/Exclude/events/DecrementUncategorizedTransactionOnExclude';
 
 export default () => {
   return new EventPublisher();
@@ -260,6 +261,7 @@ export const susbcribers = () => {
     TriggerRecognizedTransactions,
     UnlinkBankRuleOnDeleteBankRule,
     DecrementUncategorizedTransactionOnMatching,
+    DecrementUncategorizedTransactionOnExclude,
 
     // Validate matching
     ValidateMatchingOnCashflowDelete,

packages/server/src/models/CashflowTransaction.ts

@@ -5,9 +5,9 @@ import {
   getCashflowAccountTransactionsTypes,
   getCashflowTransactionType,
 } from '@/services/Cashflow/utils';
-import AccountTransaction from './AccountTransaction';
 import { CASHFLOW_DIRECTION } from '@/services/Cashflow/constants';
 import { getTransactionTypeLabel } from '@/utils/transactions-types';
+
 export default class CashflowTransaction extends TenantModel {
   transactionType: string;
   amount: number;
@@ -100,9 +100,26 @@ export default class CashflowTransaction extends TenantModel {
    */
   static get modifiers() {
     return {
+      /**
+       * Filter the published transactions.
+       */
       published(query) {
         query.whereNot('published_at', null);
       },
+
+      /**
+       * Filter the not categorized transactions.
+       */
+      notCategorized(query) {
+        query.whereNull('cashflowTransactions.uncategorizedTransactionId');
+      },
+
+      /**
+       * Filter the categorized transactions.
+       */
+      categorized(query) {
+        query.whereNotNull('cashflowTransactions.uncategorizedTransactionId');
+      },
     };
   }
 

packages/server/src/services/Accounting/utils.ts

@@ -19,6 +19,8 @@ export const transformLedgerEntryToTransaction = (
     referenceId: entry.transactionId,
 
     transactionNumber: entry.transactionNumber,
+    transactionType: entry.transactionSubType,
+
     referenceNumber: entry.referenceNumber,
 
     note: entry.note,

packages/server/src/services/Banking/BankAccounts/GetBankAccountSummary.ts

@@ -19,11 +19,13 @@ export class GetBankAccountSummary {
       Account,
       UncategorizedCashflowTransaction,
       RecognizedBankTransaction,
+      MatchedBankTransaction,
     } = this.tenancy.models(tenantId);
 
     await initialize(knex, [
       UncategorizedCashflowTransaction,
       RecognizedBankTransaction,
+      MatchedBankTransaction,
     ]);
     const bankAccount = await Account.query()
       .findById(bankAccountId)

packages/server/src/services/Banking/Exclude/ExcludeBankTransaction.ts

@@ -2,6 +2,12 @@ import HasTenancyService from '@/services/Tenancy/TenancyService';
 import UnitOfWork from '@/services/UnitOfWork';
 import { Inject, Service } from 'typedi';
 import { validateTransactionNotCategorized } from './utils';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import events from '@/subscribers/events';
+import {
+  IBankTransactionUnexcludedEventPayload,
+  IBankTransactionUnexcludingEventPayload,
+} from './_types';
 
 @Service()
 export class ExcludeBankTransaction {
@@ -11,6 +17,9 @@ export class ExcludeBankTransaction {
   @Inject()
   private uow: UnitOfWork;
 
+  @Inject()
+  private eventPublisher: EventPublisher;
+
   /**
    * Marks the given bank transaction as excluded.
    * @param {number} tenantId
@@ -31,11 +40,23 @@ export class ExcludeBankTransaction {
     validateTransactionNotCategorized(oldUncategorizedTransaction);
 
     return this.uow.withTransaction(tenantId, async (trx) => {
+      await this.eventPublisher.emitAsync(events.bankTransactions.onExcluding, {
+        tenantId,
+        uncategorizedTransactionId,
+        trx,
+      } as IBankTransactionUnexcludingEventPayload);
+
       await UncategorizedCashflowTransaction.query(trx)
         .findById(uncategorizedTransactionId)
         .patch({
           excludedAt: new Date(),
         });
+
+      await this.eventPublisher.emitAsync(events.bankTransactions.onExcluded, {
+        tenantId,
+        uncategorizedTransactionId,
+        trx,
+      } as IBankTransactionUnexcludedEventPayload);
     });
   }
 }

packages/server/src/services/Banking/Exclude/UnexcludeBankTransaction.ts

@@ -2,6 +2,12 @@ import HasTenancyService from '@/services/Tenancy/TenancyService';
 import UnitOfWork from '@/services/UnitOfWork';
 import { Inject, Service } from 'typedi';
 import { validateTransactionNotCategorized } from './utils';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import events from '@/subscribers/events';
+import {
+  IBankTransactionExcludedEventPayload,
+  IBankTransactionExcludingEventPayload,
+} from './_types';
 
 @Service()
 export class UnexcludeBankTransaction {
@@ -11,6 +17,9 @@ export class UnexcludeBankTransaction {
   @Inject()
   private uow: UnitOfWork;
 
+  @Inject()
+  private eventPublisher: EventPublisher;
+
   /**
    * Marks the given bank transaction as excluded.
    * @param {number} tenantId
@@ -31,11 +40,21 @@ export class UnexcludeBankTransaction {
     validateTransactionNotCategorized(oldUncategorizedTransaction);
 
     return this.uow.withTransaction(tenantId, async (trx) => {
+      await this.eventPublisher.emitAsync(events.bankTransactions.onExcluding, {
+        tenantId,
+        uncategorizedTransactionId,
+      } as IBankTransactionExcludingEventPayload);
+
       await UncategorizedCashflowTransaction.query(trx)
         .findById(uncategorizedTransactionId)
         .patch({
           excludedAt: null,
         });
+
+      await this.eventPublisher.emitAsync(events.bankTransactions.onExcluded, {
+        tenantId,
+        uncategorizedTransactionId,
+      } as IBankTransactionExcludedEventPayload);
     });
   }
 }

packages/server/src/services/Banking/Exclude/_types.ts

@@ -1,6 +1,30 @@
+import { Knex } from "knex";
 
 export interface ExcludedBankTransactionsQuery {
   page?: number;
   pageSize?: number;
   accountId?: number;
-}
+}
+
+export interface IBankTransactionUnexcludingEventPayload {
+  tenantId: number;
+  uncategorizedTransactionId: number;
+  trx?: Knex.Transaction
+}
+
+export interface IBankTransactionUnexcludedEventPayload {
+  tenantId: number;
+  uncategorizedTransactionId: number;
+  trx?: Knex.Transaction
+}
+
+export interface IBankTransactionExcludingEventPayload {
+  tenantId: number;
+  uncategorizedTransactionId: number;
+  trx?: Knex.Transaction
+}
+export interface IBankTransactionExcludedEventPayload {
+  tenantId: number;
+  uncategorizedTransactionId: number;
+  trx?: Knex.Transaction
+}

packages/server/src/services/Banking/Exclude/events/DecrementUncategorizedTransactionOnExclude.ts

@@ -0,0 +1,68 @@
+import { Inject, Service } from 'typedi';
+import events from '@/subscribers/events';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import {
+  IBankTransactionExcludedEventPayload,
+  IBankTransactionUnexcludedEventPayload,
+} from '../_types';
+
+@Service()
+export class DecrementUncategorizedTransactionOnExclude {
+  @Inject()
+  private tenancy: HasTenancyService;
+  /**
+   * Constructor method.
+   */
+  public attach(bus) {
+    bus.subscribe(
+      events.bankTransactions.onExcluded,
+      this.decrementUnCategorizedTransactionsOnExclude.bind(this)
+    );
+    bus.subscribe(
+      events.bankTransactions.onUnexcluded,
+      this.incrementUnCategorizedTransactionsOnUnexclude.bind(this)
+    );
+  }
+
+  /**
+   * Validates the cashflow transaction whether matched with bank transaction on deleting.
+   * @param {IManualJournalDeletingPayload}
+   */
+  public async decrementUnCategorizedTransactionsOnExclude({
+    tenantId,
+    uncategorizedTransactionId,
+    trx,
+  }: IBankTransactionExcludedEventPayload) {
+    const { UncategorizedCashflowTransaction, Account } =
+      this.tenancy.models(tenantId);
+
+    const transaction = await UncategorizedCashflowTransaction.query(
+      trx
+    ).findById(uncategorizedTransactionId);
+
+    await Account.query(trx)
+      .findById(transaction.accountId)
+      .decrement('uncategorizedTransactions', 1);
+  }
+
+  /**
+   * Validates the cashflow transaction whether matched with bank transaction on deleting.
+   * @param {IManualJournalDeletingPayload}
+   */
+  public async incrementUnCategorizedTransactionsOnUnexclude({
+    tenantId,
+    uncategorizedTransactionId,
+    trx,
+  }: IBankTransactionUnexcludedEventPayload) {
+    const { UncategorizedCashflowTransaction, Account } =
+      this.tenancy.models(tenantId);
+
+    const transaction = await UncategorizedCashflowTransaction.query().findById(
+      uncategorizedTransactionId
+    );
+    //
+    await Account.query(trx)
+      .findById(transaction.accountId)
+      .increment('uncategorizedTransactions', 1);
+  }
+}

packages/server/src/services/Banking/Matching/GetMatchedTransactionsByCashflow.ts

@@ -32,6 +32,9 @@ export class GetMatchedTransactionsByCashflow extends GetMatchedTransactionsByTy
       q.withGraphJoined('matchedBankTransaction');
       q.whereNull('matchedBankTransaction.id');
 
+      // Not categorized.
+      q.modify('notCategorized');
+
       // Published.
       q.modify('published');
 
@@ -69,6 +72,8 @@ export class GetMatchedTransactionsByCashflow extends GetMatchedTransactionsByTy
       .findById(transactionId)
       .withGraphJoined('matchedBankTransaction')
       .whereNull('matchedBankTransaction.id')
+      .modify('notCategorized')
+      .modify('published')
       .throwIfNotFound();
 
     return this.transformer.transform(

packages/server/src/services/Banking/Matching/events/DecrementUncategorizedTransactionsOnMatch.ts

@@ -31,7 +31,6 @@ export class DecrementUncategorizedTransactionOnMatching {
   public async decrementUnCategorizedTransactionsOnMatching({
     tenantId,
     uncategorizedTransactionId,
-    matchTransactionsDTO,
     trx,
   }: IBankTransactionMatchedEventPayload) {
     const { UncategorizedCashflowTransaction, Account } =
@@ -64,6 +63,6 @@ export class DecrementUncategorizedTransactionOnMatching {
     //
     await Account.query(trx)
       .findById(transaction.accountId)
-      .decrement('uncategorizedTransactions', 1);
+      .increment('uncategorizedTransactions', 1);
   }
 }

packages/server/src/services/Cashflow/CashflowTransactionJournalEntries.ts

@@ -34,11 +34,12 @@ export default class CashflowTransactionJournalEntries {
       currencyCode: transaction.currencyCode,
       exchangeRate: transaction.exchangeRate,
 
-      transactionType: transformCashflowTransactionType(
-        transaction.transactionType
-      ),
+      transactionType: 'CashflowTransaction',
       transactionId: transaction.id,
       transactionNumber: transaction.transactionNumber,
+      transactionSubType: transformCashflowTransactionType(
+        transaction.transactionType
+      ),
       referenceNumber: transaction.referenceNo,
 
       note: transaction.description,
@@ -161,12 +162,10 @@ export default class CashflowTransactionJournalEntries {
     cashflowTransactionId: number,
     trx?: Knex.Transaction
   ): Promise<void> => {
-    const transactionTypes = getCashflowAccountTransactionsTypes();
-
     await this.ledgerStorage.deleteByReference(
       tenantId,
       cashflowTransactionId,
-      transactionTypes,
+      'CashflowTransaction',
       trx
     );
   };

packages/server/src/services/Cashflow/NewCashflowTransactionService.ts

@@ -101,6 +101,7 @@ export default class NewCashflowTransactionService {
       ...fromDTO,
       transactionNumber,
       currencyCode: cashflowAccount.currencyCode,
+      exchangeRate: fromDTO?.exchangeRate || 1,
       transactionType: transformCashflowTransactionType(
         fromDTO.transactionType
       ),