Tenancies: post

Create new Tenancies.

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

You will need to supply a request body 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 -- POST Base URI: https://api-uat.vtopenview.com/tenancies --header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body

Example request body:

Content-Type: application/json { "propertyId": long, "negotiatorId": long, "userBranchId": integer, "userCompanyId": integer, "leaseTypeName": "string", "countryName": "string", "startDate": "datetime", "endDate": "datetime", "liveTenancy": boolean, "depositHeldBy": integer, "depositRegistered": boolean, "depositRegisteredOn": "datetime", "depositProtectionReference": "string", "depositProtectionTransferred": boolean, "depositProtectionTransferredDate": "datetime", "depositProtectionTransferredOn": "datetime", "depositProtectionTenantNotified": boolean, "depositProtectionResubmitInfoOn": "datetime", "depositProtectionRemind": boolean, "depositProtectionRemindDate": "datetime", "rentFrequencyId":integer, "rentFrequencyName": "string", "userTitleName": "string", "tenantSourceName": "string", "paymentMethodName": "string", "depositProtectionSchemeName": "string", "collectionDayName": "string" "tenants": [ { "applicantImportId": long, "uTitleId":integer, "forename": "string", "surname": "string", "email": "string", "phone": "string", "wPhone": "string", "mPhone": "string", "dateOfBirth": "datetime", "website": "string", "companyName": "string", "sourceId":integer, "pBAddress_HouseNo": "string", "pBAddress_Address1": "string", "pBAddress_Address2": "string", "pBAddress_Town": "string", "pBAddress_County": "string", "pBAddress_CountryId":integer, "pBAddress_PostCode": "string", "pBAddress_Latitude": "decimal", "pBAddress_Longitude": "decimal", "pBAddress_GeocodingVerified": "bool", "rentAmount": decimal, "depositAmount":decimal, "rentFrequencyId": integer, "nextRentDueDate": integer, "rentFrequencyId":integer, "nextRentDueDate": "datetime", "collectionDay":integer, "bankName": "string", "bankAccountName": "string", "bankSortCode": "string", "bankReference": "string", "paymentMethodId": integer, "gDPR_Email": boolean, "gDPR_Letter": boolean, "gDPR_SMS":boolean, "gDPR_Phone":boolean, "gDPR_3rdParty": boolean, "gDPR_Marketing": boolean, "gDPR_DoNotContact": boolean, "gDPR_CheckedByUserId": boolean, "gDPR_DateChecked": "DateTime", "hasGuarantor": boolean, "guarantor_UTitleId": integer, "guarantor_Forename": "string", "guarantor_Surname": "string", "guarantor_Email": "string", "guarantor_Phone": "string", "guarantor_WPhone": "string", "guarantor_MPhone": "string", "guarantor_DateOfBirth": "datetime", "guarantor_Website": "string", "guarantor_CompanyName": "string", "guarantor_HouseNo": "string", "guarantor_Address1": "string", "guarantor_Address2": "string", "guarantor_Town": "string", "guarantor_County": "string", "guarantor_CountryId": integer, "guarantor_PostCode": "string", "guarantor_Latitude": decimal, "guarantor_Longitude":decimal, "guarantor_GeocodingVerified": boolean, "holdingDeposit":decimal } ], "udf": [ { "udfid": long, "value": "string" } ] }

User Titles:

The list below describes the possible User Titles.

Mr
Miss
Mrs
Mr & Mrs
Ms
Dr
Prof

Example field on request:

"userTitleName": "Mr"

Lease Types:

The list below describes the possible Lease Types.

1 Month Shorthold
3 Month Shorthold
6 Month Shorthold
9 Month Shorthold
12 Month Shorthold
18 Month Shorthold
2 Year
3 Year
4 Year
5 Year
Periodic
Rolling Tenancy
4 Weeks
9 month
Three quarters
Medium term

Example field on request:

"leaseTypeName": "9 Month Shorthold"

Rent Frequencies:

The list below describes the possible Rent Frequencies.

Weekly
Fortnightly
Four Weekly
Monthly
Quarterly
Half Yearly
Yearly
Periodic
Commercial

Example field on request:

"rentFrequencyName": "Weekly"

Tenant Sources:

The list below describes the possible Tenant Sources.

Walk In
Friend
Recommendation
Website
Rightmove
Zoopla
On The Market
Prime Location
Advert

Example field on request:

"tenantSourceName": "Recommendation"

Payment Methods :

The list below describes the possible Payment Methods.

Bank Transfer
BACS
Standing Order
Direct Debit
Cheque
Cash

Example field on request:

"paymentMethodName": "Cash"

Deposit Protection Schemes :

The list below describes the possible Deposit Protection Schemes.

The Dispute Service
Deposit Protection Service
Tenancy Deposit Solutions Ltd
N/A
Tenancy Deposit Scheme

Example field on request:

"depositProtectionSchemeName": "The Dispute Service"

Collection Day Names :

The list below describes the possible Deposit Collection Day Names.

Same Day
End Of Month

Example field on request:

"collectionDayName": "End Of Month"

Response

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

Example response:

HTTPS 200 OK Content-Type: application/json { "tenancyid": long, "propertyId": long, "negotiatorId": long, "displayName": "string", "agreementName": "string", "internalCode": "string", "leaseTypeId":long, "startDate": "date", "endDate": "date", "nextVisitDate": "datetime", "vacatingDate": "datetime", "relocationAgentId":long, "periodic": boolean, "breakClauseDate": "datetime", "depositProtectionSchemeId": long, "depositHeldBy": long, "depositRegistered": boolean, "section21Date": "datetime", "section21Served": boolean, "section21ServedOn": "datetime", "improvementNoticeServed": boolean, "followUp": boolean, "followUpDate": "datetime", "useRentableItems": boolean, "useInclusiveRent": boolean, "archived": boolean, "renewing": boolean, "renewalStartDate": "datetime", "geminiId": long, "aquariusId": long, "hidden": boolean, "prebooked": boolean, "dateAdded": "datetime", "vacatingDateSwitch": boolean, "udf": [ { "udfid": long, "value": "string" } ] }