POST 17.0/app/tenancy/depositoverlegalmax

Description

Checks whether a tenancy deposit exceeds the legally allowed maximum based on the provided tenancy and property details.

URI Parameters

None.

The DepositLegalMaxRequest request containing deposit amount, rent, etc.

DepositLegalMaxRequest
Name Description Type Additional information
Deposit

decimal number

None.
Rent

decimal number

None.
PaymentFrequency

byte

None.
PropertyUsage

byte

None.
PropertyCountryCode

integer

None.
TenancyStartDate

date

None.
IsHoldingDeposit

boolean

None.

application/json, text/json
Sample: 
{
  "deposit": 1.0,
  "rent": 2.0,
  "paymentFrequency": 64,
  "propertyUsage": 64,
  "propertyCountryCode": 5,
  "tenancyStartDate": "2025-10-28T18:04",
  "isHoldingDeposit": true
}

application/xml, text/xml
Sample: 
<DepositLegalMaxRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Deposit>1</Deposit>
  <Rent>2</Rent>
  <PaymentFrequency>64</PaymentFrequency>
  <PropertyUsage>64</PropertyUsage>
  <PropertyCountryCode>5</PropertyCountryCode>
  <TenancyStartDate>2025-10-28T18:04:26.5966602+00:00</TenancyStartDate>
  <IsHoldingDeposit>true</IsHoldingDeposit>
</DepositLegalMaxRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

True if the deposit is permitted to exceed the legal maximum; otherwise, false.

boolean

application/json, text/json
Sample: 
true

application/xml, text/xml
Sample: 
<boolean>true</boolean>