API: Property: Deposit data

[EstateApps]

I am trying to locate the “deposit” value for a rental property via the Foundations property api call but I can not locate anything that looks like it in the swagger documentation or anything concrete in the Github issues about.

This data exists in the Rest version of your API as “DepositAmount”.

Not sure if it is labeled as something else or it is not supported currently.

Specification

• Service: Reapit.Services.Properties
• Add new PropertyLettingsDepositModel to PropertyLettingsModel:

"lettings": {
    "deposit": {
       "type": "weeks/months",
       "amount": 6
    }
}

or for fixed amounts

"lettings": {
    "deposit": {
       "type": "fixed",
       "amount": 600.0
    }
}

• type tied to prp.extra.pDepType which will be W = weeks, M = months, empty = fixed
• amount tied to prp.extra.pDepReq which should be an integer where type is weeks/months but can be a decimal if fixed
• This should be both readable and writeable
• For write operations, type MUST be one of weeks/months/fixed, amount must be a non-negative number

[AshDeeming]

Hi @EstateApps This isn't currently surfaced - I'll convert this to a ticket for our backend team to review as a feature request.

[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