Select any of the web services below to view details and examples.
Retrieves lease or application information. By default, this webservice returns leases that are in Current and Notice lease status. This endpoint is paginated, for pagination details check the response headers.
*propertyId [Integer] | This is a required field. This field accepts single value. |
applicationId [Integer] | This is an optional field. This field accepts single value. |
customerId [Integer] | This is an optional field. This field accepts single value. |
leaseStatusTypeIds [Integer] | This is an optional field. This field accepts comma seperated multiple values. |
leaseIds [Integer] | This is an optional field. This field accepts comma seperated multiple values. |
eventTypeIds [Integer] | This is an optional field. This field accepts comma seperated multiple values. |
scheduledArCodeIds [Integer] | This is an optional field. This field accepts comma seperated multiple values. |
unitNumber [String] | This is an optional field. This field accepts single value. |
buildingName [String] | This is an optional field. This field accepts single value. |
moveInDateFrom [Date] | This is an optional field. This field accepts single value. |
moveInDateTo [Date] | This is an optional field. This field accepts single value. |
eventDateFrom [Date] | This is an optional field. This field accepts single value. |
eventDateTo [Date] | This is an optional field. This field accepts comma seperated multiple values. |
leaseExpiringDateFrom [Date] | This is an optional field. This field accepts single value. |
leaseExpiringDateTo [Date] | This is an optional field. This field accepts single value. |
moveOutDateFrom [Date] | This is an optional field. This field accepts single value. |
moveOutDateTo [Date] | This is an optional field. This field accepts single value. |
includeOtherIncomeLeases [Boolean] | This is an optional field. This field accepts single value. |
residentFriendlyMode [Boolean] | This is an optional field. This field accepts single value. |
includeLeaseHistory [Boolean] | This is an optional field. This field accepts single value. |
includeArTransactions [Boolean] | This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease. |