GET 17.0/app/tenancy/{propertyid}/property/{contactid}/contact/existingprepayments

Description

Retrieves the existing pre-payment (unallocated deposit balance) for the specified contact and property.

URI Parameters
Name Description Type Additional information
propertyId

The unique identifier of the property.

 integer

Required
contactId

The unique identifier of the contact (tenant).

 integer

Required

None.

None.

An containing the existing deposit amount.

ExistingPrePaymentItem
Name Description Type Additional information
ExistingDepositAmount

decimal number

None.

application/json, text/json
Sample: 
{
  "existingDepositAmount": 1.0
}

application/xml, text/xml
Sample: 
<ExistingPrePaymentItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ExistingDepositAmount>1</ExistingDepositAmount>
</ExistingPrePaymentItem>