Expose security deposit and deposit holder against tenancy

[LouisaEvosite]

Is your feature request related to a problem? Please describe. Tenancy deposit information to be exposed via the Foundations API

Describe the solution you'd like DepositAmount and DepositHolder to be available on a /tenancies/{id} call or via a new endpoint.

Ideally we'd also like to know how much of the deposit was withheld on a completed tenancy.

Describe alternatives you've considered No other solution would be possible in Foundations. This is exposed via the Webservice so that can be used temporarily.

Specification

• Project: Reapit.Services.Tenancies
• Add TenancyDepositModel to TenancyModel as follows (and associated write models):

"deposit": {
  "amount": 0,
  "heldBy": "landlordsAgent/landlord/depositProtectionScheme/notApplicable"
}

• Amount comes from ten.dpstSum
• heldBy comes from ten.dpstHeld
• Mapping for new DepositHeldBy enum: Us - stakeholder (US), Us - landlord's agent (UL), Landlord (LL), Deposit Protection Scheme (DS), Not Applicable (NA)
• This is for read and write, but we should ensure this information can NOT be changed once a tenancy becomes current

[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

[LouisaEvosite]

Small update- have managed to find a deposit amount in the transactions so that bit is usable although ideally we would just have one deposit against a tenancy.

Could we instead prioritise getting the deposit holder please?

Thanks, Louisa

[github-actions[bot]]

This issue has been updated and moved to our ‘Near Term’ column (typically completed within 1 - 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

[LouisaEvosite]

Hi @RWilcox-Reapit - have had a look and I can see that we now have the deposit fields coming through but none seem to be populated for me yet:

Thanks, Louisa

[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