32211: Currency validation

[loneil]

Issue #: /bcgov/entity#32211

Description of changes:

Adds support for the legacy OTHER currency type on share classes migrated from COLIN and validates that currency values match recognized currency codes.

• Additional to OTHER type handling, currency validation was previously just done on UI and missing from API (tracked in previous FE/BE validation mismatch analysis and left to this point to handle)

Model

• Return currencyAdditional in ShareClass.json so UIs can display the OTHER currency text

Validation (validate_share_currency)

-Validate that share class currency is a recognized currency code (matching the standard currency list used by the UI dropdowns), only when hasParValue is true
-Grandfathered OTHER share classes pass through when the incoming share class ID matches an existing OTHER record in the DB — this handles the round-trip scenario where an alteration payload includes unchanged OTHER classes alongside modified non-OTHER classes
-New series under grandfathered OTHER share classes are blocked

Filing coverage

• Alteration, Correction, Transition: pass business for ID matching (allows existing OTHER pass-through)
• Incorporation Application, Continuation In, Amalgamation (regular): no business context, all currencies must be valid

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the lear license (Apache 2.0).

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull request overview

Adds backend enforcement for share class currency validation (ISO 4217) and supports round-tripping legacy OTHER currency share classes migrated from COLIN by exposing currencyAdditional and grandfathering existing OTHER records in certain filing contexts.

Changes:

• Add currencyAdditional to ShareClass.json for API consumers (UI) to display legacy OTHER currency text.
• Introduce validate_share_currency and wire it into multiple filing validation flows (IA, Continuation In, Amalgamation Application, Alteration, Correction, Transition).
• Add unit tests covering ISO validation, OTHER grandfathering rules, and series-blocking under OTHER.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
legal-api/src/legal_api/services/filings/validations/common_validations.py	Adds validate_share_currency plus helper functions for ISO validation and legacy OTHER grandfathering.
legal-api/src/legal_api/services/filings/validations/incorporation_application.py	Invokes share currency validation for corps during IA validation.
legal-api/src/legal_api/services/filings/validations/continuation_in.py	Invokes share currency validation for continuation-in filings.
legal-api/src/legal_api/services/filings/validations/amalgamation_application.py	Invokes share currency validation for regular amalgamations.
legal-api/src/legal_api/services/filings/validations/alteration.py	Invokes share currency validation in alteration share structure validation flow (with business context).
legal-api/src/legal_api/services/filings/validations/correction.py	Invokes share currency validation for corp corrections (with business context).
legal-api/src/legal_api/services/filings/validations/transition.py	Invokes share currency validation for transition filings (with business context).
legal-api/src/legal_api/models/share_class.py	Extends ShareClass.json to include currencyAdditional.
legal-api/tests/unit/services/filings/validations/test_common_validations.py	Adds direct unit tests for validate_share_currency (ISO, OTHER behavior, series rules).
legal-api/tests/unit/services/filings/validations/test_incorporation_application.py	Adds a test asserting IA runs share currency validation through the full validate() path.
legal-api/tests/unit/models/test_share_class.py	Updates/extends model json tests for currencyAdditional.
legal-api/tests/unit/models/test_share_series.py	Updates expected share class json payload in series-related model tests to include currencyAdditional.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Rajandeep98]

lgtm