Merge pull request #1313 from Northeastern-Electric-Racing/#1290-add-allowed-refund-sources-to-expense-types

#1290 - add allowed refund sources to expense type

Author: RChandler234

src/backend/src/controllers/reimbursement-requests.controllers.ts

@@ -162,9 +162,15 @@ export default class ReimbursementRequestsController {
 
   static async createExpenseType(req: Request, res: Response, next: NextFunction) {
     try {
-      const { name, code, allowed } = req.body;
+      const { name, code, allowed, allowedRefundSources } = req.body;
       const user = await getCurrentUser(res);
-      const createdExpenseType = await ReimbursementRequestService.createExpenseType(user, name, code, allowed);
+      const createdExpenseType = await ReimbursementRequestService.createExpenseType(
+        user,
+        name,
+        code,
+        allowed,
+        allowedRefundSources
+      );
       res.status(200).json(createdExpenseType);
     } catch (error: unknown) {
       next(error);
@@ -269,14 +275,15 @@ export default class ReimbursementRequestsController {
   static async editExpenseTypeCode(req: Request, res: Response, next: NextFunction) {
     try {
       const { expenseTypeId } = req.params;
-      const { name, code, allowed } = req.body;
+      const { name, code, allowed, allowedRefundSources } = req.body;
       const submitter = await getCurrentUser(res);
       const expenseTypeUpdated = await ReimbursementRequestService.editExpenseType(
         expenseTypeId,
         code,
         name,
         allowed,
-        submitter
+        submitter,
+        allowedRefundSources
       );
       res.status(200).json(expenseTypeUpdated);
     } catch (error: unknown) {

src/backend/src/prisma/migrations/20230829222742_add_allowed_refund_sources/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "Expense_Type" ADD COLUMN     "allowedRefundSources" "Club_Accounts"[];

src/backend/src/prisma/schema.prisma

@@ -429,11 +429,12 @@ model Vendor {
 }
 
 model Expense_Type {
-  expenseTypeId String                  @id @default(uuid())
-  name          String
-  code          Int
-  allowed       Boolean
-  requests      Reimbursement_Request[]
+  expenseTypeId        String                  @id @default(uuid())
+  name                 String
+  code                 Int
+  allowed              Boolean
+  allowedRefundSources Club_Accounts[]
+  requests             Reimbursement_Request[]
 }
 
 model Reimbursement {

src/backend/src/prisma/seed.ts

@@ -7,6 +7,7 @@
 
 import {
   CR_Type,
+  Club_Accounts,
   PrismaClient,
   Scope_CR_Why_Type,
   Task_Priority,
@@ -750,7 +751,10 @@ const performSeed: () => Promise<void> = async () => {
 
   const vendors: Vendor[] = [vendor, vendor2, vendor3];
 
-  const expenseType = await ReimbursementRequestService.createExpenseType(thomasEmrax, 'Equipment', 123, true);
+  const expenseType = await ReimbursementRequestService.createExpenseType(thomasEmrax, 'Equipment', 123, true, [
+    Club_Accounts.CASH,
+    Club_Accounts.BUDGET
+  ]);
 
   await ReimbursementRequestService.createReimbursementRequest(
     thomasEmrax,

src/backend/src/routes/reimbursement-requests.routes.ts

@@ -86,6 +86,8 @@ reimbursementRequestsRouter.post(
 reimbursementRequestsRouter.post(
   '/vendors/create',
   nonEmptyString(body('name')),
+  body('allowedRefundSources').isArray(),
+  isAccount(body('allowedRefundSources.*')),
   validateInputs,
   ReimbursementRequestController.createVendor
 );
@@ -95,6 +97,8 @@ reimbursementRequestsRouter.post(
   nonEmptyString(body('name')),
   intMinZero(body('code')),
   body('allowed').isBoolean(),
+  body('allowedRefundSources').isArray(),
+  isAccount(body('allowedRefundSources.*')),
   validateInputs,
   ReimbursementRequestController.createExpenseType
 );

src/backend/src/services/reimbursement-requests.services.ts

@@ -5,7 +5,7 @@
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import type { Multer } from 'multer';
-import { Reimbursement_Request, Reimbursement_Status_Type, User } from '@prisma/client';
+import { Club_Accounts, Reimbursement_Request, Reimbursement_Status_Type, User } from '@prisma/client';
 import {
   ClubAccount,
   ExpenseType,
@@ -131,6 +131,10 @@ export default class ReimbursementRequestService {
 
     if (!expenseType.allowed) throw new HttpException(400, `The expense type ${expenseType.name} is not allowed!`);
 
+    if (!expenseType.allowedRefundSources.includes(account)) {
+      throw new HttpException(400, 'The submitted refund source is not allowed to be used with the submitted expense type');
+    }
+
     const validatedReimbursementProudcts = await validateReimbursementProducts(reimbursementProducts);
 
     const createdReimbursementRequest = await prisma.reimbursement_Request.create({
@@ -268,6 +272,9 @@ export default class ReimbursementRequestService {
 
     if (!expenseType) throw new NotFoundException('Expense Type', expenseTypeId);
     if (!expenseType.allowed) throw new HttpException(400, 'Expense Type Not Allowed');
+    if (!expenseType.allowedRefundSources.includes(account)) {
+      throw new HttpException(400, 'The submitted refund source is not allowed to be used with the submitted expense type');
+    }
 
     await updateReimbursementProducts(
       oldReimbursementRequest.reimbursementProducts,
@@ -463,15 +470,23 @@ export default class ReimbursementRequestService {
    * @param name The name of the expense type
    * @param code the expense type's SABO code
    * @param allowed whether or not this expense type is allowed
+   * @param allowedRefundSources an array of Club_Accounts representing allowed refund sources
    * @returns the created expense type
    */
-  static async createExpenseType(submitter: User, name: string, code: number, allowed: boolean) {
+  static async createExpenseType(
+    submitter: User,
+    name: string,
+    code: number,
+    allowed: boolean,
+    allowedRefundSources: Club_Accounts[]
+  ) {
     if (!isAdmin(submitter.role)) throw new AccessDeniedAdminOnlyException('create expense types');
     const expense = await prisma.expense_Type.create({
       data: {
         name,
         allowed,
-        code
+        code,
+        allowedRefundSources
       }
     });
 
@@ -487,7 +502,14 @@ export default class ReimbursementRequestService {
    * @param submitter the person editing expense type code number
    * @returns the updated expense type
    */
-  static async editExpenseType(expenseTypeId: string, code: number, name: string, allowed: boolean, submitter: User) {
+  static async editExpenseType(
+    expenseTypeId: string,
+    code: number,
+    name: string,
+    allowed: boolean,
+    submitter: User,
+    allowedRefundSources: Club_Accounts[]
+  ) {
     if (!isHead(submitter.role))
       throw new AccessDeniedException('Only the head or admin can update account code number and name');
 
@@ -502,7 +524,8 @@ export default class ReimbursementRequestService {
       data: {
         name,
         code,
-        allowed
+        allowed,
+        allowedRefundSources
       }
     });
 

src/backend/src/transformers/reimbursement-requests.transformer.ts

@@ -83,7 +83,8 @@ export const expenseTypeTransformer = (expenseType: Prisma.Expense_TypeGetPayloa
     expenseTypeId: expenseType.expenseTypeId,
     name: expenseType.name,
     code: expenseType.code,
-    allowed: expenseType.allowed
+    allowed: expenseType.allowed,
+    allowedRefundSources: expenseType.allowedRefundSources as ClubAccount[]
   };
 };
 

src/backend/tests/reimbursement-requests.test.ts

@@ -67,14 +67,20 @@ describe('Reimbursement Requests', () => {
   describe('Expense Tests', () => {
     test('Create Expense Type fails for non admins', async () => {
       await expect(
-        ReimbursementRequestService.createExpenseType(wonderwoman, Parts.name, Parts.code, Parts.allowed)
+        ReimbursementRequestService.createExpenseType(wonderwoman, Parts.name, Parts.code, Parts.allowed, [ClubAccount.CASH])
       ).rejects.toThrow(new AccessDeniedAdminOnlyException('create expense types'));
     });
 
     test('Create Expense Type Successfully returns expense type Id', async () => {
       vi.spyOn(prisma.expense_Type, 'create').mockResolvedValue(Parts);
 
-      const expenseType = await ReimbursementRequestService.createExpenseType(batman, Parts.name, Parts.code, Parts.allowed);
+      const expenseType = await ReimbursementRequestService.createExpenseType(
+        batman,
+        Parts.name,
+        Parts.code,
+        Parts.allowed,
+        [ClubAccount.BUDGET]
+      );
 
       expect(expenseType.expenseTypeId).toBe(Parts.expenseTypeId);
     });

src/backend/tests/test-data/reimbursement-requests.test-data.ts

@@ -12,7 +12,7 @@ import {
 import reimbursementRequestQueryArgs from '../../src/prisma-query-args/reimbursement-requests.query-args';
 import { alfred, batman } from './users.test-data';
 import { prismaWbsElement1 } from './wbs-element.test-data';
-import { ClubAccount, ReimbursementRequest } from 'shared';
+import { ClubAccount, ExpenseType, ReimbursementRequest } from 'shared';
 import { wbsNumOf } from '../../src/utils/utils';
 import userTransformer from '../../src/transformers/user.transformer';
 
@@ -26,7 +26,8 @@ export const Parts: PrismaExpenseType = {
   expenseTypeId: 'PARTS',
   name: 'hammer',
   code: 12245,
-  allowed: true
+  allowed: true,
+  allowedRefundSources: [Club_Accounts.CASH, Club_Accounts.BUDGET]
 };
 
 export const GiveMeMyMoney: PrismaReimbursementRequest = {
@@ -146,7 +147,7 @@ export const sharedGiveMeMyMoney: ReimbursementRequest = {
   dateOfExpense: GiveMeMyMoney.dateOfExpense,
   totalCost: GiveMeMyMoney.totalCost,
   receiptPictures: [],
-  expenseType: Parts,
+  expenseType: Parts as ExpenseType,
   vendor: PopEyes,
   recipient: userTransformer(batman),
   saboId: undefined,

src/frontend/src/hooks/finance.hooks.ts

@@ -40,11 +40,11 @@ import {
 
 export interface CreateReimbursementRequestPayload {
   vendorId: string;
-  account: ClubAccount;
   dateOfExpense: Date;
   expenseTypeId: string;
   reimbursementProducts: ReimbursementProductCreateArgs[];
   totalCost: number;
+  account: ClubAccount;
 }
 
 export interface EditReimbursementRequestPayload extends CreateReimbursementRequestPayload {
@@ -55,6 +55,7 @@ export interface ExpenseTypePayload {
   code: number;
   name: string;
   allowed: boolean;
+  allowedRefundSources: ClubAccount[];
 }
 
 /**