v1

latestSwagger 2.02026-07-14453366.1 KB
LettingsController

Get a specific tenancy given its unique Object ID (OID)

get/v2/tier2/{shortName}/lettings/tenancies/{tenancyID}

Path parameters

shortNamestring required

The unique client short-name

tenancyIDstring required

The unique ID of the Tenancy

Response

OK

AdvertiseFromstring date-time

The date to advertise this tenancy from.

Areastring

The area containing the instruction.

BondRequirednumber double

The total bond required.

Branchstring

The branch the tenancy is assigned to..

ETagstring

A unique identifier defining the object and change revision.

Furnished'Unfurnished' | 'PartFurnished' | 'Furnished'

The property furnished type.

GlobalReferencestring

The global reference for a tenancy.

IsSharePropertyboolean

Is this property a shared property.

IsStudentPropertyboolean

Is this property a student property.

IsTenancyAdvertisedboolean

Gets a value indicating whether this tenancy is being advertised. Note that this will only return true while the tenancy has a valid advertise date. It will not return true in the proposed phase.

IsTenancyProposedboolean

Is the tenancy a proposed tenancy?

MaximumTenantsinteger

The maximum number of tenants to advertise for.

MinimumTenantsinteger

The minimum number of tenants to advertise for.

OIDstring

The unique Object ID (OID).

RentAdvertisednumber double

The advertised amount of rent for the property.

RentRecurrenceinteger

The rent schedule recurrence

RentSchedule'Once' | 'Daily' | 'Weekly' | 'Monthly' | 'Yearly'

The tenancy rent schedule

TenancyPropertystring

The property linked to this tenancy.

TenantSystemTypesstring[]

The specific tenant type list, or empty if for all types.

TermMaximuminteger

The instruction maximum term.

TermMinimuminteger

The minimum term.

TermStartstring date-time

The instruction start date.

UtilityCouncilTax'Tenant' | 'Landlord'

Who's responsible for council tax bills.

UtilityElectricity'Tenant' | 'Landlord'

Who's responsible for electricity bills.

UtilityGas'Tenant' | 'Landlord'

Who's responsible for Gas bills.

UtilityTelephone'Tenant' | 'Landlord'

Who's responsible for telephone bills.

UtilityWater'Tenant' | 'Landlord'

Who's responsible for water bills.