#5569 - Funding Summary Reorganization by weskubo-cgi · Pull Request #5719 · bcgov/SIMS

weskubo-cgi · 2026-02-03T22:12:10Z

Frontend

Reorganized Award Table layout to have both Estimated and Final awards in a single component
Refactored DisbursementStatusChip
Updates to ChipLabel to support disbursement status and made it global

Backend

Added retrieval of Adjustments for Estimated awards
Updated DTO structure
Exposed ECertGenerationService in e-cert-integration.module.ts

Screenshots

Pending (Ministry)

Completed (Ministry)

Legend

E2E Tests

Updated existing tests to new DTO structure
Added new test cases for Estimated Award Adjustments

…WIP.

Copilot

Pull request overview

This PR reorganizes the Award Table layout to combine Estimated and Final awards into a single unified view, updates the DTO structure to use structured objects instead of dynamic properties, adds the ability to retrieve adjustments for Estimated awards based on overawards and restrictions, and makes the ChipLabel component globally available.

Changes:

Restructured award data from dynamic key-value pairs to structured DTOs with explicit properties for disbursement schedules and values
Added new logic to calculate and display adjustments (restrictions, overawards, disbursed amounts) for both estimated and final awards
Made ChipLabel component global and created new StatusChipDisbursement component
Updated all e2e tests to match the new DTO structure and added test coverage for estimated award adjustments

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
sources/packages/web/src/types/contracts/institution/ConfirmationOfEnrollment.ts	Added ReadyToSend disbursement status enum value
sources/packages/web/src/types/contracts/Assessment.ts	Replaced dynamic award structure with structured types for adjustments and award data
sources/packages/web/src/services/http/dto/Assessment.dto.ts	Updated frontend DTOs to match new structured response format
sources/packages/web/src/main.ts	Registered ChipLabel component globally
sources/packages/web/src/composables/useDisbursement.ts	Added composable to map disbursement status to badge display details
sources/packages/web/src/components/generic/*	Updated chip components to support new statuses and made ChipLabel global
sources/packages/web/src/components/common/students/applicationDetails/*	Updated award display components to use new structured data
sources/packages/web/src/components/common/AwardTable.vue	Completely reorganized to combine estimated and final awards in a single table
sources/packages/web/src/components/common/AssessmentAwardDetails.vue	Simplified to delegate to AwardTable component
sources/packages/web/src/assets/css/base.scss	Added error chip background styling
sources/packages/backend/libs/integrations/src/esdc-integration/e-cert-integration/e-cert-integration.module.ts	Added ECertGenerationService to module providers
sources/packages/backend/apps/api/src/route-controllers/institution-user/institution-user.institutions.controller.ts	Commented out BCeID service code
sources/packages/backend/apps/api/src/route-controllers/assessment/models/assessment.dto.ts	Updated backend DTOs to use structured classes instead of dynamic types
sources/packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts	Refactored to populate structured award data and calculate estimated adjustments
sources/packages/backend/apps/api/src/route-controllers/assessment/tests/e2e/*	Updated all e2e tests for new DTO structure and added tests for estimated adjustments

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

.../assessment/_tests_/e2e/assessment.students.controller.getAssessmentAwardDetails.e2e-spec.ts

.../apps/api/src/route-controllers/institution-user/institution-user.institutions.controller.ts

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

sources/packages/web/src/components/common/AwardTable.vue

.../apps/api/src/route-controllers/institution-user/institution-user.institutions.controller.ts

sources/packages/web/src/components/common/AssessmentAwardDetails.vue

github-actions · 2026-02-05T21:22:20Z

E2E Workflow Workers Coverage Report

Totals
Statements:	75.41% ( 1055 / 1399 )
Methods:	79.31% ( 115 / 145 )
Lines:	78.79% ( 769 / 976 )
Branches:	61.51% ( 171 / 278 )

github-actions · 2026-02-05T21:25:22Z

E2E Queue Consumers Coverage Report

Totals
Statements:	85.68% ( 1616 / 1886 )
Methods:	85% ( 187 / 220 )
Lines:	88.64% ( 1287 / 1452 )
Branches:	66.36% ( 142 / 214 )

github-actions · 2026-02-05T21:26:28Z

E2E SIMS API Coverage Report

Totals
Statements:	77.57% ( 8950 / 11538 )
Methods:	76.96% ( 1049 / 1363 )
Lines:	81.66% ( 6496 / 7955 )
Branches:	63.29% ( 1405 / 2220 )

weskubo-cgi · 2026-02-06T01:31:17Z

sources/packages/web/src/components/generic/ChipLabel.vue

          return "success-shade";
        case StatusChipTypes.Warning:
          return "warning-shade";
+        case StatusChipTypes.Error:


The updates to support StatusChipTypes.Error should be safe for existing code as Error isn't used.

weskubo-cgi · 2026-02-06T01:31:53Z

sources/packages/web/src/main.ts

    .component("ErrorSummary", ErrorSummary)
    .component("ChipStatus", ChipStatus)
    .component("ChipTag", ChipTag)
+    .component("ChipLabel", ChipLabel)


It made sense to make this a global component in line with ChipStatus and ChipTag.

weskubo-cgi · 2026-02-06T01:32:39Z

sources/packages/web/src/types/contracts/institution/ConfirmationOfEnrollment.ts

 * Indicates if the money amount information was already
 * sent to be paid to the student.
 */
 export enum DisbursementScheduleStatus {


I don't like the location of this enum but didn't want to take on any additional changes with this PR.

Feel free to add a "TODO" to move to a better location.

andrewsignori-aot · 2026-02-06T19:18:27Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

-      index++;
+    const disbursement = new AwardDisbursementScheduleAPIOutDTO();
+
+    disbursement.disbursementDate = getDateOnlyFullMonthFormat(


The preference for these values would be to have them returned from the API as Date (unless date-only), and the format be applied in the UI.

sh16011993 · 2026-02-06T19:21:22Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

+    let firstEligibleDisbursement: EligibleECertDisbursement;
+    let secondEligibleDisbursement: EligibleECertDisbursement;


Suggestion: Can be a single statement

let firstEligibleDisbursement: EligibleECertDisbursement, secondEligibleDisbursement: EligibleECertDisbursement;

andrewsignori-aot · 2026-02-06T19:25:26Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

+      if (disbursement.status === DisbursementScheduleStatus.Pending) {
+        // Estimated Award - calculate estimated adjustments.
+
+        // Restriction: If the student has a restriction that impacts funding, flag the adjustment.)


The parenthesis seems to be lost at the end of the sentence.

andrewsignori-aot · 2026-02-06T19:35:35Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

+  ECertGenerationService,
+  EligibleECertDisbursement,
+} from "@sims/integrations/services";
+import { getStopFundingTypesAndRestrictionsMap } from "@sims/integrations/services/disbursement-schedule/e-cert-processing-steps/e-cert-steps-utils";


Please add this file to the index inside the e-cert-processing-steps or maybe into the services folder.

andrewsignori-aot · 2026-02-06T19:39:19Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

    );
-    const finalAward =
-      await this.populateDisbursementFinalAwardsValues(assessment);
+    let secondDisbursement;


There is a minor warning stating this variable has an implicit type of any.
As a general rule, it would be better to have it typed during its declaration.

Missed that one, thanks.

andrewsignori-aot · 2026-02-06T19:42:03Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

      institutionName:
        assessment.offering.educationProgram.institution.operatingName,
      offeringIntensity: assessment.offering.offeringIntensity,
      offeringStudyStartDate: getDateOnlyFormat(


Outside PR changes, the getDateOnlyFormat is no longer required for studyStartDate and studyEndDate.
They were required way in the past, but not anymore.

andrewsignori-aot · 2026-02-06T19:45:16Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

+        });
+    }
+
+    const firstDisbursement = await this.populateAwardDisbursement(


The calls can be executed in parallel as below.

const [firstDisbursement, secondDisbursement] = await Promise.all([ this.populateAwardDisbursement( firstDisbursementSchedule, firstEligibleDisbursement, assessment.application.student.id, { includeDocumentNumber, includeDateSent, maskMSFAA }, ), secondDisbursementSchedule ? this.populateAwardDisbursement( secondDisbursementSchedule, secondEligibleDisbursement, assessment.application.student.id, { includeDocumentNumber, includeDateSent, maskMSFAA }, ) : null, ]);

andrewsignori-aot · 2026-02-06T19:50:23Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

-    const finalAward: DynamicAwardValue = {};
-    disbursementValues.forEach((award) => {
-      if (award.valueType === DisbursementValueType.BCTotalGrant) {
+      if (eligibleDisbursement) {


Is there a scenario where the eligibleDisbursement would not be present? If yes, should the parameter be declared as

eligibleDisbursement: EligibleECertDisbursement | undefined,

If it is mandatory and present, it also has the studentId available.

I believe this comment helps answer the question: it may not be present if the disbursement is no longer pending.

andrewsignori-aot · 2026-02-06T19:58:40Z

.../packages/backend/apps/api/src/route-controllers/assessment/assessment.controller.service.ts

+        DisbursementScheduleStatus.Pending
+    ) {
+      [firstEligibleDisbursement, secondEligibleDisbursement] =
+        await this.eCertGenerationService.getEligibleDisbursements({


The getEligibleDisbursements has the following condition, which enforces that only eligible disbursements to create an e-Cert will be considered. When an application has two disbursements and the first one is sent, this method will start to return only one record that will represent the second disbursement, which will be wrongly associated with the firstEligibleDisbursement, also making the secondEligibleDisbursement null.

.where( "disbursementSchedule.disbursementScheduleStatus = :disbursementScheduleStatus", { disbursementScheduleStatus: DisbursementScheduleStatus.Pending }, )

If the above assumption is right (please validate it), considering that we no longer need the firstEligibleDisbursement once it is sent, we can stop using the array destructuring and execute the association using the disbursement ID. Does it make sense?

andrewsignori-aot · 2026-02-06T20:19:53Z

sources/packages/web/src/services/http/dto/Assessment.dto.ts

-  finalAward?: DynamicAwardValue;
+  firstDisbursement: AwardDisbursementScheduleAPIOutDTO;
+  secondDisbursement: AwardDisbursementScheduleAPIOutDTO;
+}


Please add a blank line, following the file pattern.

andrewsignori-aot · 2026-02-06T21:07:41Z

sources/packages/backend/apps/api/src/route-controllers/assessment/models/assessment.dto.ts

-  })
-  finalAward?: DynamicAwardValue;
+  firstDisbursement: AwardDisbursementScheduleAPIOutDTO;
+  secondDisbursement: AwardDisbursementScheduleAPIOutDTO;


secondDisbursement should be nullable, unless I am missing something.

andrewsignori-aot · 2026-02-06T21:09:23Z

sources/packages/backend/apps/api/src/route-controllers/assessment/models/assessment.dto.ts

+  msfaaCancelledDate: string;
+  msfaaDateSigned: string;


These should be nullable, same for enrolmentDate.

andrewsignori-aot · 2026-02-06T21:20:43Z

sources/packages/web/src/components/common/AssessmentAwardDetails.vue

-    >
-      First disbursement
-    </h3>
+  <div>


Is there a need to use div + v-row? Would the below not work in the same way?

<template> <content-group> <award-table ... /> </content-group> <content-group v-if="isSecondDisbursementAvailable"> <award-table ... /> </content-group> </template>

Not required. This was older code I should have removed.

andrewsignori-aot · 2026-02-06T21:25:38Z

sources/packages/web/src/components/common/AwardTable.vue

+        <tbody>
+          <tr v-for="award in awards" :key="award.awardType">
+            <td>
+              <span v-if="$vuetify.display.smAndDown">


Can we use the below instead if that achieves the same?

const { mobile: isMobile } = useDisplay();

andrewsignori-aot · 2026-02-06T21:32:55Z

sources/packages/web/src/components/common/AwardTable.vue

+      <span class="label-bold">Earliest date of disbursement: </span>
+      <span>{{ dateOnlyLongString(disbursement.disbursementDate) }}</span>
+    </div>
+    <div v-if="isDisbursementCompleted && disbursement.documentNumber">


Minor, even if it was named as such before, it may be misleading. I would recommend naming it something more specific to the COE completion, for instance, isCOECompleted.
Either way, the disbursement.documentNumber would also be enough as a condition to display it.

andrewsignori-aot · 2026-02-06T21:33:51Z

sources/packages/web/src/components/common/AwardTable.vue

+    />
+  </div>
+
+  <div></div>


Is this div a leftover?

andrewsignori-aot · 2026-02-06T21:38:35Z

sources/packages/web/src/components/common/AwardTable.vue

+    const { currencyFormatter, dateOnlyLongString } = useFormatters();
+
+    // Associate disbursement values with their award types.
+    const awards: AssessmentAwardData[] = awardTypes.value.map((award) => {


The awards variable is based on a computed property awardTypes but it is not defined to be reactive/computed. Is there any reason not have the awards as a computed variable?

andrewsignori-aot · 2026-02-06T21:41:15Z

sources/packages/web/src/components/common/AwardTable.vue

+        hasDisbursedAdjustment:
+          disbursementValue?.hasDisbursedAdjustment ?? false,
+        hasRestrictionAdjustment:
+          disbursementValue?.hasRestrictionAdjustment ?? false,
+        hasNegativeOverawardAdjustment:
+          disbursementValue?.hasNegativeOverawardAdjustment ?? false,
+        hasPositiveOverawardAdjustment:
+          disbursementValue?.hasPositiveOverawardAdjustment ?? false,


If the intention of having the AssessmentAwardData is to serve as a model for the UI, the transformation expected to provide the data to the component assessment-award-adjustments can be executed at this moment.

andrewsignori-aot · 2026-02-06T21:55:28Z

...lers/assessment/_tests_/e2e/assessment.aest.controller.getAssessmentAwardDetails.e2e-spec.ts

-            disbursementReceipt2bgpd: 800,
-            disbursementReceipt2sbsd: 900,
-          },
+        .then((response) => {


Is there a problem keeping the previous syntax as below (and removing the expect.arrayContaining)?

.expect(HttpStatus.OK) .expect({ applicationNumber: application.applicationNumber,

I noticed many tests changed in this way. Was there a benefit in changing it?

Tests were behaving unpredictably due to the changing order of nested objects (disbursement values) in the array. This was the only way to test the values content irrespective of order. I could add a sort to the API if you prefer but it isn't needed by web.

It is not a matter of preference; from a project perspective, the idea is to test as much as possible, as accurately as possible. If I am not wrong, the arrayContaining would allow more items to be returned in the array, and the test would still pass.
We should not change PROD code in favor of E2E tests, but adding the sort for the awards and ensuring the query will always be returned in the same way would not be so bad in this scenario.

andrewsignori-aot · 2026-02-06T21:58:30Z

...lers/assessment/_tests_/e2e/assessment.aest.controller.getAssessmentAwardDetails.e2e-spec.ts

Can we have one scenario for when an application has two disbursements, where the first disbursement is sent and the second one is pending?

andrewsignori-aot

Great work, and it is amazing to see how much the summary page has changed. Please take a look at the comments.

sh16011993 · 2026-02-06T23:14:57Z

sources/packages/web/src/components/common/students/applicationDetails/AssessmentAward.vue

-    title="Funding summary"
-    sub-title="Below is the summary from your assessment. To view your Notice of Assessment, click on view assessment."
+  <toggle-content
+    :toggled="!assessmentAwardData.firstDisbursement"


When will the firstDisbursement be evaluated to false here? New instance of a class intiatialized with the new keyword will evaluate to true always even if the object is empty. Since, it is populated using teh below in the backend, I believe it will never evaluate to false.

const disbursement = new AwardDisbursementScheduleAPIOutDTO();

sh16011993

Great work @weskubo-cgi 👍

weskubo-cgi added 3 commits January 29, 2026 17:23

Initial UI only updates.

9e72d6e

Initial updates for migration to new data format. Some changes are a …

a9502ff

…WIP.

E2E test updates. Starting integrating restrictions.

f86c3a6

weskubo-cgi marked this pull request as draft February 3, 2026 22:12

E2E test updates. Cleaned up Disbursement status. Made ChipLabel global.

8e58067

weskubo-cgi self-assigned this Feb 4, 2026

weskubo-cgi added 2 commits February 4, 2026 16:58

UI updates based on latest AC. Fixed test instability.

bc8a1ad

Added test for bypassed restriction.

9d03fbd

weskubo-cgi marked this pull request as ready for review February 5, 2026 01:50

weskubo-cgi requested a review from Copilot February 5, 2026 01:51

Copilot started reviewing on behalf of weskubo-cgi February 5, 2026 01:51 View session

weskubo-cgi removed the Complex More advanced issue and needs special attention. label Feb 5, 2026

Copilot AI reviewed Feb 5, 2026

View reviewed changes

Reverted erroneous commit. Added missed commit.

ae73816

weskubo-cgi changed the title ~~#5569 - Finding Summary Reorganization~~ #5569 - Funding Summary Reorganization Feb 5, 2026

weskubo-cgi commented Feb 6, 2026

View reviewed changes

andrewsignori-aot reviewed Feb 6, 2026

View reviewed changes

sh16011993 reviewed Feb 6, 2026

View reviewed changes

andrewsignori-aot reviewed Feb 6, 2026

View reviewed changes

sh16011993 reviewed Feb 6, 2026

View reviewed changes

sh16011993 approved these changes Feb 7, 2026

View reviewed changes

		let firstEligibleDisbursement: EligibleECertDisbursement;
		let secondEligibleDisbursement: EligibleECertDisbursement;

Conversation

weskubo-cgi commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Frontend

Backend

Screenshots

Pending (Ministry)

Completed (Ministry)

Legend

E2E Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 5, 2026

E2E Workflow Workers Coverage Report

Uh oh!

github-actions bot commented Feb 5, 2026

E2E Queue Consumers Coverage Report

Uh oh!

github-actions bot commented Feb 5, 2026

E2E SIMS API Coverage Report

Uh oh!

weskubo-cgi Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

weskubo-cgi commented Feb 3, 2026 •

edited

Loading

weskubo-cgi Feb 6, 2026 •

edited

Loading

andrewsignori-aot Feb 6, 2026 •

edited

Loading

andrewsignori-aot Feb 6, 2026 •

edited

Loading

andrewsignori-aot Feb 6, 2026 •

edited

Loading

andrewsignori-aot Feb 6, 2026 •

edited

Loading