bcgov / bcgov/entity

Legal API - update filings dictionary to allow retrieval of dissolution filing info(fee code etc) by dissolution type

Open
#12,684 1 comment 0 reactions 0 assignees View on GitHub
ENTITY - DO NOT USE Priority2 techdebt
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

This ticket was created when doing work on #12614(PR: https://github.com/bcgov/lear/pull/1561). Reference resolved comment in PR for original conversation.

To retrieve a fee code for an administrative dissolution, we needed to create a special case instead of using the existing pattern of using the `FILINGS` dictionary to retrieve the fee code. It was decided that this refactoring would be done in this ticket as implementing support for sub types(dissolution type) might break existing voluntary dissolution functionality. Note that there is some code in the COLIN API that deals with the dissolution type in a more generic fashion that can likely be leveraged.

**TODOs**
- [ ] update dissolution block in FILINGS dictionary of filings model to support different dissolution types(voluntary, administrative etc). COLIN API has an implementation that can be referenced at https://github.com/bcgov/lear/blob/a0f4262f463187a8ea59c7b49cd8f969a09d141b/colin-api/src/colin_api/models/filing.py#L126-L137 and https://github.com/bcgov/lear/blob/a0f4262f463187a8ea59c7b49cd8f969a09d141b/colin-api/src/colin_api/models/filing.py#L240-L247.
- [ ] update existing code for dissolutions that reference FILINGS dictionary to use updated dissolution block in FILINGS dictionary
- [ ] update tests

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the referenced COLIN API sections in colin-api/src/colin_api/models/filing.py, then locate the FILINGS dictionary and dissolution callers in the filings model. Update the dissolution-related tests and verify that voluntary and administrative dissolution types retrieve their filing information without breaking existing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.