feat: get bank account meta summary

packages/server/src/api/controllers/Banking/BankAccountsController.ts

@@ -0,0 +1,49 @@
+import { Inject, Service } from 'typedi';
+import { NextFunction, Request, Response, Router } from 'express';
+import BaseController from '@/api/controllers/BaseController';
+import { CashflowApplication } from '@/services/Cashflow/CashflowApplication';
+import { GetBankAccountSummary } from '@/services/Banking/BankAccounts/GetBankAccountSummary';
+
+@Service()
+export class BankAccountsController extends BaseController {
+  @Inject()
+  private getBankAccountSummaryService: GetBankAccountSummary;
+
+  /**
+   * Router constructor.
+   */
+  router() {
+    const router = Router();
+
+    router.get('/:bankAccountId/meta', this.getBankAccountSummary.bind(this));
+
+    return router;
+  }
+
+  /**
+   * Retrieves the bank account meta summary.
+   * @param {Request} req
+   * @param {Response} res
+   * @param {NextFunction} next
+   * @returns {Promise<Response|null>}
+   */
+  async getBankAccountSummary(
+    req: Request<{ bankAccountId: number }>,
+    res: Response,
+    next: NextFunction
+  ) {
+    const { bankAccountId } = req.params;
+    const { tenantId } = req;
+
+    try {
+      const data =
+        await this.getBankAccountSummaryService.getBankAccountSummary(
+          tenantId,
+          bankAccountId
+        );
+      return res.status(200).send({ data });
+    } catch (error) {
+      next(error);
+    }
+  }
+}

packages/server/src/api/controllers/Banking/BankingController.ts

@@ -5,6 +5,7 @@ import { PlaidBankingController } from './PlaidBankingController';
 import { BankingRulesController } from './BankingRulesController';
 import { BankTransactionsMatchingController } from './BankTransactionsMatchingController';
 import { RecognizedTransactionsController } from './RecognizedTransactionsController';
+import { BankAccountsController } from './BankAccountsController';
 
 @Service()
 export class BankingController extends BaseController {
@@ -24,7 +25,10 @@ export class BankingController extends BaseController {
       '/recognized',
       Container.get(RecognizedTransactionsController).router()
     );
-
+    router.use(
+      '/bank_accounts',
+      Container.get(BankAccountsController).router()
+    );
     return router;
   }
 }

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

@@ -0,0 +1,53 @@
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import { Server } from 'socket.io';
+import { Inject, Service } from 'typedi';
+
+@Service()
+export class GetBankAccountSummary {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  /**
+   * Retrieves the bank account meta summary
+   * @param {number} tenantId
+   * @param {number} bankAccountId
+   * @returns
+   */
+  public async getBankAccountSummary(tenantId: number, bankAccountId: number) {
+    const {
+      Account,
+      UncategorizedCashflowTransaction,
+      RecognizedBankTransaction,
+    } = this.tenancy.models(tenantId);
+
+    const bankAccount = await Account.query()
+      .findById(bankAccountId)
+      .throwIfNotFound();
+
+    const uncategorizedTranasctionsCount =
+      await UncategorizedCashflowTransaction.query()
+        .where('accountId', bankAccountId)
+        .count('id as total')
+        .first();
+
+    const recognizedTransactionsCount = await RecognizedBankTransaction.query()
+      .whereExists(
+        UncategorizedCashflowTransaction.query().where(
+          'accountId',
+          bankAccountId
+        )
+      )
+      .count('id as total')
+      .first();
+
+    const totalUncategorizedTransactions =
+      uncategorizedTranasctionsCount?.total;
+    const totalRecognizedTransactions = recognizedTransactionsCount?.total;
+
+    return {
+      name: bankAccount.name,
+      totalUncategorizedTransactions,
+      totalRecognizedTransactions,
+    };
+  }
+}

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

@@ -32,11 +32,16 @@ export class GetUncategorizedTransactions {
     };
     const { results, pagination } =
       await UncategorizedCashflowTransaction.query()
-        .where('accountId', accountId)
-        .where('categorized', false)
-        .modify('notExcluded')
-        .withGraphFetched('account')
-        .orderBy('date', 'DESC')
+        .onBuild((q) => {
+          q.where('accountId', accountId);
+          q.where('categorized', false);
+          q.modify('notExcluded');
+
+          q.withGraphFetched('account');
+          q.withGraphFetched('recognizedTransaction.assignAccount');
+
+          q.orderBy('date', 'DESC');
+        })
         .pagination(_query.page - 1, _query.pageSize);
 
     const data = await this.transformer.transform(

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

@@ -12,9 +12,25 @@ export class UncategorizedTransactionTransformer extends Transformer {
       'formattedDate',
       'formattedDepositAmount',
       'formattedWithdrawalAmount',
+
+      'assignedAccountId',
+      'assignedAccountName',
+      'assignedAccountCode',
+      'assignedPayee',
+      'assignedMemo',
+      'assignedCategory',
+      'assignedCategoryFormatted',
     ];
   };
 
+  /**
+   * Exclude all attributes.
+   * @returns {Array<string>}
+   */
+  public excludeAttributes = (): string[] => {
+    return ['recognizedTransaction'];
+  };
+
   /**
    * Formattes the transaction date.
    * @param transaction
@@ -26,7 +42,7 @@ export class UncategorizedTransactionTransformer extends Transformer {
 
   /**
    * Formatted amount.
-   * @param transaction 
+   * @param transaction
    * @returns {string}
    */
   public formattedAmount(transaction) {
@@ -62,4 +78,69 @@ export class UncategorizedTransactionTransformer extends Transformer {
     }
     return '';
   }
+
+  // --------------------------------------------------------
+  // # Recgonized transaction
+  // --------------------------------------------------------
+  /**
+   * Get the assigned account ID of the transaction.
+   * @param {object} transaction
+   * @returns {number}
+   */
+  public assignedAccountId(transaction: any): number {
+    return transaction.recognizedTransaction?.assignedAccountId;
+  }
+
+  /**
+   * Get the assigned account name of the transaction.
+   * @param {object} transaction
+   * @returns {string}
+   */
+  public assignedAccountName(transaction: any): string {
+    return transaction.recognizedTransaction?.assignAccount?.name;
+  }
+
+  /**
+   * Get the assigned account code of the transaction.
+   * @param {object} transaction
+   * @returns {string}
+   */
+  public assignedAccountCode(transaction: any): string {
+    return transaction.recognizedTransaction?.assignAccount?.code;
+  }
+
+  /**
+   * Get the assigned payee of the transaction.
+   * @param {object} transaction
+   * @returns {string}
+   */
+  public getAssignedPayee(transaction: any): string {
+    return transaction.recognizedTransaction?.assignedPayee;
+  }
+
+  /**
+   * Get the assigned memo of the transaction.
+   * @param {object} transaction
+   * @returns {string}
+   */
+  public assignedMemo(transaction: any): string {
+    return transaction.recognizedTransaction?.assignedMemo;
+  }
+
+  /**
+   * Get the assigned category of the transaction.
+   * @param {object} transaction
+   * @returns {string}
+   */
+  public assignedCategory(transaction: any): string {
+    return transaction.recognizedTransaction?.assignedCategory;
+  }
+
+  /**
+   * Get the assigned formatted category.
+   * @returns {string}
+   */
+  public assignedCategoryFormatted() {
+    return 'Other Income';
+  }
 }