Include Journal Entries of Type = BC in GET /journalEntries/

[MatthewGoddard]

We have been asked by clients to trigger landlord communications when a Journal Entry of type BC (Bank Detail Change) occurs.

Use the 'Type' parameter against GET /journalEntries/ to return those that equal BC

Specification

• Project: Reapit.Services.JournalEntries
• New endpoint GET /journalEntries/landlords
• Scoped to journalentries.read
• Query string parameters:
  • pageSize/pageNumber
  • landlordId[]
  • propertyId[]
  • negotiatorId[]
  • type (mandatory)
  • createdFrom/createdTo
• New enum for mapping journal entry database types to something more friendly (we'll need to have the full enum here, not just bank detail changes). Watch out for type of DC which is used for multiple purposes. Type should also offer map back to the respective table in the database (bank detail changes for landlords in jnlmisc, and so on)
• New LandlordJournalEntryModel

{
      "created": "2019-01-25T15:44:28Z",
      "propertyId": "OXF190022",
      "landlordId": "LLD240001",
      "type": "bankDetailChange",
      "negotiatorId": "JAS",
      "description": "Mr John Smith contacted us via live chat regarding 62 Test Road",
      "_links": {
        "negotiator": {
          "href": "/negotiators/JAS"
        },
        "property": {
          "href": "/properties/OXF190022"
        },
        "landlord": {
          "href": "/landlords/LLD240001"
        }
      }
    }

[github-actions[bot]]

Thank you for raising a feature request. Feature requests will be prioritised in accordance with our roadmap, customer and developer priorities. This request will be reviewed in our weekly refinement sessions and assigned to a specific project board or column, depending on the nature of the request and the development work required. For more information on our processes, please click here

[plittlewood-rpt]

To discuss location of BC entries with AC Product in the first instance.

[HollyJoyPhillips]

Product meeting arranged for 22/12

[plittlewood-rpt]

There is no plan to do anything with the bank detail journal entries. As a result we should probably look at a breaking change here to force use of certain query string parameters that will allow us to more performantly (hopefully) combine data across tables. To do this requires us to thoroughly test the API versioning mechanism again as it will be the first time we've utilised it. Behavioural changes are OK to do and do not have any impact on things like webhooks as the payloads won't be changing

[plittlewood-rpt]

We need to wait on this until we've fleshed out our versioning strategy as this will be a breaking change

[plittlewood-rpt]

We may be able to address this by hitting jnlmisc AND jnl only when associatedType is landlord. It looks like there is a very limited number of landlord journal entries in the main jnl table which might mean performance is acceptable (though not ideal)

[MatthewGoddard]

Sounds positive, @plittlewood-rpt

[github-actions[bot]]

This issue has been updated and moved to our ‘Near Term’ column (typically completed within 0 - 4 months). We have assessed the effort required and outlined a technical specification - please take the time to review this detail. When we're ready to schedule the issue, it will be assigned to the relevant board where you can continue to track its progress to completion. For more information on our processes, please click here

[RWilcox-Reapit]

Hi @MatthewGoddard

Happy to confirm this work is done now, you should have access to a new journal entries endpoint: GET /journalEntries/landlords

Any issues let me know,

Thanks

[github-actions[bot]]

It looks like you have commented on a closed issue. If your comment relates to a bug or feature request, please open a new issue, and include this issue number/url for reference. For more information on our processes, please click here

[MatthewGoddard]

Amazing - thanks Ryan!

On Wed, 17 Apr 2024 at 16:40, RWilcox-Reapit @.***> wrote:

Hi @MatthewGoddard https://github.com/MatthewGoddard

Happy to confirm this work is done now, you should have access to a new journal entries endpoint: GET /journalEntries/landlords

Any issues let me know,

Thanks

— Reply to this email directly, view it on GitHub https://github.com/reapit/foundations/issues/10231#issuecomment-2061588768, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACNFTHG36QNULW3CECXHBQDY52JVTAVCNFSM6AAAAAA7ZPSAJKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANRRGU4DQNZWHA . You are receiving this because you were mentioned.Message ID: @.***>

[github-actions[bot]]

It looks like you have commented on a closed issue. If your comment relates to a bug or feature request, please open a new issue, and include this issue number/url for reference. For more information on our processes, please click here