v1

latestOpenAPI 3.0.02026-07-14242833.3 KB
LandlordController

Get tenancy details.

get/v2/customer/{shortName}/landlord/tenancy

Path parameters

shortNamestring required

The unique client short-name

Query parameters

tokenstring required

The login token returned from the /session POST call

tenancyIDstring required

The Tenancy ID

Response

OK

ActualEndDatestring date-time

Actual End Date

Bedsinteger

Beds

Bondnumber double

Bond

BranchIDstring

The tenancy branch ID:-

FixedDatestring date-time

Fixed Date

GlobalReferencestring

User Friendly ID

IDstring

ID

ManagedRentboolean

State of the tenancy

PreviousRentAmountnumber double

Previous Rent Amount

PropertyAddressstring

Display Property Address

Rentstring

Rent

RentAmountnumber double

Rent Amount

StartDatestring date-time

Start Date

TenancyPropertystring

Tenancy Property

TenancyStatestring

State of the tenancy

Tenantsstring[]

Tenants