{"swagger":"2.0","info":{"version":"v4-concierge","title":"agentOS Api V4, Concierge Call Group"},"host":"live-api.letmc.com","schemes":["https"],"paths":{"/v4/concierge/{shortName}/company/areas/{areaID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific area given its unique Object ID(OID)","operationId":"CompanyController_GetArea","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"areaID","in":"path","description":"The unique ID of the Area","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingAreaModel"}}}}},"/v4/concierge/{shortName}/company/areas/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"A collection of all the areas for a company","operationId":"CompanyController_GetAreas","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisingAreaModelResults"}}}}},"/v4/concierge/{shortName}/company/branches/{branchID}":{"get":{"tags":["CompanyController"],"summary":"Get a specific branch given its unique Object ID (OID)","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"branchID","in":"path","description":"The unique ID of the Branch","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModel"}}}}},"/v4/concierge/{shortName}/company/branches/{offset}/{count}":{"get":{"tags":["CompanyController"],"summary":"All branches defined for a company","operationId":"CompanyController_GetBranches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first item to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The maximum number of items to return (up to 1000 per request)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseBranchModelResults"}}}}},"/v4/concierge/{shortName}/company/object/{objectID}/customfield":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field by ObjectID:-","operationId":"CompanyController_GetCustomfieldbyID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseCustomField"}}}}},"/v4/concierge/{shortName}/company/objects/{objectID}/{fieldID}/customfield":{"post":{"tags":["CompanyController"],"summary":"Set Custom Field Value:-","operationId":"CompanyController_SetCustomFieldValue","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"},{"name":"value","in":"body","description":"Value to enter (string)","required":true,"schema":{"$ref":"#/definitions/BaseCustomFieldSubmissionModel"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v4/concierge/{shortName}/company/objects/{objectID}/{fieldID}/value":{"get":{"tags":["CompanyController"],"summary":"Get Custom Field Value:-","operationId":"CompanyController_GetCustomFieldValue","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"objectID","in":"path","description":"The Unique Object ID","required":true,"type":"string"},{"name":"fieldID","in":"path","description":"The Unique Field ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/v4/concierge/{shortName}/contacts/landlord/{landlordID}":{"get":{"tags":["ContactsController"],"summary":"Retrieves a landlord by ID:-","operationId":"ContactsController_GetLandlord","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"landlordID","in":"path","description":"The unique landlord ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergeLandlordModel"}}}}},"/v4/concierge/{shortName}/contacts/purchasers":{"get":{"tags":["ContactsController"],"summary":"Get a purchaser for a sale:-","operationId":"ContactsController_GetPurchaser","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"query","description":"The unique sales instruction ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergePurchaserModel"}}}}},"/v4/concierge/{shortName}/contacts/tenants/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Retrieve all tenants from a tenancy:-","operationId":"ContactsController_GetTenants","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"tenancyID","in":"query","description":"The unique tenancy ID","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The total number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergeTenantModelResults"}}}}},"/v4/concierge/{shortName}/contacts/tenants/{tenantID}":{"get":{"tags":["ContactsController"],"summary":"Retrieve a tenant by ID:-","operationId":"ContactsController_GetTenant","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"tenantID","in":"path","description":"The unique tenant ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergeTenantModel"}}}}},"/v4/concierge/{shortName}/contacts/vendors/{offset}/{count}":{"get":{"tags":["ContactsController"],"summary":"Retrieves all vendors for a sales instruction:-","operationId":"ContactsController_GetVendors","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"salesInstructionID","in":"query","description":"The unique landlord ID","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergeVendorModelResults"}}}}},"/v4/concierge/{shortName}/contacts/vendors/{vendorID}":{"get":{"tags":["ContactsController"],"summary":"Get a sales vendor associated by ID:-","operationId":"ContactsController_GetVendor","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"vendorID","in":"path","description":"The unique vendor ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergeVendorModel"}}}}},"/v4/concierge/{shortName}/properties/{propertyID}":{"get":{"tags":["PropertyController"],"summary":"Retrieve property by ID:-","operationId":"PropertyController_GetProperty","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"propertyID","in":"path","description":"The unique property ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergePropertyModel"}}}}},"/v4/concierge/{shortName}/salesinstructions/conciergemanaged/{offset}/{count}":{"get":{"tags":["SalesInstructionController"],"summary":"Returns active sales instructions managed by a concierge between two dates:-","operationId":"SalesInstructionController_GetConciergeSales","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"branchID","in":"query","description":"The unique branch ID","required":true,"type":"string"},{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"startDate","in":"query","description":"Start date","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"End date","required":true,"type":"string","format":"date-time"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"},{"name":"modifiedSince","in":"query","description":"Optional. ISO-8601 UTC date/time; only sales instructions changed on or after this are returned. Ideal for incremental sync.","required":false,"type":"string","format":"date-time"},{"name":"modifiedUntil","in":"query","description":"Optional. ISO-8601 UTC date/time; only sales instructions changed on or before this are returned.","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergeSalesInstructionModelResults"}}}}},"/v4/concierge/{shortName}/tenancies/conciergemanaged/{offset}/{count}":{"get":{"tags":["TenancyController"],"summary":"Returns active tenancies managed by a concierge between two dates:-","operationId":"TenancyController_GetConciergeTenancies","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"branchID","in":"query","description":"The unique branch ID","required":true,"type":"string"},{"name":"shortName","in":"path","description":"The unique client short-name","required":true,"type":"string"},{"name":"offset","in":"path","description":"The index of the first result to return","required":true,"type":"integer","format":"int32"},{"name":"count","in":"path","description":"The number of results to return (Max 1000)","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConciergeTenancyModelResults"}}}}}},"definitions":{"BaseBranchModelResults":{"description":"Holds results from a paged query returning BranchModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/BaseBranchModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Base Hypermedia Links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseBranchModel":{"description":"Defines a single branch of a client.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The branch name.","type":"string"},"CompanyName":{"description":"The relevant company name, if not the one specified on the branch then the one on company.","type":"string"},"Address1":{"description":"Branch address line 1.","type":"string"},"Address2":{"description":"Branch address line 2.","type":"string"},"Address3":{"description":"Branch address line 3.","type":"string"},"Address4":{"description":"Branch address line 4.","type":"string"},"Postcode":{"description":"Branch address postcode.","type":"string"},"WebAddress":{"description":"Branch web address.","type":"string"},"EMailAddress":{"description":"Branch email address.","type":"string"},"LandPhone":{"description":"Branch land phone number.","type":"string"},"FaxPhone":{"description":"Branch fax phone number.","type":"string"},"County":{"description":"County","type":"string"},"Links":{"description":"Hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseHypermediaLink":{"description":"Hypermedia Link Class","type":"object","properties":{"Relationship":{"description":"The hypermedia link relationship to current result object.","type":"string"},"Href":{"description":"The hypermedia href","type":"string"},"Method":{"description":"The http method type","type":"string"}}},"AdvertisingAreaModelResults":{"description":"Holds results from a paged query returning AreaModel values","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range","type":"array","items":{"$ref":"#/definitions/AdvertisingAreaModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages","type":"integer"},"Links":{"description":"Base hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"AdvertisingAreaModel":{"description":"Stores the information about a single property area.","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"Name":{"description":"The property area name.","type":"string"},"BranchOID":{"description":"The branch that manages this area.","type":"string"},"ShowOnSites":{"description":"Show the area on sites?","type":"boolean"},"Links":{"description":"Base hypermedia links","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"BaseCustomField":{"type":"object","properties":{"CustomFields":{"description":"Dynamic Custom Field:-","type":"array","items":{"$ref":"#/definitions/CustomFieldDataModel"}}}},"CustomFieldDataModel":{"type":"object","properties":{"ID":{"description":"Field ID:-","type":"string"},"TabName":{"description":"Tab on OS custom field belongs to:-","type":"string"},"GroupName":{"description":"The grouping on OS the custom field belongs to:-","type":"string"},"FieldName":{"description":"Name of the custom field:-","type":"string"},"Retired":{"description":"Is field retired:-","type":"boolean"},"Value":{"description":"Custom Field Value:-","type":"object"}}},"BaseCustomFieldSubmissionModel":{"type":"object","properties":{"customfieldValue":{"description":"Custom Field Value","type":"string"}}},"ConciergeTenantModelResults":{"description":"Concierge tenant model results:-","type":"object","properties":{"Data":{"description":"Results data:-","type":"array","items":{"$ref":"#/definitions/ConciergeTenantModel"}},"Count":{"format":"int32","description":"Results count:-","type":"integer"},"Links":{"description":"Hypermedia links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergeTenantModel":{"description":"Concierge tenant model results:-","type":"object","properties":{"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"CRMReference":{"description":"The unique CRM reference.","type":"string"},"GlobalReference":{"description":"The global reference to this user.","type":"string"},"ManagedBy":{"description":"The branch linked to this user","type":"string"},"Title":{"description":"The user's title.","type":"string"},"Forename":{"description":"The user's forename.","type":"string"},"Middlename":{"description":"The user's middlename.","type":"string"},"Surname":{"description":"The user's surname.","type":"string"},"DateOfBirth":{"format":"date-time","description":"The user's date of birth.","type":"string"},"ContactEMail":{"description":"The user's email contact.","type":"string"},"ContactMobile":{"description":"The user's mobile contact.","type":"string"},"AllowUtilityCompaniesContact":{"description":"Allow 3rd Party Utility Companies Contact","type":"boolean"},"TenancyID":{"description":"Tenancy ID:-","type":"string"},"CreatedDate":{"format":"date-time","description":"The creation date of the tenant object.","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergeLandlordModel":{"description":"Concierge Landlord Model:-","type":"object","properties":{"Address":{"$ref":"#/definitions/BaseAddressModel"},"OID":{"description":"The unique Object ID (OID).","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision.","type":"string"},"CRMReference":{"description":"The unique CRM reference.","type":"string"},"GlobalReference":{"description":"The global reference to this user.","type":"string"},"ManagedBy":{"description":"The branch linked to this user","type":"string"},"Title":{"description":"The user's title.","type":"string"},"Forename":{"description":"The user's forename.","type":"string"},"Middlename":{"description":"The user's middlename.","type":"string"},"Surname":{"description":"The user's surname.","type":"string"},"DateOfBirth":{"format":"date-time","description":"The user's date of birth.","type":"string"},"ContactEMail":{"description":"The user's email contact.","type":"string"},"ContactMobile":{"description":"The user's mobile contact.","type":"string"},"AllowUtilityCompaniesContact":{"description":"Allow 3rd Party Utility Companies Contact","type":"boolean"}}},"BaseAddressModel":{"description":"Base Address Model:-","type":"object","properties":{"Address1":{"description":"Address 1:-","type":"string"},"Address2":{"description":"Address 2:-","type":"string"},"Address3":{"description":"Address 3:-","type":"string"},"Address4":{"description":"Address 4:-","type":"string"},"Postcode":{"description":"Postcode:-","type":"string"},"FlatOrRoomNumber":{"description":"Flat Or Room Number:-","type":"string"},"AddressNumber":{"description":"Address Number:-","type":"string"}}},"ConciergeVendorModelResults":{"description":"Concierge Vendor Model Results:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/ConciergeVendorModel"}},"Count":{"format":"int32","description":"Results Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergeVendorModel":{"description":"Concierge Vendor Model:-","type":"object","properties":{"OID":{"description":"Tonga Identifier:-","type":"string"},"ETag":{"description":"E Tag:-","type":"string"},"GlobalReference":{"description":"Global Reference:-","type":"string"},"Title":{"description":"Title:-","type":"string"},"Forename":{"description":"Forename:-","type":"string"},"Surname":{"description":"Surname:-","type":"string"},"PhoneNumber":{"description":"Phone Number:-","type":"string"},"Email":{"description":"Email:-","type":"string"},"DateOfBirth":{"format":"date-time","description":"Date of birth:-","type":"string"},"AddressNumber":{"description":"Vendor Address Number:-","type":"string"},"Address1":{"description":"Vendor Address 1:-","type":"string"},"Address2":{"description":"Vendor Address 2:-","type":"string"},"Address3":{"description":"Vendor Address 3:-","type":"string"},"Address4":{"description":"Vendor Address 4:-","type":"string"},"Postcode":{"description":"Vendor Postcode:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergePurchaserModel":{"description":"Concierge Sales Purchaser Model:-","type":"object","properties":{"OID":{"description":"Tonga Identifier","type":"string"},"ETag":{"description":"E Tag","type":"string"},"GlobalReference":{"description":"Global Reference","type":"string"},"Title":{"description":"Title:-","type":"string"},"Forename":{"description":"Forename:-","type":"string"},"Surname":{"description":"Surname:-","type":"string"},"Email":{"description":"Email:-","type":"string"},"DateOfBirth":{"format":"date-time","description":"Date Of Birth:-","type":"string"},"AddressNumber":{"description":"Purchaser Address Number","type":"string"},"Address1":{"description":"Purchaser Address 1","type":"string"},"Address2":{"description":"Purchaser Address 2","type":"string"},"Address3":{"description":"Purchaser Address 3","type":"string"},"Address4":{"description":"Purchaser Address 4","type":"string"},"Postcode":{"description":"Purchaser Postcode","type":"string"},"EmailAddress":{"description":"Purchaser Email Address","type":"string"},"PhoneNumber":{"description":"Purchaser Phone Number","type":"string"}}},"ConciergePropertyModel":{"description":"Concierge Property Model:-","type":"object","properties":{"OID":{"description":"OID:-","type":"string"},"ETag":{"description":"ETag:-","type":"string"},"AddressNumber":{"description":"Address Number:-","type":"string"},"AddressFlatRoomNumber":{"description":"Address Flat Room Number:-","type":"string"},"Address1":{"description":"Address 1:-","type":"string"},"Address2":{"description":"Address2:-","type":"string"},"Address3":{"description":"Address 3:-","type":"string"},"Address4":{"description":"Address 4:-","type":"string"},"Postcode":{"description":"Postcode:-","type":"string"},"EPCCurrentEER":{"description":"Current EPC EER Certificate:-","type":"string"},"EPCPotentialEER":{"description":"Potential EPC EER Certificate:-","type":"string"},"EPCCurrentEI":{"description":"Current EPC EI Certificate:-","type":"string"},"EPCPotentialEI":{"description":"Potential EPC EI Certificate:-","type":"string"},"CouncilTaxBand":{"description":"Council Tax Band:-","type":"string"},"BranchID":{"description":"Branch ID:-","type":"string"},"LandlordID":{"description":"Landlord ID:-","type":"string"},"GasMeterNumber":{"description":"Gas Meter Serial Number:-","type":"string"},"Electricity1MeterNumber":{"description":"Electricty1 Meter Serial Number:-","type":"string"},"Electricity2MeterNumber":{"description":"Electricty2 Meter Serial Number:-","type":"string"},"Electricity3MeterNumber":{"description":"Electricty3 Meter Serial Number:-","type":"string"},"Electricity4MeterNumber":{"description":"Electricty4 Meter Serial Number:-","type":"string"},"Electricity5MeterNumber":{"description":"Electricty5 Meter Serial Number:-","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergeSalesInstructionModelResults":{"description":"Results model for concierge sales instructions:-","type":"object","properties":{"Data":{"description":"Results Data:-","type":"array","items":{"$ref":"#/definitions/ConciergeSalesInstructionModel"}},"Count":{"format":"int32","description":"Result Count:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergeSalesInstructionModel":{"description":"Concierge Sales Instruction Model:-","type":"object","properties":{"OID":{"description":"Sales Instruction ID:-","type":"string"},"ETag":{"description":"E-Tag:-","type":"string"},"GlobalReference":{"description":"Global Reference:-","type":"string"},"DisplayState":{"description":"Display State:-","type":"string"},"State":{"description":"State:-","enum":["MarketAppraisal","LostAppraisal","Instructed","Advertised","UnderOffer","ContractsExchanged","Completed","FallenThrough","Withdrawn"],"type":"string"},"AddressNumber":{"description":"Address Number:-","type":"string"},"Address1":{"description":"Address 1:-","type":"string"},"Address2":{"description":"Address 2:-","type":"string"},"Address3":{"description":"Address 3:-","type":"string"},"Address4":{"description":"Address 4:-","type":"string"},"Postcode":{"description":"Postcode:-","type":"string"},"BranchID":{"description":"Branch ID:-","type":"string"},"VendorIDs":{"description":"Vendor IDs:-","type":"array","items":{"type":"string"}},"PurchaserID":{"description":"Purchaser ID:-","type":"string"},"DateOfMemorandum":{"format":"date-time","description":"Date contracts approved:-","type":"string"},"EstimatedExchangeDate":{"format":"date-time","description":"Estimated date of contract exchange:-","type":"string"},"ExchangeDate":{"format":"date-time","description":"Date Contracts were exchanged:-","type":"string"},"EstimatedCompletionDate":{"format":"date-time","description":"Estimated Completion Date:-","type":"string"},"CompletionDate":{"format":"date-time","description":"Actual Completion Date:","type":"string"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergeTenancyModelResults":{"description":"Holds results from a paged query returning TenancyModel values:-","type":"object","properties":{"Data":{"description":"The resulting data returned from the paged query range:-","type":"array","items":{"$ref":"#/definitions/ConciergeTenancyModel"}},"Count":{"format":"int32","description":"The total number of results available for all pages:-","type":"integer"},"Links":{"description":"Hypermedia Links:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}},"ConciergeTenancyModel":{"description":"Concierge Tenancy Model:-","type":"object","properties":{"OID":{"description":"The unique Object ID (OID):-","type":"string"},"ETag":{"description":"A unique identifier defining the object and change revision:-","type":"string"},"GlobalReference":{"description":"The global reference for a tenancy:-","type":"string"},"IsTenancyAdvertised":{"description":"Gets a value indicating whether this tenancy is being advertised. Note\r\nthat this will only return true while the tenancy has a valid advertise\r\ndate. It will not return true in the proposed phase:-","type":"boolean"},"IsTenancyProposed":{"description":"Is the tenancy a proposed tenancy?:-","type":"boolean"},"TermStart":{"format":"date-time","description":"The instruction start date:-","type":"string"},"RentAdvertised":{"format":"double","description":"The advertised amount of rent for the property:-","type":"number"},"RentSchedule":{"description":"The tenancy rent schedule:-","enum":["Once","Daily","Weekly","Monthly","Yearly"],"type":"string"},"RentRecurrence":{"format":"int32","description":"The rent schedule recurrence:-","type":"integer"},"AdvertiseFrom":{"format":"date-time","description":"The date to advertise this tenancy from:-","type":"string"},"BondRequired":{"format":"double","description":"The total bond required:-","type":"number"},"TenantSystemTypes":{"description":"The specific tenant type list, or empty if for all types:-","type":"array","items":{"enum":["Employed","SelfEmployed","Unemployed","Student","OwnMeans","Retired","Company","Council"],"type":"string"}},"Furnished":{"description":"The property furnished type:-","enum":["Unfurnished","PartFurnished","Furnished"],"type":"string"},"IsShareProperty":{"description":"Is this property a shared property:-","type":"boolean"},"IsStudentProperty":{"description":"Is this property a student property:-","type":"boolean"},"MinimumTenants":{"format":"int32","description":"The minimum number of tenants to advertise for:-","type":"integer"},"MaximumTenants":{"format":"int32","description":"The maximum number of tenants to advertise for:-","type":"integer"},"TermMinimum":{"format":"int32","description":"The minimum term:-","type":"integer"},"TermMaximum":{"format":"int32","description":"The instruction maximum term:-","type":"integer"},"StartDate":{"format":"date-time","description":"The tenancy start date. This is the date the tenancy\r\nbegins, and the tenants may move in to the property:-","type":"string"},"FixedDate":{"format":"date-time","description":"The tenancy fixed period end date. This is the date\r\nthe fixed term ends, and the statutory rolling period begins. It\r\ndoes not represent the end of the tenancy:-","type":"string"},"EndDate":{"format":"date-time","description":"The tenancy end date. This is the date the tenancy will\r\nactually end, when the tenants must move out. It is possible to set\r\nthis value, before the signed state:-","type":"string"},"LetType":{"description":"Lettings Type: New Let, Re-Let, Renewal:-","enum":["FirstLet","ReLet","Renewal"],"type":"string"},"IsHMOProperty":{"description":"Is this a HMO tenancy?:-","type":"boolean"},"IsTenancyClosed":{"description":"Is the tenancy a closed tenancy?:-","type":"boolean"},"IsTenancyEnded":{"description":"Is the tenancy ended?:-","type":"boolean"},"IsTenancyPeriodic":{"description":"Is the tenancy periodic?:-","type":"boolean"},"IsTenancySigned":{"description":"A value indicating whether this tenancy has been signed:-","type":"boolean"},"IsTenancyAbandoned":{"description":"A value indicating whether this tenancy has been abandoned:-","type":"boolean"},"UtilityElectricity":{"description":"Who's responsible for electricity bills:-","enum":["Tenant","Landlord"],"type":"string"},"UtilityGas":{"description":"Who's responsible for Gas bills:-","enum":["Tenant","Landlord"],"type":"string"},"UtilityWater":{"description":"Who's responsible for water bills:-","enum":["Tenant","Landlord"],"type":"string"},"OpeningElec1Reading":{"description":"Opening meter one electricity reading:-","type":"string"},"OpeningElec2Reading":{"description":"Opening meter two electricity reading:-","type":"string"},"OpeningElec3Reading":{"description":"Opening meter three electricity reading:-","type":"string"},"OpeningElec4Reading":{"description":"Opening meter four electricity reading:-","type":"string"},"OpeningElec5Reading":{"description":"Opening meter five electricity reading:-","type":"string"},"ClosingElec1Reading":{"description":"The first closing electric meter reading:-","type":"string"},"ClosingElec2Reading":{"description":"The second closing electric meter reading:-","type":"string"},"ClosingElec3Reading":{"description":"The third closing electric meter reading:-","type":"string"},"ClosingElec4Reading":{"description":"The fourth closing electric meter reading:-","type":"string"},"ClosingElec5Reading":{"description":"The fifth closing electric meter reading:-","type":"string"},"OpeningGasReading":{"description":"Opening gas meter reading:-","type":"string"},"ClosingGasReading":{"description":"The closing gas meter reading:-","type":"string"},"OpeningWaterReading":{"description":"Opening water meter reading:-","type":"string"},"ClosingWaterReading":{"description":"The closing water meter reading:-","type":"string"},"OpeningMeterDate":{"format":"date-time","description":"The date the opening meter readings were taken:-","type":"string"},"ClosingMeterDate":{"format":"date-time","description":"The date the closing meter readings were taken:-","type":"string"},"ConciergeManaged":{"description":"Is tenancy concierge managed?:-","type":"boolean"},"BranchID":{"description":"Branch ID:-","type":"string"},"AreaID":{"description":"Area ID:-","type":"string"},"PropertyID":{"description":"Property ID:-","type":"string"},"LeadTenantID":{"description":"Lead Tenant ID:-","type":"string"},"TenantIDs":{"description":"Tenant IDs:-","type":"array","items":{"type":"string"}},"Links":{"description":"HypermediaLinks:-","type":"array","items":{"$ref":"#/definitions/BaseHypermediaLink"}}}}},"securityDefinitions":{"basic":{"type":"basic","description":"Basic HTTP Authentication"},"apiKey":{"type":"apiKey","description":"ApiKey Authentication","name":"ApiKey","in":"header"}}}