Legal API: return "displayLedger" flag in filings results

[severinbeauvais]

The Legal API needs to return a displayLedger boolean flag for every filing in the filings response. All filings should be True except for:

• admin freeze
• admin unfreeze

Here are the detailed requirements, taken from Argus' comment in #16967:

---

I don't think it will be in the business response if I'm understanding your question correctly.

This flag will be specific to a filing. So the displayLedger flag can be returned in the GET /filings and GET /filings/<filing_id> endpoints I think.

I was thinking just add a dictionary to the BE that defines filings that shouldn't be displayed on the ledger. And these two filing endpoints will just use to set the flag accordingly.

At the end of the day, for our use case, we probably only need to update the GET /filings endpoint.

Examples

GET /filings endpoint

GET /filings/<filing_id> endpoint

[Mihai-QuickSilverDev]

@kzdev420 Hi Kevin, would you be able to help with this back end ticket? This would unblock in turn the front end ticket. Business would like this escalated, so I have brought it into this sprint.
@severinbeauvais @argush3

[kzdev420]

I will do this ticket

[severinbeauvais]

Are we still creating the freeze/unfreeze ledger entries, and simply adding "displayLedger=false"? In that case, the requirements in #16967 need to be updated.

cc @Mihai-QuickSilverDev

[thorwolpert]

We had agreed we wouldn't put anything in the ledger that would then need to be hidden.
All that does is add an item to the FOI request to get the info that is "hidden", making more work for staff in the long run.
I thought adminFreeze was going to be a flag & staff notation, since it doesn't change anything "about the company" and is more often an Account issue.

[Mihai-QuickSilverDev]

@argush3 Hi Argus, I see that this ticket is in Review. What was decided and done on the BE for this? And would the corresponding FE ticket be unlocked now?

[argush3]

A PR has been created but we need to decide what to do with this. Please take a look at Thor's comment above.

[Mihai-QuickSilverDev]

Actually the proposed approach is strongly dictated from the user side. In a majority of cases the freeze would be caused by a missed payment, and businesses have expressed in the past strong opinions on not having ledger entries added that could be considered detrimental to a company's reputation, etc. I have escalated this for resolution and executive decision at the Product Owner and Program Director's level and wll communicate here an abiding decision.

[severinbeauvais]

For the record, the filings endpoint would still provide all items in the ledger, but certain items would have this "display" flag set to False so that the UI wouldn't display them.

I'm not sure if this mitigates the "hidden items need FOI request" concern. And actually, how would users know whether some ledger items are not displayed?

[jdyck-fw]

Dave spoke with Elizabeth who will circle back around this week, when we hope to unblock this.

[jdyck-fw]

Linda will discuss with Thor.

[lmcclung]

I met with Yasmin and we've agreed that the admin freeze/unfreeze actions should not appear in ledger history. Using the bank statement analogy, when the bank sends us a letter or vice versa there isn't anything appearing in the list of ins/outs on our bank statement regarding the correspondence.

At the end of the day, there should be a message in the tombstone that it is frozen. And the comment staff entered should show up in the comments tab.

[thorwolpert]

thanks @lmcclung
there's never supposed to be any "hidden" things on the ledger.

[severinbeauvais]

@thorwolpert , since Freeze and Unfreeze are filings, should we:
a) not serve them at all in the filings response?
b) serve all filings but add a "displayLedger" flag so the UI doesn't show them?

Also, staff are required to add a detail comment to a Freeze/Unfreeze filing. This comment is linked to the filing (not to the business). Since we won't be displaying the filing in the ledger, should the comment be linked to the business instead, or shown in the staff comments section anyway?

PS - Yes, the business response ("tombstone") does indicate when an admin freeze is in place:

[thorwolpert]

When they were presented more than a year ago, it was an admin flag and a staff note, not a filing.
Afaik, they aren't filings in colin. Colin tracks events, so they can show up in the event history.

As stated above, they are often done because of payment issues.
That could be from any number of accounts now that have access to the business, and not a reflection on the business itself. Now, it's more of an account issue, since we changed the paradigm on that entirely.

[severinbeauvais]

@thorwolpert OK, but this is the way they are now. Can you help us figure out what to do?

[jdyck-fw]

@thorwolpert - Mind helping us solutioning this within what you see could work?

[thorwolpert]

sure, but it does seem like it should still be just setting the flag to block a business from being updated and assigning a staff note as to why.
We do that when we alter a BEN to another type and send control back to Colin (Colin does the same when pushing over to the new system).
Can it be changed fairly easily back to that?

[thorwolpert]

With also having more than 1 managing account now, I think the whole freeze/block thing needs a review.
Do we need to notify all affiliated parties?
Like what happens when Account A defaults a payment, should Account B be notified so they can correct it?

[severinbeauvais]

@thorwolpert , the existing code creates a Freeze (and Unfreeze) filing in the ledger. Do we show it? If not, how do you propose we hide it? And if we hide it, how do you propose we show the detail comment in the Staff Comments instead of the Filing Comments?

PS We do set an adminFreeze flag in the business object (tombstone), and we do block further updates (via allowable actions functionality).

[thorwolpert]

If it's in the ledger, then I guess it gets shown.

[severinbeauvais]

Requirements:

• need to have freeze and unfreeze functionality
• need to now show freeze and unfreeze in ledger

Option 1: change freeze and unfreeze to not be filings

Option 2: hide freeze and unfreeze filings in ledger

Based on the feedback from @lmcclung above, and a decision by @davemck513 today, we are going to implement this ticket as documented: we will hide the freeze and unfreeze filings. This ticket is no longer blocked.

[severinbeauvais]

Test Notes

This Legal API change was tested as part of #16967.

More specifically, you can look at the filings network response for a business with an admin freeze (or unfreeze) filing and verify that these filings have "displayLedger: false" while all other filings have "displayLedger: true".