POST 17.0/app/properties/deposit

Description

Calculates the deposit using the passed property information

URI Parameters

None.

Information about the property used in the deposit calculation

DepositCalculationRequest
Name Description Type Additional information
RentAmount

decimal number

None.
PriceFrequency

PriceFrequency

None.
DeductHoldingDepositFrom

DeductHoldingDepositFrom

None.

application/json, text/json
Sample: 
{
  "rentAmount": 1.0,
  "priceFrequency": 0,
  "deductHoldingDepositFrom": 0
}

application/xml, text/xml
Sample: 
<DepositCalculationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RentAmount>1</RentAmount>
  <PriceFrequency>PCM</PriceFrequency>
  <DeductHoldingDepositFrom>Rent</DeductHoldingDepositFrom>
</DepositCalculationRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

DepositCalculation
Name Description Type Additional information
MaxDeposit

decimal number

None.
HoldingDeposit

decimal number

None.
RemainingDeposit

decimal number

None.
FirstRentPayment

decimal number

None.
Total

decimal number

None.

application/json, text/json
Sample: 
{
  "maxDeposit": 1.0,
  "holdingDeposit": 2.0,
  "remainingDeposit": 3.0,
  "firstRentPayment": 4.0,
  "total": 5.0
}

application/xml, text/xml
Sample: 
<DepositCalculation xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MaxDeposit>1</MaxDeposit>
  <HoldingDeposit>2</HoldingDeposit>
  <RemainingDeposit>3</RemainingDeposit>
  <FirstRentPayment>4</FirstRentPayment>
  <Total>5</Total>
</DepositCalculation>