Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Request - Partner Current Year Income (financial information) option #3620

Closed
16 tasks done
Joshua-Lakusta opened this issue Aug 8, 2024 · 0 comments
Closed
16 tasks done

Comments

@Joshua-Lakusta
Copy link
Collaborator

Joshua-Lakusta commented Aug 8, 2024

As a student I want to request the use of my partner/spouses current year income. This is important as it is a calculation impacting field and the ability to request the use of estimated current year income is a policy requirement.

Acceptance Criteria

  • Add a new question to the Partner Information and Income to allow students to submit partner income for the current year. This question is only relevant if they have selected Married/common-law

  • New question will have 2 radio options yes or no (this question will appear below the basic income declaration question for a partner.
    Content:

Do you want to declare your partner's estimated current year income? (If your spouse/common-law partner has had, or anticipates having a significant decrease in income for "YEAR", you may request to be assessed using your spouse/common-law partner's estimated income.)

  • Replace "YEAR" with dynamic outcome with following logic:

YEAR = (dynamic year = to first year in program year (2023-2024 would be 2023))

  • If no is selected do nothing additional

  • If yes is selected expand to add an estimated income field, reasons for use of estimated income, and document uploader (this mirrors the way the student declares estimated income)

  • Under Supporting Information Header the content should be:

Add your spouse/common-law partner's actual income from the beginning of the calendar year up to the date of their income change and the estimated income for the remainder of that calendar year to calculate your total current year income.

  • Add income entry field that will represent a new value to be created and named by dev doing the ticket

  • Income field should follow the same rules as the estimated student income version

  • Heading above the income entry field should state:

My spouse/common-law partner's current year income is:

  • There needs to be a section for the reasons for change in estimated income with five options and only one can be selected

Content:

Select the reason for your spouse/common-law partner's significant decrease in income:

  • Medical illness or injury
  • Family emergency (e.g., death or injury)
  • Natural Disaster
  • Layoff, strike, lockout or other reduction in earnings beyond the family's control
  • Other
  • Add content for uploader content for documentation for uploader:

Upload supporting documents for spouse/common-law partner's "DYNAMIC YEAR" estimated income.
Please provide supporting documentation for your request to use current year estimated income for your spouse/common law partner.
Provide the following:

A letter explaining the circumstances that meet one or more of the Criteria (see above)
Provide at least one of the following:

All relevant supporting documentation of the circumstance(s) (medical records, letter from the physician, record of employment, layoff or strike, invoices from damages, etc.).
The most recent CRA Income Tax Return and income information for the year matching the student financial assistance application number (with relevant supporting documentation to show the decrease in income), if available.
All relevant supporting documentation of estimated total income for the year matching the student financial assistance application number, if applicable (pay stubs, invoices, bank statements, Employment Insurance benefit statements, Record of Employment, etc.).

  • Update the camunda flow to reflect new priority list for partner income. The partner "estimated current year" income should be used above all other incomes in the priority list (same as student estimated current year income)

Current

if
  partner1CRAReportedIncome = null
then
  calculatedDataPartner1TotalIncome
else
  partner1CRAReportedIncome

Updated (note studentDataCurrentYearPartnerIncome and does not currently exist is a placeholder name. This value will need to be produced by appeals process. Replace if desired.) Codes are reference only but need to be reviewed and adjusted during development

if 
studentDataCurrentYearPartnerIncome = null
then
	if
               partner1CRAReportedIncome = null
       then
              calculatedDataPartner1TotalIncome
       else
              partner1CRAReportedIncome

else
studentDataCurrentYearPartnerIncome

image.png

  • Update change request/appeal pathing to reflect new option to use above noted new value at the top of the priority list. Should allow for override of the data to reflect that above calculations identical to how estimated current year income for student was handled.

Additional Context
Use this as a generic layout reference but true content is in the information above.
image.png

Technical

@Joshua-Lakusta Joshua-Lakusta self-assigned this Aug 8, 2024
@Joshua-Lakusta Joshua-Lakusta added the Business Items under Business Consideration label Aug 8, 2024
@Joshua-Lakusta Joshua-Lakusta added Dev & Architecture Development and Architecture and removed Business Items under Business Consideration labels Sep 10, 2024
@CarlyCotton CarlyCotton changed the title Partner financial information change request current year income option Change Request - Partner Current Year Income (financial information) option Oct 1, 2024
@andrewsignori-aot andrewsignori-aot removed the Dev & Architecture Development and Architecture label Oct 1, 2024
@lewischen-aot lewischen-aot self-assigned this Oct 10, 2024
github-merge-queue bot pushed a commit that referenced this issue Oct 23, 2024
…mation) option (#3799)

- Added a new question to the Partner Information and Income to allow
students to submit partner income for the current year.
- Replaced "YEAR" with dynamic outcome with following logic:
- Updated the Camunda workflow to reflect new priority list for partner
income.
- Moved the "Define partner income" in the workflow after the appeals to
use the appeals' calculated variables
- Converted the current logic inside "Define Partner Income" to a flow 
- Created E2E tests for partner current year income.
- For API: "Should save the current year partner income when the student
submits an appeal for the current year partner income."
- For workflow: "Should calculate partner income as current year partner
income value when there is a request a change for current year partner
income."

Screenshots of current year partner income UI

![image](https://github.com/user-attachments/assets/fe5b22e0-be24-48af-80b5-78048386762e)


![image](https://github.com/user-attachments/assets/0de431e0-a3d6-46c8-aa16-9a3246fd1aa7)

Screenshot of Camunda workflow

![image](https://github.com/user-attachments/assets/20db3de1-a8c4-4d65-93c9-5c7cdf5c5a8c)
github-merge-queue bot pushed a commit that referenced this issue Oct 23, 2024
…mation) option (Quick Fix) (#3820)

- Modified `maxMoneyValue` in Form.io definition
"partnerinformationandincomeappeal.json" to fix the backend error due to
failure in Form.io dryRun validation in my previous while submitting an
appeal.
  - Unchecked "table view"
  - Checked "Calculate on server"

Screenshot of backend error due to Form.io definition

![image](https://github.com/user-attachments/assets/f1e3fd44-eb05-40c3-99da-83d0c9e58066)

Screenshot of successful backend log with the current change 

![image](https://github.com/user-attachments/assets/312aaf9e-de9e-4fed-9906-da5ea7e129a2)
github-merge-queue bot pushed a commit that referenced this issue Oct 24, 2024
…mation) option (Fix Duplicate Markup) (#3834)

Fixed duplicates of the markup content in the Upload Document panel in
the Form.io file.

Screenshot of the markup content before the fix

![image](https://github.com/user-attachments/assets/63ce1efa-7752-448b-af86-2b686d8e6fcd)

Screenshot of the markup content after the fix

![image](https://github.com/user-attachments/assets/4d66ed59-21e5-4491-b966-f4188aa4808a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants