Tenancies: list

Return information about all tenancies in a company.

Request - GET https://api-uat.vtopenview.com/tenancies

DO NOT supply a request body and a request parameter with this method.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- GET Base URI: https://api-uat.vtopenview.com/tenancies
--header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Response

If successful, this method returns a response body with the following structure:

Example response:

HTTPS 200 OK
Content-Type: application/json
{
"tenancies": [
{
"tenancyid": long,
"reference": "string",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"archived": boolean,
"archivedDate": "date",
"prebooked": boolean,
"rent": decimal,
"deposit": decimal,
"holdingdeposit": decimal,
"collectionday": "string",
"nextrentdue": "date",
"rentperiod": "string",
"occupation": "string",
"employer": "string",
"ninumber": "string",
"agreementname": "string",
"renttype": "string",
"autorentinvoice": boolean,
"usealternateaddress": boolean,
"housingbenefit": boolean,
"casenumber": "string",
"hbchargedahead": boolean,
"hbchargedarrears": boolean,
"contactnotes": "string",
"property": [
{
"propertyid": long,
"address": [
{
"houseno": "string",
"address1": "string",
"address2": "string",
"town": "string",
"county": "string",
"postcode": "string",
"latitude": decimal,
"longitude": decimal,
"geocodingverified": boolean,
"countryname": "string",
"countrydisplayname": "string",
"fulladdress": "string",
"shortaddress": "string"
}
]
}
],
"tenancyAddedDate": "date",
"tenancyModifiedDate": "date",
"tenancystart": "date",
"tenancyend": "date",
"renewalstart": "date",
"vacatingdate": "date",
"visitnextdue": "date",
"leaseperiod": "string",
"relocationagent": "string",
"agreementname": "string",
"agreementsigned": boolean,
"followup": boolean,
"notes": "string",
"breakclause": "string",
"noticenotes": "string",
"primarytenant": [
{
"tenantid": long,
"name": "string",
"email": "string",
"rent": decimal,
"deposit": decimal,
"initialrent": decimal,
"finalrent": decimal,
"totalrent": decimal,
"rentperiod": "string",
"collectiondate": "date",
"nextrentdue": "date",
"rentreview": "date",
"thereafter": integer,
"inccharge": decimal,
"erv": decimal,
"ervvariance": decimal,
}
],
"tenants": [
{
"tenantid": long,
"name": "string",
"email": "string",
"address": "string",
"primarytenant": boolean,
"archived": boolean,
}
],
"compliance": {
"section21": {
"section21served": boolean,
"servedby": "string",
"servednotes": "string",
"lanoticeserved": boolean,
"lanoticeservednotes": "string",
},
"depositprotection": {
"scheme": "string",
"heldby": "string",
"reference": "string",
"transferred": boolean,
"depositregistered": boolean,
"tenantnotified": boolean,
"remind": boolean,
}
},
"information": {
"housingbenefit": {
"usehousingbenefit": boolean,
"nextrentdue": "date",
"rent": decimal,
"rentperiod": "string",
"arrears": boolean,
"ahead": boolean,
"notes": "string",
}
}
}
]
}