{"swagger":"2.0","info":{"title":"Foundations Interactive API Explorer","description":"<p>Technical documentation for the Reapit Foundations REST API endpoints. This tool is interactive and provides instant access to data hosted in our <strong><a href=\"https://foundations-documentation.reapit.cloud/api/api-documentation#sandbox-mode\">sandbox environment</a> </strong>with <strong>authentication</strong> and <strong>versioning</strong> headers pre-populated. Example requests and responses are shown by default but you can switch to view a fully documented schema - look for the&nbsp;<strong>model</strong> link.</p>\n<p>* To begin developing with the platform, consult our&nbsp;<strong><a href=\"https://foundations-documentation.reapit.cloud/api/api-documentation\">documentation</a></strong>&nbsp;<br />* To report a bug or request a new feature, see our <strong><a href=\"https://developers.reapit.cloud/help\">help pages</a>&nbsp;<br /></strong>* For information on terminology, see our&nbsp;<strong><a href=\"https://foundations-documentation.reapit.cloud/platform-glossary\">glossary</a></strong>&nbsp;<br />* Our APIs are located at&nbsp;<strong>https://platform.reapit.cloud<br /></strong>* The current API version is&nbsp;<strong>2020-01-31<br /></strong></p>","version":"1.0.0"},"host":"platform.reapit.cloud","paths":{"/applicants/":{"get":{"tags":["Applicants"],"summary":"Gets a collection of applicants matching the filter criteria provided","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of applicants to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/nextCall/lastCall)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the applicants returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","areas","department","documents","negotiators","offers","offices","solicitor","source"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return applicants where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"age","description":"Only return applicants where the `age` field contains one or more values provided ","type":"array","items":{"enum":["period","new","modern","old"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"contactDetail","description":"Only return applicants where at least one of the applicants contact details matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"emailAddresses","description":"Only return applicants where the `email` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"furnishing","description":"Only return appliants where the `furnishing` field contains one or more values provided. Only applicable when marketingMode is renting ","type":"array","items":{"enum":["furnished","unfurnished","partFurnished"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"locality","description":"Only return applicants where the `locality` field contains one or more values provided ","type":"array","items":{"enum":["rural","village","townCity"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return applicants where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return applicants where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"parking","description":"Only return applicants where the `parking` field contains one or more values provided ","type":"array","items":{"enum":["residents","offStreet","secure","underground","garage","doubleGarage","tripleGarage","carport"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"situation","description":"Only return applicants where the `situation` field contains one or more values provided ","type":"array","items":{"enum":["garden","land","patio","roofTerrace","conservatory","balcony","communalGardens","outsideSpace"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"style","description":"Only return applicants where the `style` field contains one or more values provided ","type":"array","items":{"enum":["terraced","endTerrace","detached","semiDetached","linkDetached","mews","basement","lowerGroundFloor","groundFloor","firstFloor","upperFloor","upperFloorWithLift","penthouse","duplex"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"type","description":"Only return applicants where the `type` field contains one or more values provided ","type":"array","items":{"enum":["house","bungalow","flatApartment","maisonette","land","farm","cottage","studio","townhouse","developmentPlot"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"market","description":"Only return applicants where the `market` field contains one or more values provided ","type":"array","items":{"enum":["local","openA","openB","openC","openD"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"address","description":"Only return applicants where the `address` field matches the value provided","type":"string"},{"in":"query","name":"departmentId","description":"Only return applicants where the `departmentId` field matches the value provided","type":"string"},{"in":"query","name":"marketingMode","description":"Only return applicants where the `marketingMode` field matches the value provided ","type":"array","items":{"enum":["buying","renting"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"name","description":"Only return applicants where the `name` field matches the value provided. This can be used in conjunction with the nameType parameter to improve search performance","type":"string"},{"in":"query","name":"nameType","description":"Specify the kind of name filter being applied. When not specified, a full name search will be carried out which is slower than a quicker surname/initials search ","type":"array","items":{"enum":["surname","initials","full","companyName"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"priceFrom","description":"Only return applicants where the `buying.priceFrom` field is more than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"priceTo","description":"Only return applicants where the `buying.priceTo` field is less than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"rentFrom","description":"Only return applicants where the `renting.rentFrom` field is more than or equal to the value provided","type":"number","format":"double"},{"in":"query","name":"rentTo","description":"Only return applicants where the `renting.rentTo` field is less than or equal to the value provided","type":"number","format":"double"},{"in":"query","name":"rentFrequency","description":"The rent collection frequency that 'rentFrom' and 'rentTo' parameters are in relation to. Defaults to monthly. ","type":"array","items":{"enum":["weekly","monthly","annually"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"bedroomsFrom","description":"Only return applicants where the `bedrooms` field is more than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"bedroomsTo","description":"Only return applicants where the `bedrooms` field is less than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"active","description":"Only return applicants where the `active` field matches the value provided","type":"boolean"},{"in":"query","name":"fromArchive","description":"Only return applicants where the `fromArchive` field matches the value provided","type":"boolean"},{"in":"query","name":"createdFrom","description":"Only return applicants where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return applicants where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return applicants where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return applicants where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"hasLastCall","description":"Only return applicants which have a lastCall date","type":"boolean"},{"in":"query","name":"lastCallFrom","description":"Only return applicants where the `lastCall` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"lastCallTo","description":"Only return applicants where the `lastCall` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"nextCallFrom","description":"Only return applicants where the `nextCall` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"nextCallTo","description":"Only return applicants where the `nextCall` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"hasNextCall","description":"Only return applicants which have a nextcall date","type":"boolean"},{"in":"query","name":"metadata","description":"Only return applicants where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"locationOptions","description":"Only return applicants where a value in the `locationOptions` field contains the provided string","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an applicant","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant","type":"string"},"created":{"format":"date-time","description":"The date and time when the applicant was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the applicant was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department the applicant is associated with. The applicant will only match to properties with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg swimmingPool, tennisCourt), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedRequirements":{"description":"The requirements associated to the applicant which are not currently mapped. These are defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped requirement type","type":"object","properties":{"type":{"description":"The type of unmapped requirement","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the applicant was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag denoting whether or not this applicant is archived","type":"boolean"},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department. Only applicable to applicants with a marketingMode of renting","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"commercial":{"description":"An applicant's commercial details","type":"object","properties":{"useClass":{"description":"The commercial use requirements (eg a1, a2, b1), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"related":{"description":"A collection of contacts and/or companies associated to the applicant. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to an applicant","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the applicant","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the applicant. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF200060","created":"2020-01-12T15:44:28Z","modified":"2020-01-26T09:24:02Z","marketingMode":"sales","currency":"GBP","active":true,"notes":"Looking to move his mother back into the area","sellingStatus":null,"sellingPosition":null,"statusId":null,"lastCall":"2020-01-15","nextCall":"2020-03-01","departmentId":"G","solicitorId":"OXF18000012","potentialClient":false,"type":["house","maisonette","cottage"],"style":["detached","semiDetached"],"situation":["garden","patio"],"parking":["garage"],"age":["period"],"locality":["rural"],"specialFeatures":null,"unmappedRequirements":null,"bedroomsMin":4,"bedroomsMax":5,"receptionsMin":1,"receptionsMax":2,"bathroomsMin":1,"bathroomsMax":0,"parkingSpacesMin":0,"parkingSpacesMax":0,"locationType":"areas","locationOptions":["SOL","BHM","WLV"],"archivedOn":null,"fromArchive":false,"buying":{"priceFrom":250000,"priceTo":275000,"decoration":null,"reasonId":null,"positionId":null,"tenure":["freehold","leasehold"],"mortgageExpiry":null,"leaseRemaining":{"min":15,"max":25}},"renting":null,"externalArea":{"type":"acres","amountFrom":2,"amountTo":3},"internalArea":{"type":"squareFeet","amount":1500},"source":{"id":"RMV","type":"source"},"commercial":null,"regional":null,"officeIds":["OXF","SOL"],"negotiatorIds":["JAS"],"related":[{"id":"OXF12300101","name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"fromArchive":false,"primaryAddress":{"buildingName":null,"buildingNumber":"1","line1":"Test House","line2":"Test Lane","line3":"County of Test","line4":"Test City","postcode":"A11 2BB","countryId":"GB"},"additionalContactDetails":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/applicants/OXF200060"},"documents":{"href":"/documents/?associatedType=applicant&associatedId=OXF200060"},"offers":{"href":"/offers/?applicantId=OXF200060"},"appointments":{"href":"/appointments/?attendeeType=applicant&attendeeId=OXF200060"},"department":{"href":"/departments/G"},"solicitor":{"href":"/companies/OXF18000012"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"negotiators":{"href":"/negotiators/?id=JAS"},"relationships":{"href":"/applicants/OXF200060/relationships"},"areas":{"href":"/areas/?id=SOL&id=BHM&id=WLV"},"source":{"href":"/sources/RMV"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/applicants/?PageNumber=1&PageSize=1"},"first":{"href":"/applicants/?PageNumber=1&PageSize=1"},"next":{"href":"/applicants/?PageNumber=2&PageSize=1"},"last":{"href":"/applicants/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Applicants"],"summary":"Creates a new applicant","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create a new applicant","required":["marketingMode","departmentId","officeIds","negotiatorIds","related"],"type":"object","properties":{"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant\r\nWhere not specified this will default to the customer's base currency","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department the applicant is associated with. The applicant will only match to properties with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget. (Required when 'marketingMode' is 'buying' and 'priceTo' is not provided)","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget. (Required when 'marketingMode' is 'buying' and 'priceFrom' is not provided)","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date-time","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14T12:30:02Z"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget. (Required when 'marketingMode' is 'renting' and 'rentTo' is 0)","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget. (Required when 'marketingMode' is 'renting' and 'rentFrom' is 0)","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually/fourWeekly).","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"related":{"description":"A collection of contacts and/or companies associated to the applicant. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"Request body used to create a relationship between an applicant and a contact or company","required":["associatedId"],"type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"}}}},"metadata":{"description":"App specific metadata to set against the applicant","type":"object","additionalProperties":{}}},"example":{"marketingMode":"buying","currency":"GBP","active":true,"notes":"Looking to move his mother back into the area","statusId":null,"sellingStatus":"exchanged","sellingPosition":"renting","lastCall":"2019-11-12","nextCall":"2022-12-29","departmentId":"G","solicitorId":"OXF18000012","potentialClient":false,"type":["house","maisonette","cottage"],"style":["detached","semiDetached"],"situation":["garden","patio"],"parking":["garage"],"age":["period"],"locality":["rural"],"specialFeatures":null,"bedroomsMin":4,"bedroomsMax":5,"receptionsMin":1,"receptionsMax":2,"bathroomsMin":1,"bathroomsMax":0,"parkingSpacesMin":0,"parkingSpacesMax":0,"locationType":"areas","locationOptions":["SOL","BHM","WLV"],"buying":{"reasonId":null,"positionId":null,"priceFrom":250000,"priceTo":275000,"decoration":null,"tenure":["freehold","leasehold"],"mortgageExpiry":null,"leaseRemaining":{"min":10,"max":20}},"renting":{"moveDate":null,"term":null,"rentFrom":null,"rentTo":null,"rentFrequency":null,"furnishing":null,"positionId":null},"externalArea":{"type":"acres","amountFrom":2,"amountTo":3},"internalArea":{"type":"squareFeet","amount":1500},"source":{"id":"RMV","type":"source"},"regional":null,"officeIds":["OXF","SOL"],"negotiatorIds":["JAS"],"related":[{"associatedId":"OXF20000001","associatedType":"contact"}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/applicants/{id}":{"get":{"tags":["Applicants"],"summary":"Gets a single applicant by its' unique identifier","operationId":"GetApplicantById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique applicant identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the applicant returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","areas","department","documents","negotiators","offers","offices","solicitor","source"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an applicant","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant","type":"string"},"created":{"format":"date-time","description":"The date and time when the applicant was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the applicant was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department the applicant is associated with. The applicant will only match to properties with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg swimmingPool, tennisCourt), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedRequirements":{"description":"The requirements associated to the applicant which are not currently mapped. These are defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped requirement type","type":"object","properties":{"type":{"description":"The type of unmapped requirement","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the applicant was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag denoting whether or not this applicant is archived","type":"boolean"},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department. Only applicable to applicants with a marketingMode of renting","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"commercial":{"description":"An applicant's commercial details","type":"object","properties":{"useClass":{"description":"The commercial use requirements (eg a1, a2, b1), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"related":{"description":"A collection of contacts and/or companies associated to the applicant. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to an applicant","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the applicant","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the applicant. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF200060","created":"2020-01-12T15:44:28Z","modified":"2020-01-26T09:24:02Z","marketingMode":"sales","currency":"GBP","active":true,"notes":"Looking to move his mother back into the area","sellingStatus":null,"sellingPosition":null,"statusId":null,"lastCall":"2020-01-15","nextCall":"2020-03-01","departmentId":"G","solicitorId":"OXF18000012","potentialClient":false,"type":["house","maisonette","cottage"],"style":["detached","semiDetached"],"situation":["garden","patio"],"parking":["garage"],"age":["period"],"locality":["rural"],"specialFeatures":null,"unmappedRequirements":null,"bedroomsMin":4,"bedroomsMax":5,"receptionsMin":1,"receptionsMax":2,"bathroomsMin":1,"bathroomsMax":0,"parkingSpacesMin":0,"parkingSpacesMax":0,"locationType":"areas","locationOptions":["SOL","BHM","WLV"],"archivedOn":null,"fromArchive":false,"buying":{"priceFrom":250000,"priceTo":275000,"decoration":null,"reasonId":null,"positionId":null,"tenure":["freehold","leasehold"],"mortgageExpiry":null,"leaseRemaining":{"min":15,"max":25}},"renting":null,"externalArea":{"type":"acres","amountFrom":2,"amountTo":3},"internalArea":{"type":"squareFeet","amount":1500},"source":{"id":"RMV","type":"source"},"commercial":null,"regional":null,"officeIds":["OXF","SOL"],"negotiatorIds":["JAS"],"related":[{"id":"OXF12300101","name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"fromArchive":false,"primaryAddress":{"buildingName":null,"buildingNumber":"1","line1":"Test House","line2":"Test Lane","line3":"County of Test","line4":"Test City","postcode":"A11 2BB","countryId":"GB"},"additionalContactDetails":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/applicants/OXF200060"},"documents":{"href":"/documents/?associatedType=applicant&associatedId=OXF200060"},"offers":{"href":"/offers/?applicantId=OXF200060"},"appointments":{"href":"/appointments/?attendeeType=applicant&attendeeId=OXF200060"},"department":{"href":"/departments/G"},"solicitor":{"href":"/companies/OXF18000012"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"negotiators":{"href":"/negotiators/?id=JAS"},"relationships":{"href":"/applicants/OXF200060/relationships"},"areas":{"href":"/areas/?id=SOL&id=BHM&id=WLV"},"source":{"href":"/sources/RMV"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Applicants"],"summary":"Updates an applicant","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the applicant to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update an existing applicant","type":"object","properties":{"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant\r\nWhere not specified this will default to the customer's base currency","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department that the applicant requirements are associated with. The applicant will only match to properties with the same value","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the applicant","type":"object","additionalProperties":{}}},"example":{"marketingMode":"buying","currency":"GBP","active":true,"notes":"Looking to move his mother back into the area","statusId":null,"sellingStatus":"completed","sellingPosition":"sellingWithUs","lastCall":"2019-11-12","nextCall":"2022-12-29","departmentId":"G","solicitorId":"OXF18000012","potentialClient":null,"type":["house","maisonette","cottage"],"style":["detached","semiDetached"],"situation":["garden","patio"],"parking":["garage"],"age":["period"],"locality":["rural"],"specialFeatures":null,"bedroomsMin":4,"bedroomsMax":5,"receptionsMin":1,"receptionsMax":2,"bathroomsMin":1,"bathroomsMax":null,"parkingSpacesMin":null,"parkingSpacesMax":null,"locationType":"areas","locationOptions":["SOL","BHM","WLV"],"buying":{"reasonId":null,"positionId":null,"priceFrom":250000,"priceTo":275000,"decoration":null,"tenure":["freehold","leasehold"],"mortgageExpiry":"0001-01-01T00:00:00Z","leaseRemaining":{"min":15,"max":25}},"renting":null,"externalArea":{"type":"acres","amountFrom":2,"amountTo":3},"internalArea":{"type":"squareFeet","amount":1500},"source":{"id":"RMV","type":"source"},"regional":null,"officeIds":["OXF","SOL"],"negotiatorIds":["JAS"],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/applicants/{id}/relationships":{"get":{"tags":["Applicants"],"summary":"Gets this applicants contact/company relationships","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique applicant identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of applicant relationships to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a relationship between an applicant and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"applicantId":{"description":"The unique identifier of the applicant","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent applicant entity","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","applicantId":"OXF190001","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"fromArchive":false,"_links":{"self":{"href":"/applicants/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}]}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Applicants"],"summary":"Creates a relationship between this applicant and a contact/company","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique applicant identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"Model containing information used to create or update the relationship","schema":{"description":"Request body used to create or update a relationship between an applicant and a contact or company","type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"},"isMain":{"description":"Flag denoting whether or not this relationship should be considered to be the main/primary relationship. Setting to true will automatically demote the existing primary relationship","type":"boolean"}},"example":{"associatedId":"OXF18000001","associatedType":"contact","isMain":false}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/applicants/{id}/relationships/{relationshipId}":{"get":{"tags":["Applicants"],"summary":"Gets a single relationship between this applicant and a contact/company","operationId":"GetApplicantRelationshipById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique applicant identifier","required":true,"type":"string"},{"in":"path","name":"relationshipId","description":"Unique relationship identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a relationship between an applicant and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"applicantId":{"description":"The unique identifier of the applicant","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent applicant entity","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","applicantId":"OXF190001","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"fromArchive":false,"_links":{"self":{"href":"/applicants/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Applicants"],"summary":"Deletes a specific relationship between this applicant and a contact/company","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique applicant identifier","required":true,"type":"string"},{"in":"path","name":"relationshipId","description":"Unique relationship identifier","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/areas/":{"get":{"tags":["Areas"],"summary":"Gets a collection of areas","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of areas to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/name)","type":"string"},{"in":"query","name":"id","description":"Only return areas where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"departmentId","description":"Only return areas where the `departmentId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return areas where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"name","description":"Only return areas where the `name` field matches the value provided","type":"string"},{"in":"query","name":"active","description":"Only return areas where the `active` field matches the value provided","type":"boolean"},{"in":"query","name":"createdFrom","description":"Only return areas where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return areas where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return areas where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return areas where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an area that properties reside in, or applicants are looking to buy/rent in","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the area","type":"string"},"created":{"format":"date-time","description":"The date and time when the area was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the area was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the area","type":"string"},"active":{"description":"A flag denoting whether the area can currently be selected against properties and applicants","type":"boolean"},"type":{"description":"The type of area (postcodes/polygon/group)","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"parentIds":{"description":"A collection of unique identifiers of parent area groups that this area is part of\r\nThis information can be used to understand the area hierarchy in a customer's system","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the area. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"BRM","created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","name":"Birmingham","active":true,"type":"polygon","area":["51.60009,-0.21789","51.47025,-0.27282","51.50445,0.00184"],"departmentIds":["G"],"officeIds":["OXF","SOL"],"parentIds":null,"_eTag":null,"_links":{"self":{"href":"/areas/BRM"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"departments":{"href":"/departments/?id=G"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/areas/?PageNumber=1&PageSize=1"},"first":{"href":"/areas/?PageNumber=1&PageSize=1"},"next":{"href":"/areas/?PageNumber=2&PageSize=1"},"last":{"href":"/areas/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Areas"],"summary":"Creates a new area","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the area","schema":{"description":"Request body used to create a new area","required":["name","type","area"],"type":"object","properties":{"name":{"description":"The name of the area","type":"string"},"type":{"description":"The type of area (postcodes/polygon/group)","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"parentId":{"description":"The unique identifier of the parent area, if the area should be registered as a child area/group in an existing area group","type":"string"}},"example":{"name":"Birmingham","type":"polygon","area":["51.60009,-0.21789","51.47025,-0.27282","51.50445,0.00184"],"departmentIds":["G"],"officeIds":["OXF","SOL"],"parentId":null}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/areas/{id}":{"get":{"tags":["Areas"],"summary":"Retrieves a specific area","operationId":"GetAreaById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the area","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an area that properties reside in, or applicants are looking to buy/rent in","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the area","type":"string"},"created":{"format":"date-time","description":"The date and time when the area was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the area was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the area","type":"string"},"active":{"description":"A flag denoting whether the area can currently be selected against properties and applicants","type":"boolean"},"type":{"description":"The type of area (postcodes/polygon/group)","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"parentIds":{"description":"A collection of unique identifiers of parent area groups that this area is part of\r\nThis information can be used to understand the area hierarchy in a customer's system","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the area. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"BRM","created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","name":"Birmingham","active":true,"type":"polygon","area":["51.60009,-0.21789","51.47025,-0.27282","51.50445,0.00184"],"departmentIds":["G"],"officeIds":["OXF","SOL"],"parentIds":null,"_eTag":null,"_links":{"self":{"href":"/areas/BRM"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"departments":{"href":"/departments/?id=G"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Areas"],"summary":"Updates an existing area","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the area to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the existing area","schema":{"description":"Request body used to update an existing area","type":"object","properties":{"name":{"description":"The name of the area","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}}},"example":{"name":"Birmingham","area":["51.60009,-0.21789","51.47025,-0.27282","51.50445,0.00184"],"departmentIds":["G"],"officeIds":["OXF","SOL"]}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/appointments/":{"get":{"tags":["Appointments"],"summary":"Gets a collection of calendar appointments.\r\nRecurring appointments can also be retrieved by specifying a `start` and `end` date along with any of the following query parameters: Id, NegotiatorId, PropertyId, AttendeeId","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of appointments to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (start/created/typeId)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the appointments returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["negotiators","offices","organiser","property","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return appointments where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"typeId","description":"Only return appointments where the `typeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return appointments where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return appointments where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return appointments where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"attendeeId","description":"Only return appointments where the `attendee.id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"attendeeType","description":"Only return appointments where the `attendee.type` field matches value provided ","type":"array","items":{"enum":["applicant","contact","landlord","tenancy"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"start","description":"Only return appointments where the `start` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"end","description":"Only return appointments where the `end` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"includeCancelled","description":"When true, include cancelled appointments","type":"boolean"},{"in":"query","name":"includeUnconfirmed","description":"When true, include unconfirmed appointments","type":"boolean"},{"in":"query","name":"fromArchive","description":"When true, return archived appointments","type":"boolean"},{"in":"query","name":"followUpFrom","description":"Only return appointments where the `followUp.due` field is on or after the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"followUpTo","description":"Only return appointments where the `followUp.due` field is on or before the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return appointments where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return appointments where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return appointments where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return appointments where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"metadata","description":"Only return appointments where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the appointment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the appointment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"recurring":{"description":"A flag denoting whether or not the appointment recurs","type":"boolean"},"recurrence":{"description":"Representation of an appointments recurrence details","type":"object","properties":{"interval":{"format":"int32","description":"The recurrence interval","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date the appointment recurs until","type":"string","example":"2019-08-14T12:30:02Z"}}},"cancelled":{"description":"A flag denoting whether or not the appointment has been cancelled","type":"boolean"},"followUp":{"description":"Follow up information relating to an appointment","type":"object","properties":{"due":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"Free text internal follow up notes to be stored against the appointment","type":"string"}}},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"fromArchive":{"description":"A flag determining whether or not the appointment is archived","type":"boolean"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the appointment","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the appointment. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF180001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","start":"2018-08-14T12:30:02Z","end":"2018-08-14T13:30:02Z","typeId":"VW","description":"Meet landlord at the property to get the key.","recurring":true,"recurrence":null,"cancelled":false,"followUp":{"due":"2018-10-05","responseId":"OXF190033","notes":"Meet at the property."},"propertyId":"OXF190022","organiserId":"JAS","negotiatorIds":["JAS"],"officeIds":["OXF","SOL"],"attendee":{"id":"OXF20001","type":"applicant","contacts":[{"id":"OXF19000001","name":"Mr John Smith","title":null,"forename":null,"surname":null,"homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","fromArchive":false,"marketingConsent":"grant"}]},"attended":"attended","accompanied":true,"isRepeat":false,"virtual":false,"negotiatorConfirmed":true,"attendeeConfirmed":true,"propertyConfirmed":true,"fromArchive":false,"otherAgentId":null,"documents":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/appointments/OXF180001"},"type":{"href":"/configuration/appointmentTypes/VW"},"organiser":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF190022"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"negotiators":{"href":"/negotiators/?id=JAS"},"attendee":{"href":"/applicants/OXF20001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/appointments/?PageNumber=1&PageSize=1"},"first":{"href":"/appointments/?PageNumber=1&PageSize=1"},"next":{"href":"/appointments/?PageNumber=2&PageSize=1"},"last":{"href":"/appointments/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Appointments"],"summary":"Creates an appointment in one or more negotiators diary","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create a new calendar appointment","required":["start","end","typeId"],"type":"object","properties":{"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"followUpOn":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"}}},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"recurrence":{"description":"Details of an appointment's recurrence pattern","type":"object","properties":{"interval":{"format":"int32","description":"The numeric value denoting how often the appointment will recur","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date and time when the recurrence will stop. (Required if 'type' is provided)","type":"string","example":"2019-08-14T12:30:02Z"}}},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata to set against the appointment","type":"object","additionalProperties":{}}},"example":{"start":"2018-08-14T12:30:02Z","end":"2018-08-14T13:30:02Z","followUpOn":"2018-10-05","typeId":"VW","description":"Meet landlord at the property to get the key.","organiserId":"JAS","negotiatorIds":["JAS"],"officeIds":["OXF","SOL"],"attendee":{"id":"OXF20001","type":"applicant"},"propertyId":"OXF190022","otherAgentId":null,"accompanied":true,"negotiatorConfirmed":true,"attendeeConfirmed":true,"propertyConfirmed":true,"virtual":false,"isRepeat":false,"attended":"noShow","recurrence":{"interval":0,"type":null,"until":null},"documents":{"draftPropertyInspectionReportId":null,"finalPropertyInspectionReportId":null},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/appointments/{id}":{"get":{"tags":["Appointments"],"summary":"Gets a single calendar appointment by its' unique identifier","operationId":"GetAppointmentById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique appointment identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the appointment returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["negotiators","offices","organiser","property","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the appointment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the appointment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"recurring":{"description":"A flag denoting whether or not the appointment recurs","type":"boolean"},"recurrence":{"description":"Representation of an appointments recurrence details","type":"object","properties":{"interval":{"format":"int32","description":"The recurrence interval","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date the appointment recurs until","type":"string","example":"2019-08-14T12:30:02Z"}}},"cancelled":{"description":"A flag denoting whether or not the appointment has been cancelled","type":"boolean"},"followUp":{"description":"Follow up information relating to an appointment","type":"object","properties":{"due":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"Free text internal follow up notes to be stored against the appointment","type":"string"}}},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"fromArchive":{"description":"A flag determining whether or not the appointment is archived","type":"boolean"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the appointment","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the appointment. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF180001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","start":"2018-08-14T12:30:02Z","end":"2018-08-14T13:30:02Z","typeId":"VW","description":"Meet landlord at the property to get the key.","recurring":true,"recurrence":null,"cancelled":false,"followUp":{"due":"2018-10-05","responseId":"OXF190033","notes":"Meet at the property."},"propertyId":"OXF190022","organiserId":"JAS","negotiatorIds":["JAS"],"officeIds":["OXF","SOL"],"attendee":{"id":"OXF20001","type":"applicant","contacts":[{"id":"OXF19000001","name":"Mr John Smith","title":null,"forename":null,"surname":null,"homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","fromArchive":false,"marketingConsent":"grant"}]},"attended":"attended","accompanied":true,"isRepeat":false,"virtual":false,"negotiatorConfirmed":true,"attendeeConfirmed":true,"propertyConfirmed":true,"fromArchive":false,"otherAgentId":null,"documents":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/appointments/OXF180001"},"type":{"href":"/configuration/appointmentTypes/VW"},"organiser":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF190022"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"negotiators":{"href":"/negotiators/?id=JAS"},"attendee":{"href":"/applicants/OXF20001"}},"_embedded":null}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Appointments"],"summary":"Updates an appointment in one or more negotiators' diary","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique appointment identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update an existing calendar appointment","type":"object","properties":{"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"followUpOn":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"cancelled":{"description":"A flag denoting whether or not the appointment has been cancelled","type":"boolean"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee. To clear an attendee this can be passed as an empty string.","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"},"confirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"}}},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"followUp":{"description":"Represents the follow up information on a single appointment","type":"object","properties":{"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"The internal follow up notes to be stored against the appointment","type":"string"}}},"recurrence":{"description":"Details of an appointment's recurrence pattern","type":"object","properties":{"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"interval":{"format":"int32","description":"The numeric value denoting how often the appointment will recur","type":"integer"},"until":{"format":"date-time","description":"The date and time when the recurrence will stop","type":"string","example":"2019-08-14T12:30:02Z"}}},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata to set against the appointment","type":"object","additionalProperties":{}}},"example":{"start":"2018-08-14T12:30:02Z","end":"2018-08-14T13:30:02Z","followUpOn":"2018-10-05","typeId":"VW","description":"Meet landlord at the property to get the key.","propertyId":"OXF190022","otherAgentId":null,"organiserId":"JAS","cancelled":false,"negotiatorIds":["JAS"],"officeIds":["OXF","SOL"],"attendee":{"id":"OXF20001","type":"applicant","confirmed":false},"accompanied":true,"virtual":null,"isRepeat":null,"negotiatorConfirmed":true,"attendeeConfirmed":true,"propertyConfirmed":true,"attended":"notSet","followUp":{"responseId":"OXF190022","notes":"Meet at the property."},"recurrence":null,"documents":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/appointments/{id}/openHouseAttendees":{"get":{"tags":["Appointments"],"summary":"Gets a collection of open house attendees for a specific open house appointment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The identifier of the open house appointment to retrieve attendees for","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of appointments to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the open house attendee","type":"string"},"openHouseId":{"description":"The unique identifier of the open house appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the open house attendee was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the open house attendee was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes taken regarding the open house attendee","type":"string"},"interestLevel":{"description":"The open house attendees interest level (veryInterested/notInterested/possibleInterest)","type":"string"},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"_eTag":{"description":"The ETag for the current version of the open house attendee. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF180004","openHouseId":"OXF1800001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","notes":"Coming back for a second viewing","interestLevel":"veryInterested","attendee":{"id":"OXF20001","type":"applicant","contacts":[{"id":"OXF19000001","name":"Mr John Smith","title":null,"forename":null,"surname":null,"homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","fromArchive":false,"marketingConsent":null}]},"_eTag":null,"_links":{"self":{"href":"/appointments/OXF1800001/openHouseAttendees/OXF180004"},"parent":{"href":"/appointments/OXF1800001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/appointments/OXF1800001/openHouseAttendees/?PageNumber=1&PageSize=1"},"first":{"href":"/appointments/OXF1800001/openHouseAttendees/?PageNumber=1&PageSize=1"},"next":{"href":"/appointments/OXF1800001/openHouseAttendees/?PageNumber=2&PageSize=1"},"last":{"href":"/appointments/OXF1800001/openHouseAttendees/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Appointments"],"summary":"Create an open house attendee against an open house appointment","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"path","name":"id","description":"The identifier of the open house appointment to create an attendee for","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body to create an open house attendee","schema":{"description":"Request body used to create a new open house attendee","type":"object","properties":{"interestLevel":{"description":"The interest level of the open house attendee (veryInterested/mightBeInterested/notInterested/notSet)","type":"string"},"notes":{"description":"Notes on this open house attendee","type":"string"},"attendee":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"}}}},"example":{"interestLevel":"veryInterested","notes":"Coming back for a second viewing.","attendee":{"id":"OXF200001","type":"applicant"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/appointments/{id}/openHouseAttendees/{openHouseAttendeeId}":{"get":{"tags":["Appointments"],"summary":"Gets a specific open house attendee for an open house appointment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The identifier of the open house appointment to retrieve the attendee for","required":true,"type":"string"},{"in":"path","name":"openHouseAttendeeId","description":"The identifier of the open house attendee to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the open house attendee","type":"string"},"openHouseId":{"description":"The unique identifier of the open house appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the open house attendee was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the open house attendee was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes taken regarding the open house attendee","type":"string"},"interestLevel":{"description":"The open house attendees interest level (veryInterested/notInterested/possibleInterest)","type":"string"},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"_eTag":{"description":"The ETag for the current version of the open house attendee. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF180004","openHouseId":"OXF1800001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","notes":"Coming back for a second viewing","interestLevel":"veryInterested","attendee":{"id":"OXF20001","type":"applicant","contacts":[{"id":"OXF19000001","name":"Mr John Smith","title":null,"forename":null,"surname":null,"homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","fromArchive":false,"marketingConsent":null}]},"_eTag":null,"_links":{"self":{"href":"/appointments/OXF1800001/openHouseAttendees/OXF180004"},"parent":{"href":"/appointments/OXF1800001"}},"_embedded":null}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Appointments"],"summary":"Updates an open house attendee against an open house appointment","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The identifier of the open house appointment to update an attendee for","required":true,"type":"string"},{"in":"path","name":"openHouseAttendeeId","description":"The identifier of the open house attendee to update","required":true,"type":"string"},{"in":"body","name":"body","description":"Request body to update an open house attendee","schema":{"description":"Request body used to upda te a new open house attendee","type":"object","properties":{"interestLevel":{"description":"The interest level of the open house attendee (veryInterested/mightBeInterested/notInterested/notSet)","type":"string"},"notes":{"description":"Notes on this open house attendee","type":"string"}},"example":{"interestLevel":"mightBeInterested","notes":"Coming back for a second viewing."}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Appointments"],"summary":"Removes a specific open house attendee from an open house appointment","parameters":[{"in":"path","name":"id","description":"The identifier of the open house appointment to remove the attendee from","required":true,"type":"string"},{"in":"path","name":"openHouseAttendeeId","description":"The identifier of the open house attendee to remove","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/auctions/lots":{"get":{"tags":["Auctions"],"summary":"Retrieves a collection of lots.","produces":["application/json"],"parameters":[{"in":"query","name":"pageNumber","description":"The page number to return.","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of lots to be returned per page. Value can range between 1 and 100, and\r\nthe default is 25.","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction.","type":"string"},{"in":"query","name":"createdFrom","description":"Only return lots where the `created` field is on or after to the ISO8601 date and time provided.","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return lots where the `created` field is on or before the ISO8601 date and time provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return lots where the `modified` field is on or after to the ISO8601 date and time\r\nprovided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return lots where the `modified` field is on or before the ISO8601 date and time provided.","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents an auction lot","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the lot","type":"string"},"created":{"format":"date-time","description":"The date and time when the lot was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the lot was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this lot is for","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator handling this lot","type":"string"},"lotNumber":{"description":"The number for this lot","type":"string"},"status":{"description":"The status of the property in the lot","type":"string"},"auction":{"description":"Represents an auction","type":"object","properties":{"id":{"description":"The unique identifier of the auction","type":"string"},"auctionCode":{"description":"The code of the auction","type":"string"},"venueId":{"description":"The unique identifier of the venue","type":"string"}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT250001","created":"2026-06-18T18:13:38.7890191Z","modified":"2026-06-17T18:13:38.7890193Z","propertyId":"RPT240001","negotiatorId":"RPT","lotNumber":"12","status":"forSale","auction":{"id":"RPT250001","auctionCode":"AUCT","venueId":"RPT25000001"},"_links":{"self":{"href":"/lots/RPT250001"},"property":{"href":"/properties/RPT240001"},"negotiator":{"href":"/negotiators/RPT"},"venue":{"href":"/companies/RPT25000001"}},"_embedded":null}],"pageNumber":1,"pageSize":25,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/lots/?PageNumber=1&PageSize=25"},"first":{"href":"/lots/?PageNumber=1&PageSize=25"}}}}},"400":{"description":"Bad Request"}},"security":[{"Authorization":[]}]}},"/auctions/lots/{id}":{"get":{"tags":["Auctions"],"summary":"Retrieves a single lot.","produces":["application/json"],"parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Represents an auction lot","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the lot","type":"string"},"created":{"format":"date-time","description":"The date and time when the lot was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the lot was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this lot is for","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator handling this lot","type":"string"},"lotNumber":{"description":"The number for this lot","type":"string"},"status":{"description":"The status of the property in the lot","type":"string"},"auction":{"description":"Represents an auction","type":"object","properties":{"id":{"description":"The unique identifier of the auction","type":"string"},"auctionCode":{"description":"The code of the auction","type":"string"},"venueId":{"description":"The unique identifier of the venue","type":"string"}}}}},"examples":{"application/json":{"id":"RPT250001","created":"2026-06-18T18:13:38.7912524Z","modified":"2026-06-17T18:13:38.7912526Z","propertyId":"RPT240001","negotiatorId":"RPT","lotNumber":"12","status":"forSale","auction":{"id":"RPT250001","auctionCode":"AUCT","venueId":"RPT25000001"},"_links":{"self":{"href":"/lots/RPT250001"},"property":{"href":"/properties/RPT240001"},"negotiator":{"href":"/negotiators/RPT"},"venue":{"href":"/companies/RPT25000001"}},"_embedded":null}}},"400":{"description":"Bad Request"}},"security":[{"Authorization":[]}]}},"/certificates/":{"get":{"tags":["Certificates"],"summary":"Retrieves a collection of certificates.","produces":["application/json"],"parameters":[{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0).","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of properties to be returned per page. Value can range between 1 and 100,\r\nand the default is 25.","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction.","type":"string"},{"in":"query","name":"createdFrom","description":"Only return certificates where the `created` field is on or after to the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return certificates where the `created` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return certificates where the `modified` field is on or after to the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return certificates where the `modified` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"endDateFrom","description":"Only return certificates where the `endDate` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"endDateTo","description":"Only return certificates where the `endDate` field is on or before the value provided.","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate.","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property associated with this certificate.","type":"string"},"estateId":{"description":"The unique identifier of the estate associated with this certificate.","type":"string"},"blockId":{"description":"The unique identifier of the block associated with this certificate.","type":"string"},"companyId":{"description":"The unique identifier of the company which provides this certificate.","type":"string"},"category":{"description":"The cartificate category.","type":"string"},"type":{"description":"The type of certificate.","type":"string"},"statusId":{"description":"The status ID of the certificate.","type":"string"},"notes":{"description":"General notes relating to the certificate.","type":"string"},"startDate":{"format":"date-time","description":"The start date.","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The end date.","type":"string","example":"2019-08-14T12:30:02Z"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"CRT24000001","created":"2024-06-01T11:30:12Z","modified":"2024-07-04T09:12:45Z","propertyId":"PRP240001","estateId":"EST240001","blockId":"BLK240001","companyId":"CMP24000001","category":"safetyCertificate","type":"gasSafety","statusId":"","notes":"General notes for this certificate","startDate":"2024-06-01","endDate":"2025-03-01","_links":{"self":{"href":"/certificates/CRT24000001"},"property":{"href":"/properties/PRP240001"},"company":{"href":"/companies/CMP24000001"}},"_embedded":null}],"pageNumber":1,"pageSize":25,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/certificates/?PageNumber=1&PageSize=25"},"first":{"href":"/certificates/?PageNumber=1&PageSize=25"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}}},"security":[{"Authorization":[]}]}},"/certificates/{id}":{"get":{"tags":["Certificates"],"summary":"Retrieves full details of a single certificate.","produces":["application/json"],"parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate.","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property associated with this certificate.","type":"string"},"estateId":{"description":"The unique identifier of the estate associated with this certificate.","type":"string"},"blockId":{"description":"The unique identifier of the block associated with this certificate.","type":"string"},"companyId":{"description":"The unique identifier of the company which provides this certificate.","type":"string"},"category":{"description":"The cartificate category.","type":"string"},"type":{"description":"The type of certificate.","type":"string"},"statusId":{"description":"The status ID of the certificate.","type":"string"},"notes":{"description":"General notes relating to the certificate.","type":"string"},"startDate":{"format":"date-time","description":"The start date.","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The end date.","type":"string","example":"2019-08-14T12:30:02Z"}}},"examples":{"application/json":{"id":"CRT24000001","created":"2024-06-01T11:30:12Z","modified":"2024-07-04T09:12:45Z","propertyId":"PRP240001","estateId":"EST240001","blockId":"BLK240001","companyId":"CMP24000001","category":"safetyCertificate","type":"gasSafety","statusId":"","notes":"General notes for this certificate","startDate":"2024-06-01","endDate":"2025-03-01","_links":{"self":{"href":"/certificates/CRT24000001"},"property":{"href":"/properties/PRP240001"},"company":{"href":"/companies/CMP24000001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}}},"security":[{"Authorization":[]}]}},"/companies/":{"get":{"tags":["Companies"],"summary":"Gets a paged collection of companies","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of companies to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the companies returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["companyTypes","relationships"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return companies where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"address","description":"Only return companies where the `address` field matches the value provided","type":"string"},{"in":"query","name":"branch","description":"Only return companies where the `branch` field matches the value provided","type":"string"},{"in":"query","name":"name","description":"Only return companies where the `name` field matches the value provided","type":"string"},{"in":"query","name":"typeId","description":"Only return companies where the `typeId` field matches the value provided","type":"string"},{"in":"query","name":"negotiatorId","description":"Only return companies where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return companies where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"contactDetail","description":"Only return companies where at least one of the contact details matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"fromArchive","description":"Only return companies where the `fromArchive` field matches the value given","type":"boolean"},{"in":"query","name":"createdFrom","description":"Only return companies where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return companies where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return companies where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return companies where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return companies where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the company","type":"string"},"created":{"format":"date-time","description":"The date and time when the company was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the company was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company","type":"string"},"email":{"description":"The email address of the company","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the company was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the company is archived","type":"boolean"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"country":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"payments":{"description":"Representation of the payments and terms configuration for a company","type":"object","properties":{"nominalAccountId":{"description":"The identifier of the nominal code selected in the payments and terms configuration","type":"string"},"agentCommissionPercentage":{"format":"double","description":"The commission paid as a percentage to the agent","type":"number"},"referralFee":{"format":"double","description":"The fixed referral amount the supplier receives","type":"number"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the company. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the company. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the company","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the company. Used for managing update concurrency","type":"string","readOnly":true},"relationships":{"description":"A list of relationships belonging to the company. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual companies possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the related company","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF19002002","created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","name":"Reapit","branch":"Oxford","notes":"Founded in 1997, The Reapit Group is a property software provider of CRM and property management solutions specialising in the residential real estate sector","active":true,"marketingConsent":"notAsked","vatRegistered":true,"typeIds":["SP"],"supplierTypeId":"MG","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","archivedOn":null,"fromArchive":false,"address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","country":"GB"},"payments":{"nominalAccountId":"nomcode","agentCommissionPercentage":20,"referralFee":2500},"additionalContactDetails":null,"officeIds":["OXF"],"negotiatorIds":["JAS"],"communicationPreferenceLetter":false,"communicationPreferenceEmail":true,"communicationPreferencePhone":false,"communicationPreferenceSms":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/companies/OXF19002002"},"companyTypes":{"href":"/configuration/companyTypes/?id=SP"},"relationships":{"href":"/companies/OXF19002002/relationships"},"supplierType":{"href":"/configuration/supplierTypes/MG"},"account":{"href":"/transactions/nominalAccounts/nomcode"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/companies/?PageNumber=1&PageSize=1"},"first":{"href":"/companies/?PageNumber=1&PageSize=1"},"next":{"href":"/companies/?PageNumber=2&PageSize=1"},"last":{"href":"/companies/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Companies"],"summary":"Creates a new company","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the company","schema":{"description":"Request body used to create a new company","required":["name","typeIds"],"type":"object","properties":{"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company. (Required when no other company or address details are provided)","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company. (Required when no other company or address details are provided)","type":"string"},"email":{"description":"The email address of the company. (Required when no other company or address details are provided)","type":"string"},"address":{"description":"Request body to set the address of a new company","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata to set against the company","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","branch":"Oxford","notes":"Founded in 1997, The Reapit Group is a property software provider of CRM and property management solutions specialising in the residential real estate sector","active":true,"marketingConsent":"deny","vatRegistered":true,"typeIds":["SP"],"supplierTypeId":"MG","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"type":null,"buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"communicationPreferenceLetter":false,"communicationPreferenceEmail":true,"communicationPreferencePhone":false,"communicationPreferenceSms":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/companies/{id}":{"get":{"tags":["Companies"],"summary":"Gets a single company by its' unique identifier","operationId":"GetCompanyById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique company identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the company returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["companyTypes","relationships"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the company","type":"string"},"created":{"format":"date-time","description":"The date and time when the company was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the company was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company","type":"string"},"email":{"description":"The email address of the company","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the company was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the company is archived","type":"boolean"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"country":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"payments":{"description":"Representation of the payments and terms configuration for a company","type":"object","properties":{"nominalAccountId":{"description":"The identifier of the nominal code selected in the payments and terms configuration","type":"string"},"agentCommissionPercentage":{"format":"double","description":"The commission paid as a percentage to the agent","type":"number"},"referralFee":{"format":"double","description":"The fixed referral amount the supplier receives","type":"number"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the company. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the company. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the company","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the company. Used for managing update concurrency","type":"string","readOnly":true},"relationships":{"description":"A list of relationships belonging to the company. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual companies possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the related company","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}}}},"examples":{"application/json":{"id":"OXF19002002","created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","name":"Reapit","branch":"Oxford","notes":"Founded in 1997, The Reapit Group is a property software provider of CRM and property management solutions specialising in the residential real estate sector","active":true,"marketingConsent":"notAsked","vatRegistered":true,"typeIds":["SP"],"supplierTypeId":"MG","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","archivedOn":null,"fromArchive":false,"address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","country":"GB"},"payments":{"nominalAccountId":"nomcode","agentCommissionPercentage":20,"referralFee":2500},"additionalContactDetails":null,"officeIds":["OXF"],"negotiatorIds":["JAS"],"communicationPreferenceLetter":false,"communicationPreferenceEmail":true,"communicationPreferencePhone":false,"communicationPreferenceSms":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/companies/OXF19002002"},"companyTypes":{"href":"/configuration/companyTypes/?id=SP"},"relationships":{"href":"/companies/OXF19002002/relationships"},"supplierType":{"href":"/configuration/supplierTypes/MG"},"account":{"href":"/transactions/nominalAccounts/nomcode"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Companies"],"summary":"Updates a company by unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the company to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the company.","schema":{"description":"Request body used to update an existing company","type":"object","properties":{"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company","type":"string"},"email":{"description":"The email address of the company","type":"string"},"address":{"description":"Request body to set the address of an existing company","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata to set against the company","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","branch":"Oxford","notes":"Founded in 1997, The Reapit Group is a property software provider of CRM and property management solutions specialising in the residential real estate sector","active":true,"marketingConsent":"deny","vatRegistered":true,"typeIds":["SP"],"supplierTypeId":"MG","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"type":null,"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"communicationPreferenceLetter":false,"communicationPreferenceEmail":true,"communicationPreferencePhone":false,"communicationPreferenceSms":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/companies/{id}/relationships":{"get":{"tags":["Companies"],"summary":"Retrieve details of the roles/relationships for a specific company","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the company","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of companies to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of the roles that an individual companies possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the related company","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/companies/{id}/staffMembers":{"get":{"tags":["Companies"],"summary":"Gets a collection of staff members for a company","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique company identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a staff member","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact.","type":"string"},"index":{"description":"The index of the staff member when they are not a full contact","type":"string"},"name":{"description":"The staff member's name","type":"string"},"active":{"description":"A flag determining whether or not the staff member is currently active","type":"boolean"},"jobTitle":{"description":"The staff member's job title","type":"string"},"workPhone":{"description":"The staff member's work phone","type":"string"},"mobilePhone":{"description":"The staff member's mobile phone","type":"string"},"email":{"description":"The staff member's email","type":"string"},"salutation":{"description":"The staff member's preferred salutation","type":"string"},"isContact":{"description":"Flag to determine if this staff member is a full contact.","type":"boolean"},"isMainContact":{"description":"Flag to determin if this staff member is a main contact","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":null,"index":null,"name":"John Smith","active":true,"jobTitle":"Managing Director","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","salutation":null,"isContact":true,"isMainContact":true,"_links":null,"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/companies/CMP12300054/staffMembers/?PageNumber=1&PageSize=1"},"first":{"href":"/companies/CMP12300054/staffMembers/?PageNumber=1&PageSize=1"},"next":{"href":"/companies/CMP12300054/staffMembers/?PageNumber=2&PageSize=1"},"last":{"href":"/companies/CMP12300054/staffMembers/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/companies/{id}/accreditations":{"get":{"tags":["Companies"],"summary":"Gets a collection of a company's accreditations","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the company","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents an accreditation for a company.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the company","type":"string"},"created":{"format":"date-time","description":"The date and time when the company was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the company was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of accreditation.","type":"string"},"expiry":{"format":"date-time","description":"The date of expiry for the accreditation.","type":"string","example":"2019-08-14T12:30:02Z"},"details":{"description":"The details relating to this accreditation.","type":"string"},"_eTag":{"description":"The ETag for the current version of the company. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"CMP25000001","created":"0001-01-01T00:00:00Z","modified":null,"type":"gasSafety","expiry":"2025-06-30","details":"Example details","_eTag":null,"_links":null,"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/companies/CMP25000001/accreditations/?PageNumber=1&PageSize=1"},"first":{"href":"/companies/CMP25000001/accreditations/?PageNumber=1&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/companies/{id}/accreditations/{type}":{"patch":{"tags":["Companies"],"summary":"Updates a company accreditation by type","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the company","required":true,"type":"string"},{"in":"path","name":"type","description":"The type of accreditation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the accreditation","schema":{"description":"Request body used to update an existing company accreditation","type":"object","properties":{"expiry":{"format":"date-time","description":"The date of expiry for the accreditation.","type":"string","example":"2019-08-14T12:30:02Z"},"details":{"description":"The details relating to this accreditation.","type":"string"}},"example":{"expiry":"2027-06-18T18:13:39.3438235Z","details":"Updated accreditation details"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/configuration/types":{"get":{"tags":["Configuration"],"summary":"Gets up to 5 different configuration types in a single request","produces":["application/json"],"parameters":[{"in":"query","name":"type","description":"A list of configuration types to retrieve. You must provide between 1 and 5 types. ","type":"array","items":{"enum":["agencyTypes","appointmentTypes","applicantStatuses","boardStatuses","buyingPositions","buyingReasons","certificateTypes","companyTypes","contactCategories","identityDocumentTypes","documentTypes","journalEntryTypes","keyTypes","followUpResponses","sellingReasons","rentInsuranceCancellationReasons","rentingPositions","supplierTypes","taskTypes","tenancyLegalStatuses","tenancyTypes","vendorTypes","worksOrderTypes"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of all of the available configurable items","type":"object","properties":{"agencyTypes":{"description":"A list of configurable agency types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"appointmentTypes":{"description":"A list of configurable appointment types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"applicantStatuses":{"description":"A list of configurable applicant statuses","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"boardStatuses":{"description":"A list of configurable board statuses","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"buyingPositions":{"description":"A list of configurable buying positions","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"buyingReasons":{"description":"A list of configurable buying reasons","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"certificateTypes":{"description":"A list of configurable certificate types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"companyTypes":{"description":"A list of configurable company types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"contactCategories":{"description":"A list of configurable contact categories","type":"array","items":{"description":"Representation of heirarchical category configuration items with a type.","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"type":{"description":"The category type.","type":"string"}}}},"documentTypes":{"description":"A list of configurable document types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"identityDocumentTypes":{"description":"A list of configurable identity document types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"journalEntryTypes":{"description":"A list of configurable journal entry types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"keyTypes":{"description":"A list of configurable key types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"followUpResponses":{"description":"A list of configurable follow up responses","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"sellingReasons":{"description":"A list of configurable selling reasons","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"rentInsuranceCancellationReasons":{"description":"A list of configurable rent insurance cancellation reasons","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"rentingPositions":{"description":"A list of configurable renting positions","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"supplierTypes":{"description":"A list of configurable supplier types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"taskTypes":{"description":"A list of configurable task types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"tenancyLegalStatuses":{"description":"A list of configurable tenancy legal status","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"tenancyTypes":{"description":"A list of configurable tenancy types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"vendorTypes":{"description":"A list of configurable vendor types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"worksOrderTypes":{"description":"A list of configurable works order types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/agencyTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of agency types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/agencyTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single agency type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the agency type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/alarmTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of alarm types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/alarmTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single alarm type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the alarm type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/alarmCategories":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of alarm categories","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/alarmCategories/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single alarm category","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the alarm category to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/applicantStatuses/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single applicant status","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the applicant status to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/applicantStatuses":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of applicant statuses","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return items where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/appointmentTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of appointment types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/appointmentTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single appointment type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the appointment type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/boardStatuses":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of board statuses","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/boardStatuses/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single board status","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the board status to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/buyingPositions":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of buying positions","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/buyingPositions/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single buying position","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the buying position to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/buyingReasons":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of buying reasons","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/certificateTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of certificate types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a certificate type","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"statuses":{"description":"The configurable statuses associated to the certificate type","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/certificateTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single certificate type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the certificate type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a certificate type","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"statuses":{"description":"The configurable statuses associated to the certificate type","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/certificateTypes/{typeId}/statuses":{"get":{"tags":["Configuration"],"summary":"Gets the statuses for a given certificate type.","produces":["application/json"],"parameters":[{"in":"path","name":"typeId","description":"The unique identifier of the certificate type.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/companyTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of company types","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return items where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/companyTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single company type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the company type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/contactCategories/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single contact category","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the contact category to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/contactCategories":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of contact categories","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return items where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of heirarchical category configuration items with a type.","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"type":{"description":"The category type.","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/documentTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of document types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/documentTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single document type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the document type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/followUpResponses":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of pre-defined appointment follow up feedback responses","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/followUpResponses/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single pre-defined appointment follow up feedback response","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the follow up feedback response option to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/identityDocumentTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of ID document types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/identityDocumentTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single ID document type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the ID document type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/journalEntryTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of journal entry types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/journalEntryTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single journal entry type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the journal entry type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/keyTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of key types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/keyTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single key type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the key type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/portalTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of portal types","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return items where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/portalTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a portal type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the portal type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/preTenancyCheckTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of configured pre tenancy checks","produces":["application/json"],"parameters":[{"in":"query","name":"active","type":"boolean"},{"in":"query","name":"officeId","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of detail properties configuration item\r\nconfiguration","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"active":{"description":"A flag determining the status","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices associated","type":"array","items":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/preTenancyCheckTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a configured pre tenancy check by id","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the pre tenancy check to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of detail properties configuration item\r\nconfiguration","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"active":{"description":"A flag determining the status","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices associated","type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/preTenancyCheckStatuses":{"get":{"tags":["Configuration"],"summary":"Get the configured pre-tenancy checklist statuses","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/preTenancyCheckStatuses/{id}":{"get":{"tags":["Configuration"],"summary":"Get a configured pre-tenancy checklist status by id","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the pre-tenancy checklist status","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/propertyServiceTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of property services","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/propertyServiceTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single property service","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the appointment type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/renewalCheckTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of configured renewal negotiation checks","produces":["application/json"],"parameters":[{"in":"query","name":"active","type":"boolean"},{"in":"query","name":"officeId","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of detail properties configuration item\r\nconfiguration","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"active":{"description":"A flag determining the status","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices associated","type":"array","items":{"type":"string"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/renewalCheckTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a configured renewal check by id","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the renewal check to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of detail properties configuration item\r\nconfiguration","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"active":{"description":"A flag determining the status","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices associated","type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/rentInsuranceCancellationReasons":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of rent protection insurance cancellation reasons","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/rentInsuranceCancellationReasons/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single rent protection insurance cancellation reason by it's id","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the rent protection insurance cancellation reason to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/rentingPositions":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of renting positions","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/rentingPositions/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single renting position","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the renting position to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/ruralTenancyTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of rural tenancy types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/ruralTenancyTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a rural tenancy type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the rural tenancy type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/sellingReasons":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of vendor selling reasons","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/sellingReasons/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single vendor selling reason","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the vendor selling reason to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/supplierTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of supplier types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/supplierTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single supplier type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the supplier type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/taskTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of task types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/taskTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single task type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the task type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyLegalStatuses":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of tenancy legal statuses","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyLegalStatuses/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single tenancy legal status","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the tenancy legal status to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyRenewalOptions":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of tenancy renewal options","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return items where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyRenewalOptions/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a tenancy renewal option","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the tenancy renewal option to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyRenewalOptionConditions":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of conditions relating to tenancy renewal options","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return items where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyRenewalOptionConditions/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a tenancy renewal option condition","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the tenancy renewal option condition to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of tenancy types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single tenancy type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the tenancy type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/vendorTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of vendor types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/vendorTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single vendor type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the vendor type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/worksOrderTypes":{"get":{"tags":["Configuration"],"summary":"Gets the full listing of work order types","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/configuration/worksOrderTypes/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single work order type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The id of the work order type to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/terminology":{"get":{"tags":["Configuration"],"summary":"Gets the full Lists of terminologies associated","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"description":"Representation of the configuration settings for terminology","type":"object","properties":{"properties":{"description":"Terminologies associated with the properties","type":"object","properties":{"useSoldStc":{"description":"A flag denoting whether the agent's CRM is configured to use \"Sold STC/SSTC\" terminology instead of \"Under Offer\"","type":"boolean"},"useMarketAppraisal":{"description":"A flag denoting whether the agent's CRM is configured to use \"Market Appraisal\" terminology instead of \"Valuation\"","type":"boolean"}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyFinishedReasons":{"get":{"tags":["Configuration"],"summary":"Gets the full list of tenancy finished reasons","produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of heirarchical category configuration items with a category","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"category":{"description":"The category for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/tenancyFinishedReasons/{id}":{"get":{"tags":["Configuration"],"summary":"Gets a single tenancy finished reason by the given unique identifier.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the tenancy finished reason.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of heirarchical category configuration items with a category","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"category":{"description":"The category for the list item","type":"string"}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/propertyDescriptions":{"get":{"tags":["Configuration"],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"description1":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description2":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description3":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description4":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description5":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description6":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/configuration/activeLanguages":{"get":{"tags":["Configuration"],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/contacts/":{"get":{"tags":["Contacts"],"summary":"Retrieve a collection of contacts","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of contacts to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/name/address)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the contacts returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["documents","identityChecks","negotiators","offices","relationships","source","landlordDetails"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return contacts where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"contactDetail","description":"Only return contacts where at least one of the contact details matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"email","description":"Only return contacts where the `email` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return contacts where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return contacts where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"address","description":"Only return contacts where the `primaryAddress` field matches the value provided","type":"string"},{"in":"query","name":"identityCheck","description":"Only return contacts where the `identityCheck` field matches the value provided ","type":"array","items":{"enum":["pass","fail","pending","warnings","unchecked"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"name","description":"Only return contacts where the `title`, `forename` and/or `surname` field matches the value provided","type":"string"},{"in":"query","name":"nameType","description":"Specify the kind of name filter being applied. When not specified, a full name search will be carried out which is slower than a quicker surname/initials search, (initials/surname)","type":"string"},{"in":"query","name":"marketingConsent","description":"Only return contacts where the `marketingConsent` field matches the value provided ","type":"array","items":{"enum":["grant","deny","notAsked"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"marketingConsentFilterType","description":"Controls the behaviour when filtering contacts by consent status. When set to `assumedOrExplicit` any contacts registered before GDPR regulations were\r\nintroduced in the United Kingdom will be returned as permission granted if the contact has not explicitly been asked, or denied if the contact was registered\r\nafter the regulations were introduced. The default behaviour when this option is not specified is `explicit` ","type":"array","items":{"enum":["assumedOrExplicit","explicit"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"active","description":"Only return contacts where the `active` field matches the value provided","type":"boolean"},{"in":"query","name":"fromArchive","description":"Only return contacts where the `fromArchive` field matches the value given","type":"boolean"},{"in":"query","name":"createdFrom","description":"Only return contacts where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return contacts where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return contacts where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return contacts where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return contacts where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact","type":"string"},"created":{"format":"date-time","description":"The date and time when the contact was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the contact was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"identityCheck":{"description":"The status of the last identity check performed against the contact (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"source":{"description":"Representation of a contact's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the contact was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the contact is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"secondaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"workAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the contact","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the contact. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"relationships":{"description":"A list of relationships belonging to the contact. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual contacts possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"contactId":{"description":"The unique identifier of the related contact","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"landlordDetails":{"description":"Representation of landlord details for a contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact landlord details","type":"string"},"makingTaxDigitalOptInStatus":{"description":"The making tax digital opt-in state (notAsked/optedIn/optedOut)","type":"string"},"makingTaxDigitalOptInStatusDate":{"format":"date-time","description":"The date when the making tax digital opt-in state was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state (notSet/invited/accepted/revoked)","type":"string"}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF18000001","created":"2018-02-12T09:45:01Z","modified":"2019-06-23T12:30:12Z","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","active":true,"marketingConsent":"grant","identityCheck":null,"source":{"id":"SOL","type":"office"},"homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","archivedOn":null,"fromArchive":false,"primaryAddress":{"type":"primary","buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":null,"postcode":"B91 2XX","countryId":"GB"},"secondaryAddress":null,"workAddress":{"type":"work","buildingName":null,"buildingNumber":"44","line1":"Test street","line2":"Shirley","line3":"West Midlands","line4":null,"postcode":"B90 1ZZ","countryId":"GB"},"officeIds":["OXF"],"negotiatorIds":["JAS"],"categoryIds":[],"communicationPreferenceLetter":false,"communicationPreferenceEmail":false,"communicationPreferencePhone":false,"communicationPreferenceSMS":false,"additionalContactDetails":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"extrasField":null,"_links":{"self":{"href":"/contacts/OXF18000001"},"documents":{"href":"/documents/?associatedType=contact&associatedId=OXF18000001"},"identityChecks":{"href":"/identityChecks/?contactId=OXF18000001"},"offices":{"href":"/offices/?id=OXF"},"negotiators":{"href":"/negotiators/?id=JAS"},"relationships":{"href":"/contacts/OXF18000001/relationships"},"subscriptions":{"href":"/contacts/OXF18000001/subscriptions"},"source":{"href":"/offices/SOL"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":50,"_links":{"self":{"href":"/contacts/?PageNumber=1&PageSize=1"},"first":{"href":"/contacts/?PageNumber=1&PageSize=1"},"next":{"href":"/contacts/?PageNumber=2&PageSize=1"},"last":{"href":"/contacts/?PageNumber=50&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Contacts"],"summary":"Create a new contact","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the contact","schema":{"description":"Request body used to create a new contact","required":["surname","marketingConsent","officeIds","negotiatorIds"],"type":"object","properties":{"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"source":{"description":"Request body used to set the source of a new contact","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact (Required when no other contact details are provided)","type":"string"},"workPhone":{"description":"The work phone number of the contact (Required when no other contact details are provided)","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact (Required when no other contact details are provided)","type":"string"},"email":{"description":"The email address of the contact (Required when no other contact details are provided)","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"primaryAddress":{"description":"Request body used to set an address against a new contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"secondaryAddress":{"description":"Request body used to set an address against a new contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"workAddress":{"description":"Request body used to set an address against a new contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata to set against the contact","type":"object","additionalProperties":{}}},"example":{"title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","active":true,"marketingConsent":"grant","source":{"id":"SOL","type":"office"},"homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","officeIds":["OXF"],"negotiatorIds":["JAS"],"categoryIds":[],"primaryAddress":{"type":"primary","buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"secondaryAddress":null,"workAddress":{"type":"work","buildingName":"","buildingNumber":"44","line1":"Test street","line2":"Shirley","line3":"West Midlands","line4":"","postcode":"B90 1ZZ","countryId":"GB"},"communicationPreferenceLetter":true,"communicationPreferenceEmail":true,"communicationPreferencePhone":true,"communicationPreferenceSMS":true,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/contacts/{id}":{"get":{"tags":["Contacts"],"summary":"Retrieve a specific contact","operationId":"GetContactById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the contact returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["documents","identityChecks","negotiators","offices","relationships","source","landlordDetails"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an individual contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact","type":"string"},"created":{"format":"date-time","description":"The date and time when the contact was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the contact was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"identityCheck":{"description":"The status of the last identity check performed against the contact (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"source":{"description":"Representation of a contact's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the contact was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the contact is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"secondaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"workAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the contact","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the contact. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"relationships":{"description":"A list of relationships belonging to the contact. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual contacts possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"contactId":{"description":"The unique identifier of the related contact","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"landlordDetails":{"description":"Representation of landlord details for a contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact landlord details","type":"string"},"makingTaxDigitalOptInStatus":{"description":"The making tax digital opt-in state (notAsked/optedIn/optedOut)","type":"string"},"makingTaxDigitalOptInStatusDate":{"format":"date-time","description":"The date when the making tax digital opt-in state was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state (notSet/invited/accepted/revoked)","type":"string"}}}}},"examples":{"application/json":{"id":"OXF18000001","created":"2018-02-12T09:45:01Z","modified":"2019-06-23T12:30:12Z","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","active":true,"marketingConsent":"grant","identityCheck":null,"source":{"id":"SOL","type":"office"},"homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","archivedOn":null,"fromArchive":false,"primaryAddress":{"type":"primary","buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":null,"postcode":"B91 2XX","countryId":"GB"},"secondaryAddress":null,"workAddress":{"type":"work","buildingName":null,"buildingNumber":"44","line1":"Test street","line2":"Shirley","line3":"West Midlands","line4":null,"postcode":"B90 1ZZ","countryId":"GB"},"officeIds":["OXF"],"negotiatorIds":["JAS"],"categoryIds":[],"communicationPreferenceLetter":false,"communicationPreferenceEmail":false,"communicationPreferencePhone":false,"communicationPreferenceSMS":false,"additionalContactDetails":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"extrasField":null,"_links":{"self":{"href":"/contacts/OXF18000001"},"documents":{"href":"/documents/?associatedType=contact&associatedId=OXF18000001"},"identityChecks":{"href":"/identityChecks/?contactId=OXF18000001"},"offices":{"href":"/offices/?id=OXF"},"negotiators":{"href":"/negotiators/?id=JAS"},"relationships":{"href":"/contacts/OXF18000001/relationships"},"subscriptions":{"href":"/contacts/OXF18000001/subscriptions"},"source":{"href":"/offices/SOL"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Contacts"],"summary":"Update a contact","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier for the contact to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the contact.","schema":{"description":"Request body used to update an existing contact","type":"object","properties":{"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"source":{"description":"Request body used to update the source of an existing contact","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"primaryAddress":{"description":"Request body used to update an address on an existing contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the adderess resides in","type":"string"}}},"secondaryAddress":{"description":"Request body used to update an address on an existing contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the adderess resides in","type":"string"}}},"workAddress":{"description":"Request body used to update an address on an existing contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the adderess resides in","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"fromArchive":{"description":"A flag determining whether the contact is archived","type":"boolean"},"metadata":{"description":"App specific metadata to set against the contact","type":"object","additionalProperties":{}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"object","additionalProperties":{"type":"string"}}},"example":{"title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","active":true,"marketingConsent":"grant","source":{"id":"SOL","type":"office"},"homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","officeIds":["OXF"],"negotiatorIds":["JAS"],"categoryIds":null,"primaryAddress":{"type":"primary","buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":null,"postcode":"B91 2XX","countryId":"GB"},"secondaryAddress":null,"workAddress":{"type":"work","buildingName":null,"buildingNumber":"44","line1":"Test street","line2":"Shirley","line3":"West Midlands","line4":null,"postcode":"B90 1ZZ","countryId":"GB"},"communicationPreferenceLetter":true,"communicationPreferenceEmail":false,"communicationPreferencePhone":false,"communicationPreferenceSMS":false,"fromArchive":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"additionalContactDetails":{"Wifes Mobile":"07123 456789","Son":"example2@gmail.com"}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/contacts/{id}/relationships":{"get":{"tags":["Contacts"],"summary":"Retrieve details of the roles/relationships for a specific contact","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"},{"in":"query","name":"includeArchived","description":"A flag to include archived roles in the results. Default is false (archived roles are excluded)","type":"boolean"},{"in":"query","name":"pageSize","description":"A limit on the number of contacts to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of the roles that an individual contacts possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"contactId":{"description":"The unique identifier of the related contact","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF10020030","created":"2020-02-02T13:31:10Z","modified":"2020-02-05T11:13:44Z","contactId":"OXF12345678","associatedType":"applicant","associatedId":"OXF202020","fromArchive":false,"_links":{"self":{"href":"/contacts/OXF12345678/relationships/OXF10020030"},"contact":{"href":"/contacts/OXF12345678"},"applicant":{"href":"/applicants/OXF202020"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":50,"_links":{"self":{"href":"/contacts/OXF12345678/relationships/?PageNumber=1&PageSize=1"},"first":{"href":"/contacts/OXF12345678/relationships/?PageNumber=1&PageSize=1"},"next":{"href":"/contacts/OXF12345678/relationships/?PageNumber=2&PageSize=1"},"last":{"href":"/contacts/OXF12345678/relationships/?PageNumber=50&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/contacts/{id}/subscriptions":{"get":{"tags":["Contacts"],"summary":"Retrieve details of any mailing and/or event subscriptions for a specific contact","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of subscriptions to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"type","description":"Only fetch contact subscriptions where the `type` field matches the value provided","type":"string"},{"in":"query","name":"status","description":"Only fetch contact subscriptions where the `status` field matches the value provided (subscribed/unsubscribed)","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual contact subscription","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the subscription","type":"string"},"contactId":{"description":"The unique identifier of the contact the subscription is associated with","type":"string"},"name":{"description":"The name of the subscription","type":"string"},"group":{"description":"The name of the group this subscription belongs to, if applicable","type":"string"},"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"},"type":{"description":"The type of subscription (mailing/event)","type":"string"},"subscribedOn":{"format":"date-time","description":"The date and time when the subscription was started for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"},"unsubscribedOn":{"format":"date-time","description":"The date and time when the subscription was terminated for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"M006","contactId":"OXF18000001","name":"August 2021","group":"Monthly Newsletters","status":"subscribed","type":"mailing","subscribedOn":"2021-01-05","unsubscribedOn":null,"_links":{"self":{"href":"/contacts/OXF18000001/subscriptions/M006"},"contact":{"href":"/contacts/OXF18000001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":50,"_links":{"self":{"href":"/contacts/OXF18000001/subscriptions/?PageNumber=1&PageSize=1"},"first":{"href":"/contacts/OXF18000001/subscriptions/?PageNumber=1&PageSize=1"},"next":{"href":"/contacts/OXF18000001/subscriptions/?PageNumber=2&PageSize=1"},"last":{"href":"/contacts/OXF18000001/subscriptions/?PageNumber=50&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"put":{"tags":["Contacts"],"summary":"Updates the details of a specific mailing or event subscription for a specific contact","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"},{"in":"body","name":"body","description":"The update model.","schema":{"description":"Request body used to update an existing contact subscription","type":"object","properties":{"groupName":{"description":"The name of the group the contact is subscribed to","type":"string"},"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"}},"example":{"groupName":"Mailing Header","status":"subscribed"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/contacts/{id}/subscriptions/{subscriptionId}":{"get":{"tags":["Contacts"],"summary":"Retrieve details of a specific mailing or event subscription for a specific contact","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"},{"in":"path","name":"subscriptionId","description":"The id of the subscription to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an individual contact subscription","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the subscription","type":"string"},"contactId":{"description":"The unique identifier of the contact the subscription is associated with","type":"string"},"name":{"description":"The name of the subscription","type":"string"},"group":{"description":"The name of the group this subscription belongs to, if applicable","type":"string"},"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"},"type":{"description":"The type of subscription (mailing/event)","type":"string"},"subscribedOn":{"format":"date-time","description":"The date and time when the subscription was started for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"},"unsubscribedOn":{"format":"date-time","description":"The date and time when the subscription was terminated for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"}}},"examples":{"application/json":{"id":"M006","contactId":"OXF18000001","name":"August 2021","group":"Monthly Newsletters","status":"subscribed","type":"mailing","subscribedOn":"2021-01-05","unsubscribedOn":null,"_links":{"self":{"href":"/contacts/OXF18000001/subscriptions/M006"},"contact":{"href":"/contacts/OXF18000001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"put":{"tags":["Contacts"],"summary":"Updates the details of a specific mailing or event subscription for a specific contact","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"},{"in":"path","name":"subscriptionId","description":"The id of the subscription to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The update model.","schema":{"description":"Request body used to update an existing contact subscription","type":"object","properties":{"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"}},"example":{"status":"unsubscribed"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/contacts/{id}/landlordDetails":{"get":{"tags":["Contacts"],"summary":"Retrieve landlord details for a specific contact","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of landlord details for a contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact landlord details","type":"string"},"makingTaxDigitalOptInStatus":{"description":"The making tax digital opt-in state (notAsked/optedIn/optedOut)","type":"string"},"makingTaxDigitalOptInStatusDate":{"format":"date-time","description":"The date when the making tax digital opt-in state was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state (notSet/invited/accepted/revoked)","type":"string"}}},"examples":{"application/json":{"id":"OXF18000001","makingTaxDigitalOptInStatus":"optedIn","makingTaxDigitalOptInStatusDate":"2024-01-15T10:30:00Z","makingTaxDigitalConsentStatus":"accepted","_links":{"self":{"href":"/contacts/OXF18000001/landlordDetails"},"contact":{"href":"/contacts/OXF18000001"}},"_embedded":null}}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"put":{"tags":["Contacts"],"summary":"Update landlord details for a specific contact","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the contact","required":true,"type":"string"},{"in":"body","name":"body","description":"The update model.","schema":{"description":"Request body used to update landlord details for a contact","type":"object","properties":{"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state description (notSet/invited/accepted/revoked)","type":"string"}},"example":{"makingTaxDigitalConsentStatus":"invited"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/conveyancing/":{"get":{"tags":["Conveyancing"],"summary":"Retrieves sales progression information for a collection of offers","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of entities to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"id","description":"Only return entities where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return entities where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"buyerId","description":"Only return entities where the `buyerId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"embed","description":"Embed additional resources into the entities returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["buyerSolicitor","offer","property","vendor","vendorSolicitor"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"metadata","description":"Only return entities where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"createdFrom","description":"Only return entities where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return entities where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return entities where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return entities where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an offers sales progression information","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"milestones":{"description":"A collection of milestones associated to the offer","type":"array","items":{"description":"Represents a milestone model.","type":"object","properties":{"name":{"description":"Gets or sets the name associated with the object.","type":"string"},"status":{"description":"Gets or sets the status of the milestone.","type":"string"},"modified":{"format":"date-time","description":"The date and time when the milestone was modified.","type":"string","example":"2019-08-14T12:30:02Z"}}}},"modified":{"format":"date-time","description":"The date and time when the offer was modified","type":"string","example":"2019-08-14T12:30:02Z"},"isExternal":{"description":"Flag set to true if this offer is external","type":"boolean"},"propertyId":{"description":"The unique identifier of the property that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"propertyAddress":{"description":"The address of the property that this offer is associated to","type":"string"},"vendor":{"description":"The full name of the vendor of the property","type":"string"},"vendorId":{"description":"The unique identifier of the vendor that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"vendorSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed","type":"string"},"buyer":{"description":"The full name of the buyer who has submitted the offer","type":"string"},"buyerId":{"description":"The unique identifier of the contact that represents this buyer. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the buyer has instructed","type":"string"},"externalAgent":{"description":"The name of the agent who is marketing the property, where the offer is external and and relates to a property not instructed to the agent","type":"string"},"externalAgentId":{"description":"The unique identifier of the agent company that holds the property instruction","type":"string"},"upwardChainId":{"description":"The unique identifier of the offer that sits above this one in the chain (where known)","type":"string"},"downwardChainId":{"description":"The unique identifier of the offer that sits below this one in the chain (where known)","type":"string"},"fixturesAndFittingsCompleted":{"format":"date","description":"The date when the fixtures and fittings form has been completed","type":"string","example":"2019-08-14"},"deedsRequested":{"format":"date","description":"The date when the title deeds were requested from land registry","type":"string","example":"2019-08-14"},"deedsReceived":{"format":"date","description":"The date when the title deeds were received from land registry","type":"string","example":"2019-08-14"},"enquiriesSent":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were sent","type":"string","example":"2019-08-14"},"enquiriesAnswered":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were answered","type":"string","example":"2019-08-14"},"searchesPaid":{"format":"date","description":"The date when the buyer paid for conveyancing searches","type":"string","example":"2019-08-14"},"searchesApplied":{"format":"date","description":"The date when conveyancing searches were applied for","type":"string","example":"2019-08-14"},"searchesReceived":{"format":"date","description":"The date when conveyancing searches were received for","type":"string","example":"2019-08-14"},"contractSent":{"format":"date","description":"The date when the draft contract was sent","type":"string","example":"2019-08-14"},"contractReceived":{"format":"date","description":"The date when the draft contract was received","type":"string","example":"2019-08-14"},"contractApproved":{"format":"date","description":"The date when the contract was approved","type":"string","example":"2019-08-14"},"contractVendorSigned":{"format":"date","description":"The date when the vendor signed the approved contract","type":"string","example":"2019-08-14"},"contractBuyerSigned":{"format":"date","description":"The date when the buyer signed the approved contract","type":"string","example":"2019-08-14"},"mortgageRequired":{"description":"Indication of whether the buyer will require a mortgage to fund the purchase (yes/no/unknown)","type":"string"},"mortgageLoanPercentage":{"format":"int32","description":"The loan to value percentage of the mortgage required","type":"integer"},"mortgageSubmitted":{"format":"date","description":"The date when the mortgage application was submitted","type":"string","example":"2019-08-14"},"mortgageOfferReceived":{"format":"date","description":"The date when the mortgage offer was received","type":"string","example":"2019-08-14"},"mortgageLenderId":{"description":"The unique identifier of the company who will provide the mortgage","type":"string"},"mortgageBrokerId":{"description":"The unique identifier of the company who brokered the mortgage","type":"string"},"mortgageSurveyDate":{"format":"date","description":"The date of the mortgage valuation/survey","type":"string","example":"2019-08-14"},"mortgageSurveyorId":{"description":"The unique identifier of the company who will perform the mortgage valuation/survey","type":"string"},"additionalSurveyRequired":{"description":"Indication of whether the buyer requires that an additional survey take place  (yes/no/unknown)","type":"string"},"additionalSurveyDate":{"format":"date","description":"The date of the additional survey","type":"string","example":"2019-08-14"},"additionalSurveyorId":{"description":"The unique identifier of the company who will perform the additional survey","type":"string"},"exchangedVendor":{"format":"date","description":"The date when the vendor conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"exchangedBuyer":{"format":"date","description":"The date when the buyer conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"completion":{"format":"date","description":"The date when the sale completed","type":"string","example":"2019-08-14"},"checkListItems":{"description":"Check list items to be completed as part of the sales progression process","type":"array","items":{"description":"Representation of a check list item","type":"object","properties":{"name":{"description":"The name of the check list item","type":"string"},"completed":{"description":"A flag to determine if the item is completed","type":"boolean"},"completedDate":{"format":"date","description":"The date when the item was completed","type":"string","example":"2019-08-14"}}}},"buyerSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"vendorSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of this conveyancing record. Used for managing update concurrency","type":"string","readOnly":true},"metadata":{"description":"App specific metadata that has been set against this conveyancing record","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF2000122","created":"2020-05-10T11:31:10Z","milestones":null,"modified":"2020-05-20T11:31:10Z","isExternal":false,"propertyId":"OXF1700012","propertyAddress":"10 Church View Lane, Rugeley, WS15 6PP","vendor":"Mrs Jennifer Brown","vendorId":"OXF1700012","vendorSolicitorId":"RPT1800331","buyer":"Mr David Smith","buyerId":"RPT1900021","buyerSolicitorId":"OXF1800002","externalAgent":"","externalAgentId":"","upwardChainId":"OXF2000076","downwardChainId":"","fixturesAndFittingsCompleted":"2020-05-20","deedsRequested":"2020-05-20","deedsReceived":"2020-05-20","enquiriesSent":"2020-05-20","enquiriesAnswered":"2020-05-20","searchesPaid":"2020-05-20","searchesApplied":"2020-05-20","searchesReceived":"2020-05-20","contractSent":"2020-05-20","contractReceived":"2020-05-20","contractApproved":"2020-05-20","contractVendorSigned":"2020-05-20","contractBuyerSigned":"2020-05-20","mortgageRequired":"yes","mortgageLoanPercentage":65,"mortgageSubmitted":"2020-05-20","mortgageOfferReceived":"2020-05-20","mortgageLenderId":"OXF1500012","mortgageBrokerId":"","mortgageSurveyDate":"2020-05-20","mortgageSurveyorId":"","additionalSurveyRequired":"no","additionalSurveyDate":"2020-05-20","additionalSurveyorId":"","exchangedVendor":"2020-05-20","exchangedBuyer":"2020-05-20","completion":"2020-05-20","checkListItems":null,"buyerSolicitorContact":null,"vendorSolicitorContact":null,"_eTag":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_links":{"self":{"href":"/conveyancing/OXF2000122"},"offer":{"href":"/offers/OXF2000122"},"buyerSolicitor":{"href":"/companies/OXF1800002"},"property":{"href":"/properties/OXF1700012"},"vendor":{"href":"/vendors/OXF1700012"},"vendorSolicitor":{"href":"/companies/RPT1800331"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/conveyancing/?PageNumber=1&PageSize=1"},"first":{"href":"/conveyancing/?PageNumber=1&PageSize=1"},"next":{"href":"/conveyancing/?PageNumber=2&PageSize=1"},"last":{"href":"/conveyancing/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/conveyancing/{id}":{"get":{"tags":["Conveyancing"],"summary":"Retrieves sales progression information for the specified offer","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the offer","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the entity returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["buyerSolicitor","offer","property","vendor","vendorSolicitor"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an offers sales progression information","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"milestones":{"description":"A collection of milestones associated to the offer","type":"array","items":{"description":"Represents a milestone model.","type":"object","properties":{"name":{"description":"Gets or sets the name associated with the object.","type":"string"},"status":{"description":"Gets or sets the status of the milestone.","type":"string"},"modified":{"format":"date-time","description":"The date and time when the milestone was modified.","type":"string","example":"2019-08-14T12:30:02Z"}}}},"modified":{"format":"date-time","description":"The date and time when the offer was modified","type":"string","example":"2019-08-14T12:30:02Z"},"isExternal":{"description":"Flag set to true if this offer is external","type":"boolean"},"propertyId":{"description":"The unique identifier of the property that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"propertyAddress":{"description":"The address of the property that this offer is associated to","type":"string"},"vendor":{"description":"The full name of the vendor of the property","type":"string"},"vendorId":{"description":"The unique identifier of the vendor that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"vendorSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed","type":"string"},"buyer":{"description":"The full name of the buyer who has submitted the offer","type":"string"},"buyerId":{"description":"The unique identifier of the contact that represents this buyer. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the buyer has instructed","type":"string"},"externalAgent":{"description":"The name of the agent who is marketing the property, where the offer is external and and relates to a property not instructed to the agent","type":"string"},"externalAgentId":{"description":"The unique identifier of the agent company that holds the property instruction","type":"string"},"upwardChainId":{"description":"The unique identifier of the offer that sits above this one in the chain (where known)","type":"string"},"downwardChainId":{"description":"The unique identifier of the offer that sits below this one in the chain (where known)","type":"string"},"fixturesAndFittingsCompleted":{"format":"date","description":"The date when the fixtures and fittings form has been completed","type":"string","example":"2019-08-14"},"deedsRequested":{"format":"date","description":"The date when the title deeds were requested from land registry","type":"string","example":"2019-08-14"},"deedsReceived":{"format":"date","description":"The date when the title deeds were received from land registry","type":"string","example":"2019-08-14"},"enquiriesSent":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were sent","type":"string","example":"2019-08-14"},"enquiriesAnswered":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were answered","type":"string","example":"2019-08-14"},"searchesPaid":{"format":"date","description":"The date when the buyer paid for conveyancing searches","type":"string","example":"2019-08-14"},"searchesApplied":{"format":"date","description":"The date when conveyancing searches were applied for","type":"string","example":"2019-08-14"},"searchesReceived":{"format":"date","description":"The date when conveyancing searches were received for","type":"string","example":"2019-08-14"},"contractSent":{"format":"date","description":"The date when the draft contract was sent","type":"string","example":"2019-08-14"},"contractReceived":{"format":"date","description":"The date when the draft contract was received","type":"string","example":"2019-08-14"},"contractApproved":{"format":"date","description":"The date when the contract was approved","type":"string","example":"2019-08-14"},"contractVendorSigned":{"format":"date","description":"The date when the vendor signed the approved contract","type":"string","example":"2019-08-14"},"contractBuyerSigned":{"format":"date","description":"The date when the buyer signed the approved contract","type":"string","example":"2019-08-14"},"mortgageRequired":{"description":"Indication of whether the buyer will require a mortgage to fund the purchase (yes/no/unknown)","type":"string"},"mortgageLoanPercentage":{"format":"int32","description":"The loan to value percentage of the mortgage required","type":"integer"},"mortgageSubmitted":{"format":"date","description":"The date when the mortgage application was submitted","type":"string","example":"2019-08-14"},"mortgageOfferReceived":{"format":"date","description":"The date when the mortgage offer was received","type":"string","example":"2019-08-14"},"mortgageLenderId":{"description":"The unique identifier of the company who will provide the mortgage","type":"string"},"mortgageBrokerId":{"description":"The unique identifier of the company who brokered the mortgage","type":"string"},"mortgageSurveyDate":{"format":"date","description":"The date of the mortgage valuation/survey","type":"string","example":"2019-08-14"},"mortgageSurveyorId":{"description":"The unique identifier of the company who will perform the mortgage valuation/survey","type":"string"},"additionalSurveyRequired":{"description":"Indication of whether the buyer requires that an additional survey take place  (yes/no/unknown)","type":"string"},"additionalSurveyDate":{"format":"date","description":"The date of the additional survey","type":"string","example":"2019-08-14"},"additionalSurveyorId":{"description":"The unique identifier of the company who will perform the additional survey","type":"string"},"exchangedVendor":{"format":"date","description":"The date when the vendor conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"exchangedBuyer":{"format":"date","description":"The date when the buyer conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"completion":{"format":"date","description":"The date when the sale completed","type":"string","example":"2019-08-14"},"checkListItems":{"description":"Check list items to be completed as part of the sales progression process","type":"array","items":{"description":"Representation of a check list item","type":"object","properties":{"name":{"description":"The name of the check list item","type":"string"},"completed":{"description":"A flag to determine if the item is completed","type":"boolean"},"completedDate":{"format":"date","description":"The date when the item was completed","type":"string","example":"2019-08-14"}}}},"buyerSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"vendorSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of this conveyancing record. Used for managing update concurrency","type":"string","readOnly":true},"metadata":{"description":"App specific metadata that has been set against this conveyancing record","type":"object","additionalProperties":{}}}},"examples":{"application/json":{"id":"OXF2000122","created":"2020-05-10T11:31:10Z","milestones":null,"modified":"2020-05-20T11:31:10Z","isExternal":false,"propertyId":"OXF1700012","propertyAddress":"10 Church View Lane, Rugeley, WS15 6PP","vendor":"Mrs Jennifer Brown","vendorId":"OXF1700012","vendorSolicitorId":"RPT1800331","buyer":"Mr David Smith","buyerId":"RPT1900021","buyerSolicitorId":"OXF1800002","externalAgent":"","externalAgentId":"","upwardChainId":"OXF2000076","downwardChainId":"","fixturesAndFittingsCompleted":"2020-05-20","deedsRequested":"2020-05-20","deedsReceived":"2020-05-20","enquiriesSent":"2020-05-20","enquiriesAnswered":"2020-05-20","searchesPaid":"2020-05-20","searchesApplied":"2020-05-20","searchesReceived":"2020-05-20","contractSent":"2020-05-20","contractReceived":"2020-05-20","contractApproved":"2020-05-20","contractVendorSigned":"2020-05-20","contractBuyerSigned":"2020-05-20","mortgageRequired":"yes","mortgageLoanPercentage":65,"mortgageSubmitted":"2020-05-20","mortgageOfferReceived":"2020-05-20","mortgageLenderId":"OXF1500012","mortgageBrokerId":"","mortgageSurveyDate":"2020-05-20","mortgageSurveyorId":"","additionalSurveyRequired":"no","additionalSurveyDate":"2020-05-20","additionalSurveyorId":"","exchangedVendor":"2020-05-20","exchangedBuyer":"2020-05-20","completion":"2020-05-20","checkListItems":null,"buyerSolicitorContact":null,"vendorSolicitorContact":null,"_eTag":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_links":{"self":{"href":"/conveyancing/OXF2000122"},"offer":{"href":"/offers/OXF2000122"},"buyerSolicitor":{"href":"/companies/OXF1800002"},"property":{"href":"/properties/OXF1700012"},"vendor":{"href":"/vendors/OXF1700012"},"vendorSolicitor":{"href":"/companies/RPT1800331"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Conveyancing"],"summary":"Updates sales progression information for the specified offer","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the offer","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the offer","schema":{"description":"Request body for updating sales progression information on an existing offer","type":"object","properties":{"vendorSolicitorId":{"description":"The unique identifier of the vendor that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed","type":"string"},"fixturesAndFittingsCompleted":{"format":"date","description":"The date when the fixtures and fittings form has been completed","type":"string","example":"2019-08-14"},"deedsRequested":{"format":"date","description":"The date when the title deeds were requested from land registry","type":"string","example":"2019-08-14"},"deedsReceived":{"format":"date","description":"The date when the title deeds were received from land registry","type":"string","example":"2019-08-14"},"enquiriesSent":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were sent","type":"string","example":"2019-08-14"},"enquiriesAnswered":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were answered","type":"string","example":"2019-08-14"},"searchesPaid":{"format":"date","description":"The date when the buyer paid for conveyancing searches","type":"string","example":"2019-08-14"},"searchesApplied":{"format":"date","description":"The date when conveyancing searches were applied for","type":"string","example":"2019-08-14"},"searchesReceived":{"format":"date","description":"The date when conveyancing searches were received","type":"string","example":"2019-08-14"},"contractSent":{"format":"date","description":"The date when the draft contract was sent","type":"string","example":"2019-08-14"},"contractReceived":{"format":"date","description":"The date when the draft contract was received","type":"string","example":"2019-08-14"},"contractApproved":{"format":"date","description":"The date when the contract was approved","type":"string","example":"2019-08-14"},"contractVendorSigned":{"format":"date","description":"The date when the vendor signed the approved contract","type":"string","example":"2019-08-14"},"contractBuyerSigned":{"format":"date","description":"The date when the buyer signed the approved contract","type":"string","example":"2019-08-14"},"mortgageRequired":{"description":"Indication of whether the buyer will require a mortgage to fund the purchase (yes/no/unknown)","type":"string"},"mortgageLoanPercentage":{"format":"int32","description":"The loan to value percentage of the mortgage required","type":"integer"},"mortgageSubmitted":{"format":"date","description":"The date when the mortgage application was submitted","type":"string","example":"2019-08-14"},"mortgageOfferReceived":{"format":"date","description":"The date when the mortgage offer was received","type":"string","example":"2019-08-14"},"mortgageLenderId":{"description":"The unique identifier of the company who will provide the mortgage","type":"string"},"mortgageBrokerId":{"description":"The unique identifier of the company who brokered the mortgage","type":"string"},"mortgageSurveyDate":{"format":"date-time","description":"The date of the mortgage valuation/survey","type":"string","example":"2019-08-14T12:30:02Z"},"mortgageSurveyorId":{"description":"The unique identifier of the company who will perform the mortgage valuation/survey","type":"string"},"additionalSurveyRequired":{"description":"Indication of whether the buyer requires that an additional survey take place (yes/no/unknown)","type":"string"},"additionalSurveyDate":{"format":"date","description":"The date of the additional survey","type":"string","example":"2019-08-14"},"additionalSurveyorId":{"description":"The unique identifier of the company who will perform the additional survey","type":"string"},"exchangedVendor":{"format":"date","description":"The date when the vendor conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"exchangedBuyer":{"format":"date","description":"The date when the buyer conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"completion":{"format":"date","description":"The date when the sale completed","type":"string","example":"2019-08-14"},"metadata":{"description":"App specific metadata to set against this conveyancing record","type":"object","additionalProperties":{}}},"example":{"vendorSolicitorId":"VEN1900001","buyerSolicitorId":"BUY1900001","fixturesAndFittingsCompleted":"2020-01-10","deedsRequested":"2020-01-05","deedsReceived":"2020-03-04","enquiriesSent":"2020-01-10","enquiriesAnswered":"2020-02-10","searchesPaid":"2020-01-16","searchesApplied":"2020-01-11","searchesReceived":"2020-02-27","contractSent":"2020-04-03","contractReceived":"2020-02-10","contractApproved":"2020-01-01","contractVendorSigned":"2020-01-12","contractBuyerSigned":"2020-01-10","mortgageRequired":"yes","mortgageLoanPercentage":55,"mortgageSubmitted":"2020-01-14","mortgageOfferReceived":"2020-04-10","mortgageLenderId":"OXF1500012","mortgageBrokerId":"","mortgageSurveyDate":"2020-01-14","mortgageSurveyorId":"","additionalSurveyRequired":"yes","additionalSurveyDate":"2020-01-22","additionalSurveyorId":"","exchangedVendor":"2020-03-10","exchangedBuyer":"2020-01-23","completion":"2020-04-10","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/conveyancing/{id}/chain":{"get":{"tags":["Conveyancing"],"summary":"Retrieves details of the known chain for the specified offer","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the offer","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of entities to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an offers sales progression information","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"milestones":{"description":"A collection of milestones associated to the offer","type":"array","items":{"description":"Represents a milestone model.","type":"object","properties":{"name":{"description":"Gets or sets the name associated with the object.","type":"string"},"status":{"description":"Gets or sets the status of the milestone.","type":"string"},"modified":{"format":"date-time","description":"The date and time when the milestone was modified.","type":"string","example":"2019-08-14T12:30:02Z"}}}},"modified":{"format":"date-time","description":"The date and time when the offer was modified","type":"string","example":"2019-08-14T12:30:02Z"},"isExternal":{"description":"Flag set to true if this offer is external","type":"boolean"},"propertyId":{"description":"The unique identifier of the property that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"propertyAddress":{"description":"The address of the property that this offer is associated to","type":"string"},"vendor":{"description":"The full name of the vendor of the property","type":"string"},"vendorId":{"description":"The unique identifier of the vendor that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"vendorSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed","type":"string"},"buyer":{"description":"The full name of the buyer who has submitted the offer","type":"string"},"buyerId":{"description":"The unique identifier of the contact that represents this buyer. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the buyer has instructed","type":"string"},"externalAgent":{"description":"The name of the agent who is marketing the property, where the offer is external and and relates to a property not instructed to the agent","type":"string"},"externalAgentId":{"description":"The unique identifier of the agent company that holds the property instruction","type":"string"},"upwardChainId":{"description":"The unique identifier of the offer that sits above this one in the chain (where known)","type":"string"},"downwardChainId":{"description":"The unique identifier of the offer that sits below this one in the chain (where known)","type":"string"},"fixturesAndFittingsCompleted":{"format":"date","description":"The date when the fixtures and fittings form has been completed","type":"string","example":"2019-08-14"},"deedsRequested":{"format":"date","description":"The date when the title deeds were requested from land registry","type":"string","example":"2019-08-14"},"deedsReceived":{"format":"date","description":"The date when the title deeds were received from land registry","type":"string","example":"2019-08-14"},"enquiriesSent":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were sent","type":"string","example":"2019-08-14"},"enquiriesAnswered":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were answered","type":"string","example":"2019-08-14"},"searchesPaid":{"format":"date","description":"The date when the buyer paid for conveyancing searches","type":"string","example":"2019-08-14"},"searchesApplied":{"format":"date","description":"The date when conveyancing searches were applied for","type":"string","example":"2019-08-14"},"searchesReceived":{"format":"date","description":"The date when conveyancing searches were received for","type":"string","example":"2019-08-14"},"contractSent":{"format":"date","description":"The date when the draft contract was sent","type":"string","example":"2019-08-14"},"contractReceived":{"format":"date","description":"The date when the draft contract was received","type":"string","example":"2019-08-14"},"contractApproved":{"format":"date","description":"The date when the contract was approved","type":"string","example":"2019-08-14"},"contractVendorSigned":{"format":"date","description":"The date when the vendor signed the approved contract","type":"string","example":"2019-08-14"},"contractBuyerSigned":{"format":"date","description":"The date when the buyer signed the approved contract","type":"string","example":"2019-08-14"},"mortgageRequired":{"description":"Indication of whether the buyer will require a mortgage to fund the purchase (yes/no/unknown)","type":"string"},"mortgageLoanPercentage":{"format":"int32","description":"The loan to value percentage of the mortgage required","type":"integer"},"mortgageSubmitted":{"format":"date","description":"The date when the mortgage application was submitted","type":"string","example":"2019-08-14"},"mortgageOfferReceived":{"format":"date","description":"The date when the mortgage offer was received","type":"string","example":"2019-08-14"},"mortgageLenderId":{"description":"The unique identifier of the company who will provide the mortgage","type":"string"},"mortgageBrokerId":{"description":"The unique identifier of the company who brokered the mortgage","type":"string"},"mortgageSurveyDate":{"format":"date","description":"The date of the mortgage valuation/survey","type":"string","example":"2019-08-14"},"mortgageSurveyorId":{"description":"The unique identifier of the company who will perform the mortgage valuation/survey","type":"string"},"additionalSurveyRequired":{"description":"Indication of whether the buyer requires that an additional survey take place  (yes/no/unknown)","type":"string"},"additionalSurveyDate":{"format":"date","description":"The date of the additional survey","type":"string","example":"2019-08-14"},"additionalSurveyorId":{"description":"The unique identifier of the company who will perform the additional survey","type":"string"},"exchangedVendor":{"format":"date","description":"The date when the vendor conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"exchangedBuyer":{"format":"date","description":"The date when the buyer conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"completion":{"format":"date","description":"The date when the sale completed","type":"string","example":"2019-08-14"},"checkListItems":{"description":"Check list items to be completed as part of the sales progression process","type":"array","items":{"description":"Representation of a check list item","type":"object","properties":{"name":{"description":"The name of the check list item","type":"string"},"completed":{"description":"A flag to determine if the item is completed","type":"boolean"},"completedDate":{"format":"date","description":"The date when the item was completed","type":"string","example":"2019-08-14"}}}},"buyerSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"vendorSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of this conveyancing record. Used for managing update concurrency","type":"string","readOnly":true},"metadata":{"description":"App specific metadata that has been set against this conveyancing record","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF2000122","created":"2020-05-10T11:31:10Z","milestones":null,"modified":"2020-05-20T11:31:10Z","isExternal":false,"propertyId":"OXF1700012","propertyAddress":"10 Church View Lane, Rugeley, WS15 6PP","vendor":"Mrs Jennifer Brown","vendorId":"OXF1700012","vendorSolicitorId":"RPT1800331","buyer":"Mr David Smith","buyerId":"RPT1900021","buyerSolicitorId":"OXF1800002","externalAgent":"","externalAgentId":"","upwardChainId":"OXF2000076","downwardChainId":"","fixturesAndFittingsCompleted":"2020-05-20","deedsRequested":"2020-05-20","deedsReceived":"2020-05-20","enquiriesSent":"2020-05-20","enquiriesAnswered":"2020-05-20","searchesPaid":"2020-05-20","searchesApplied":"2020-05-20","searchesReceived":"2020-05-20","contractSent":"2020-05-20","contractReceived":"2020-05-20","contractApproved":"2020-05-20","contractVendorSigned":"2020-05-20","contractBuyerSigned":"2020-05-20","mortgageRequired":"yes","mortgageLoanPercentage":65,"mortgageSubmitted":"2020-05-20","mortgageOfferReceived":"2020-05-20","mortgageLenderId":"OXF1500012","mortgageBrokerId":"","mortgageSurveyDate":"2020-05-20","mortgageSurveyorId":"","additionalSurveyRequired":"no","additionalSurveyDate":"2020-05-20","additionalSurveyorId":"","exchangedVendor":"2020-05-20","exchangedBuyer":"2020-05-20","completion":"2020-05-20","checkListItems":null,"buyerSolicitorContact":null,"vendorSolicitorContact":null,"_eTag":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_links":{"self":{"href":"/conveyancing/OXF2000122"},"offer":{"href":"/offers/OXF2000122"},"buyerSolicitor":{"href":"/companies/OXF1800002"},"property":{"href":"/properties/OXF1700012"},"vendor":{"href":"/vendors/OXF1700012"},"vendorSolicitor":{"href":"/companies/RPT1800331"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/conveyancing/?PageNumber=1&PageSize=1"},"first":{"href":"/conveyancing/?PageNumber=1&PageSize=1"},"next":{"href":"/conveyancing/?PageNumber=2&PageSize=1"},"last":{"href":"/conveyancing/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/conveyancing/{id}/downward":{"post":{"tags":["Conveyancing"],"summary":"Create a link between the specified offer to another below this one in the chain (the buyers sale)","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the offer to create the downward link against","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing information about the offer below this one in the chain","schema":{"description":"Request body for associating this offer to another one below it in the chain","type":"object","properties":{"offerId":{"description":"The unique identifier of the offer below this one in the chain. Should be left empty if the upward property is external (instructed by another agent)","type":"string"},"propertyAddress":{"description":"The address of the property below this one in the chain. (Required when 'offerId' is not provided)","type":"string"},"agent":{"description":"The name of the agent managing the sale of the property. (Required when 'offerId' is not provided)","type":"string"},"buyer":{"description":"The name of the buyer purchasing the property. (Required when 'offerId' is not provided)","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the buyer has instructed. (Required when 'offerId' is not provided)","type":"string"}},"example":{"offerId":"","propertyAddress":"10 Church View Lane, Rugeley, WS15 6PP","agent":"External estate agent name","buyer":"Mr John Smith","buyerSolicitorId":"OXF19000001"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Conveyancing"],"summary":"Deletes the link between the specified offer and the one below it one in the chain (the buyers sale)","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the offer to remove the downward link from","required":true,"type":"string"}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/conveyancing/{id}/upward":{"post":{"tags":["Conveyancing"],"summary":"Create a link between the specified offer to another above this one in the chain (the vendors purchase)","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the offer to create the upward link against","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing information about the offer above this one in the chain","schema":{"description":"Request body for associating this offer to another one above it in the chain","type":"object","properties":{"offerId":{"description":"The unique identifier of the offer above this one in the chain. Should be left empty if the upward property is external (instructed by another agent)","type":"string"},"propertyAddress":{"description":"The address of the property above this one in the chain. (Required when 'offerId' is not provided)","type":"string"},"agent":{"description":"The name of the agent managing the sale of the property. (Required when 'offerId' is not provided)","type":"string"},"vendor":{"description":"The name of the vendor selling the property. (Required when 'offerId' is not provided)","type":"string"},"vendorSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed. (Required when 'offerId' is not provided)","type":"string"}},"example":{"offerId":"","propertyAddress":"10 Church View Lane, Rugeley, WS15 6PP","agent":"External estate agent name","vendor":"Mr John Smith","vendorSolicitorId":"OXF19000001"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Conveyancing"],"summary":"Deletes the link between the specified offer and the one above it one in the chain (the vendors purchase)","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the offer to remove the upward link from","required":true,"type":"string"}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/departments/":{"get":{"tags":["Departments"],"summary":"Gets a collection of departments","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of departments to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"id","description":"Only return departments where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"name","description":"Only return departments where the `name` field matches one or more values provided","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a department","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the department","type":"string"},"created":{"format":"date-time","description":"The date and time when the department was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the department was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the department","type":"string"},"typeOptions":{"description":"A collection of property type values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"styleOptions":{"description":"A collection of property style values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situationOptions":{"description":"A collection of property situation values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parkingOptions":{"description":"A collection of property parking values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"ageOptions":{"description":"A collection of property age values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"localityOptions":{"description":"A collection of property locality values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeaturesOptions":{"description":"A collection of special property feature values that will be presented by other services","type":"array","items":{"type":"string"}},"commercialUseClassOptions":{"description":"A collection of commercial use class values that will be accepted by other services","type":"array","items":{"type":"string"}},"commercialFloorLevelOptions":{"description":"A collection of commercial floor level values that will be accepted by other services","type":"array","items":{"type":"string"}},"keywords":{"description":"A collection of keyword values that will be accepted by other services","type":"array","items":{"type":"string"}},"hasBedrooms":{"description":"A flag to determing if the department has bedrooms configured","type":"boolean"},"hasBathrooms":{"description":"A flag to determing if the department has bathrooms configured","type":"boolean"},"hasReceptionRooms":{"description":"A flag to determing if the department has reception rooms configured","type":"boolean"},"hasParkingSpaces":{"description":"A flag to determing if the department has parking spaces configured","type":"boolean"},"hasFloorLevelEnabled":{"description":"A flag to determing if the department allows the floor level property to be set","type":"boolean"},"hasInternalFloorsEnabled":{"description":"A flag to determing if the department allows the internal floors property to be set","type":"boolean"},"hasTotalFloorsEnabled":{"description":"A flag to determing if the department allows the total floors property to be set","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the department. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"G","created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","name":"General","typeOptions":["house","bungalow","flatApartment","maisonette","land","farm","developmentPlot","cottage"],"styleOptions":["terraced","endTerrace","detached","semiDetached","linkDetached","basement","groundFloor","firstFloor","upperFloor","upperFloorWithLift"],"situationOptions":["garden","land","patio","roofTerrace","conservatory","balcony","communalGarden"],"parkingOptions":["residents","offStreet","garage","doubleGarage","tripleGarage"],"ageOptions":["period","modern","new"],"localityOptions":["rural","village","townCity"],"specialFeaturesOptions":["Tennis Court","Swimming Pool","Outbuildings","Pets"],"commercialUseClassOptions":null,"commercialFloorLevelOptions":null,"keywords":["Arable","Garden","Paddock","Pasture","Woodland","Agricultural Tie","ESA","Irrigation","Minerals","Organic","Dairy","Equestrian","Livestock","Pig Unit","Poultry","Training Yard"],"hasBedrooms":false,"hasBathrooms":false,"hasReceptionRooms":false,"hasParkingSpaces":false,"hasFloorLevelEnabled":false,"hasInternalFloorsEnabled":false,"hasTotalFloorsEnabled":false,"_eTag":null,"_links":{"self":{"href":"/departments/G"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/departments/?PageNumber=1&PageSize=1"},"first":{"href":"/departments/?PageNumber=1&PageSize=1"},"next":{"href":"/departments/?PageNumber=2&PageSize=1"},"last":{"href":"/departments/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/departments/{id}":{"get":{"tags":["Departments"],"summary":"Gets a single department by its' unique identifier","operationId":"GetDepartmentById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique department identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a department","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the department","type":"string"},"created":{"format":"date-time","description":"The date and time when the department was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the department was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the department","type":"string"},"typeOptions":{"description":"A collection of property type values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"styleOptions":{"description":"A collection of property style values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situationOptions":{"description":"A collection of property situation values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parkingOptions":{"description":"A collection of property parking values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"ageOptions":{"description":"A collection of property age values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"localityOptions":{"description":"A collection of property locality values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeaturesOptions":{"description":"A collection of special property feature values that will be presented by other services","type":"array","items":{"type":"string"}},"commercialUseClassOptions":{"description":"A collection of commercial use class values that will be accepted by other services","type":"array","items":{"type":"string"}},"commercialFloorLevelOptions":{"description":"A collection of commercial floor level values that will be accepted by other services","type":"array","items":{"type":"string"}},"keywords":{"description":"A collection of keyword values that will be accepted by other services","type":"array","items":{"type":"string"}},"hasBedrooms":{"description":"A flag to determing if the department has bedrooms configured","type":"boolean"},"hasBathrooms":{"description":"A flag to determing if the department has bathrooms configured","type":"boolean"},"hasReceptionRooms":{"description":"A flag to determing if the department has reception rooms configured","type":"boolean"},"hasParkingSpaces":{"description":"A flag to determing if the department has parking spaces configured","type":"boolean"},"hasFloorLevelEnabled":{"description":"A flag to determing if the department allows the floor level property to be set","type":"boolean"},"hasInternalFloorsEnabled":{"description":"A flag to determing if the department allows the internal floors property to be set","type":"boolean"},"hasTotalFloorsEnabled":{"description":"A flag to determing if the department allows the total floors property to be set","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the department. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"G","created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","name":"General","typeOptions":["house","bungalow","flatApartment","maisonette","land","farm","developmentPlot","cottage"],"styleOptions":["terraced","endTerrace","detached","semiDetached","linkDetached","basement","groundFloor","firstFloor","upperFloor","upperFloorWithLift"],"situationOptions":["garden","land","patio","roofTerrace","conservatory","balcony","communalGarden"],"parkingOptions":["residents","offStreet","garage","doubleGarage","tripleGarage"],"ageOptions":["period","modern","new"],"localityOptions":["rural","village","townCity"],"specialFeaturesOptions":["Tennis Court","Swimming Pool","Outbuildings","Pets"],"commercialUseClassOptions":null,"commercialFloorLevelOptions":null,"keywords":["Arable","Garden","Paddock","Pasture","Woodland","Agricultural Tie","ESA","Irrigation","Minerals","Organic","Dairy","Equestrian","Livestock","Pig Unit","Poultry","Training Yard"],"hasBedrooms":false,"hasBathrooms":false,"hasReceptionRooms":false,"hasParkingSpaces":false,"hasFloorLevelEnabled":false,"hasInternalFloorsEnabled":false,"hasTotalFloorsEnabled":false,"_eTag":null,"_links":{"self":{"href":"/departments/G"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/documents/":{"get":{"tags":["Documents"],"summary":"Gets a collection of documents matching the filter criteria provided","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"Maximum number of records per page","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the documents returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["documentType"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return documents where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"associatedId","description":"Only return documents where the `associatedId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"associatedType","description":"Only return documents where the `associatedType` field matches one or more values provided ","type":"array","items":{"enum":["appliance","applicant","bankStatement","batch","certificate","contact","depositCertificate","estate","estateUnit","idCheck","keySet","landlord","nominalTransaction","property","tenancy","tenancyCheck","tenancyRenewal","worksOrder"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"typeId","description":"Only return documents where the `typeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"includeRoleDocuments","description":"Flag indicating whether or not documents for contact roles should be returned.\r\nNote this property can only be used when requesting documents for a single contact","type":"boolean"},{"in":"query","name":"createdFrom","description":"Only return documents where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return documents where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return documents where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return documents where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return documents where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a document","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the document","type":"string"},"created":{"format":"date-time","description":"The date and time when the document was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the document was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of entity that the document is associated with","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"associatedId":{"description":"The unique identifier of the entity that the document is associated with","type":"string"},"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"addedBy":{"description":"The identifier of the negotiator who added the document","type":"string"},"metadata":{"description":"App specific metadata that has been set against the document","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the document. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20000060","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","associatedType":"property","isPrivate":false,"associatedId":"OXF190347","typeId":"DET","name":"24 Smithson Road Details.pdf","addedBy":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"self":{"href":"/documents/OXF20000060"},"type":{"href":"/configuration/documentTypes/DET"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":2,"_links":{"self":{"href":"/documents/?PageNumber=1&PageSize=1"},"first":{"href":"/documents/?PageNumber=1&PageSize=1"},"next":{"href":"/documents/?PageNumber=2&PageSize=1"},"last":{"href":"/documents/?PageNumber=2&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Documents"],"summary":"Creates a new document","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create a new document","required":["associatedType","associatedId","typeId","name"],"type":"object","properties":{"associatedType":{"description":"The type of entity that the document is associated with (appliance/applicant/bankStatement/batch/certificate/contact/depositCertificate/estate/estateUnit/idCheck/keySet/landlord/nominalTransaction/property/supplierInvoice/tenancy/tenancyCheck/tenancyRenewal/worksOrder/renewalNegotiation)","type":"string"},"associatedId":{"description":"The unique identifier of the entity that the document is associated with","type":"string"},"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"fileData":{"description":"The base64 encoded document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl)\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"metadata":{"description":"App specific metadata to set against the document","type":"object","additionalProperties":{}}},"example":{"associatedType":"property","associatedId":"OXF190347","typeId":"DET","name":"24 Smithson Road Details.pdf","isPrivate":false,"fileData":"data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==","fileUrl":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/documents/{id}":{"get":{"tags":["Documents"],"summary":"Gets a single document by its' unique identifier","operationId":"GetDocumentById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique document identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the document returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["documentType"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a document","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the document","type":"string"},"created":{"format":"date-time","description":"The date and time when the document was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the document was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of entity that the document is associated with","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"associatedId":{"description":"The unique identifier of the entity that the document is associated with","type":"string"},"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"addedBy":{"description":"The identifier of the negotiator who added the document","type":"string"},"metadata":{"description":"App specific metadata that has been set against the document","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the document. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20000060","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","associatedType":"property","isPrivate":false,"associatedId":"OXF190347","typeId":"DET","name":"24 Smithson Road Details.pdf","addedBy":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"self":{"href":"/documents/OXF20000060"},"type":{"href":"/configuration/documentTypes/DET"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Documents"],"summary":"Updates an existing document by its' unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier for the document to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the document.","schema":{"description":"Request body used to update an existing document","type":"object","properties":{"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"metadata":{"description":"App specific metadata to set against the document","type":"object","additionalProperties":{}}},"example":{"typeId":"DET","name":"24 Smithson Road Approved Details v2.pdf","isPrivate":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Documents"],"summary":"Deletes a document by unique identifier","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier for the document to delete.","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/documents/{id}/download":{"get":{"tags":["Documents"],"summary":"Gets the content of single document by its' unique identifier via content stream or redirect","operationId":"GetDocumentContentById","produces":["application/octet-stream"],"parameters":[{"in":"path","name":"id","description":"Unique document identifier. Please see the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#document) for more information about how to use this endpoint","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"format":"binary","type":"string"}},"302":{"description":"Redirect"},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/documents/signedUrl":{"post":{"tags":["Documents"],"summary":"Creates pre signed urls used for uploading files between 6MB and 30MB","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create pre signed urls to upload files between 6MB and 30MB","required":["amount"],"type":"object","properties":{"amount":{"format":"int32","description":"The number of pre signed urls to create","type":"integer"}},"example":{"amount":1}}}],"responses":{"200":{"description":"Success","schema":{"description":"Request body used to create pre signed urls to upload files between 6MB and 30MB","required":["amount"],"type":"object","properties":{"amount":{"format":"int32","description":"The number of pre signed urls to create","type":"integer"}},"example":{"amount":1}}},"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/enquiries/":{"get":{"tags":["Enquiries"],"summary":"Retrieves a collection of enquiries from prospective vendors, landlords or applicants","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of enquiries to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"enquiryType","description":"Only return enquiries where the `enquiryType` field matches one or more values provided. <br />\r\nAllowed values: salesApplicant/lettingsApplicant/salesProperty/lettingsProperty","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"status","description":"Only return properties where the `status` field matches one or more values provided. <br />\r\nAllowed values: pending/added/rejected/alreadyExists/duplicateEntry/spam","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return properties where the `officeId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"createdFrom","description":"Only return enquiries where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return enquiries where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return enquiries where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return enquiries where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an enquiry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"format":"int32","description":"The unique identifier of the enquiry","type":"integer"},"created":{"format":"date-time","description":"The date and time when the enquiry was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the enquiry was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The title of the individual making the enquiry","type":"string"},"forename":{"description":"The forename of the individual making the enquiry","type":"string"},"surname":{"description":"The surname of the individual making the enquiry","type":"string"},"enquiryType":{"description":"The type of enquiry. Enquiries can created for applicants interested in buying/renting, as well as prospective vendors and landlords (salesApplicant/lettingsApplicant/salesProperty/lettingsProperty)","type":"string"},"message":{"description":"Textual information about the nature of the enquiry - usually the message text from the individual making the enquiry","type":"string"},"status":{"description":"The status of the enquiry (pending/added/rejected/alreadyExists/duplicateEntry/spam)","type":"string"},"marketingConsent":{"description":"The marketing consent status of the individual making the enquiry (grant/deny/notAsked)","type":"string"},"position":{"description":"The selling position of the individual making the enquiry (renting/instructedThisAgent/instructedOtherAgent/privateSale/notOnMarket)","type":"string"},"officeId":{"description":"The unique identifier of the office related to the enquiry","type":"string"},"applicantId":{"description":"The unique identifier of the applicant related to the enquiry","type":"string"},"createdPropertyId":{"description":"The unique identifier of the created property related to the enquiry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator related to the enquiry","type":"string"},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator who has been assigned to the enquiry","type":"string"},"sourceName":{"description":"The name of the source that the enquiry was generated by","type":"string"},"homePhone":{"description":"The home phone number of the individual making the enquiry","type":"string"},"workPhone":{"description":"The work phone number of the individual making the enquiry","type":"string"},"mobilePhone":{"description":"The mobile phone number of the individual making the enquiry","type":"string"},"email":{"description":"The email of the individual making the enquiry","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"buying":{"description":"Request body used to create a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"renting":{"description":"The details specific to enquiries with a type of lettingsApplicant","type":"object","properties":{"rentFrom":{"format":"double","description":"The lower bound of the prospective tenant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the prospective tenant's budget","type":"number"},"rentFrequency":{"description":"How often the tenant would like to pay the rent (weekly/monthly/annually)","type":"string"}}},"bedrooms":{"format":"int32","description":"The number of bedrooms the prospective buyer or tenant requires","type":"integer"},"propertyIds":{"description":"A list of unique property identifiers that this enquiry relates to. Used to indicate the properties that a sales or lettings applicant has expressed an interest in","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the enquiry. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":45,"created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","title":"Mr","forename":"John","surname":"Smith","enquiryType":"salesApplicant","message":"Sales enquiry from Rightmove for 10 High Street, Solihull","status":"pending","marketingConsent":"grant","position":"renting","officeId":"OXF","applicantId":null,"createdPropertyId":null,"negotiatorId":null,"leadNegotiatorId":"ALL","sourceName":"Rightmove","homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"buying":{"priceFrom":null,"priceTo":null},"renting":{"rentFrom":null,"rentTo":null,"rentFrequency":null},"bedrooms":null,"propertyIds":["OXF190012"],"_eTag":null,"_links":{"self":{"href":"/enquiries/45"},"properties":{"href":"/properties/?id=OXF190012"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/enquiries/?PageNumber=1&PageSize=1"},"first":{"href":"/enquiries/?PageNumber=1&PageSize=1"},"next":{"href":"/enquiries/?PageNumber=2&PageSize=1"},"last":{"href":"/enquiries/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Enquiries"],"summary":"Creates a new enquiry.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the enquiry.","schema":{"description":"Request body used to create an enquiry","required":["title","forename","surname","enquiryType","message","officeId","marketingConsent","sourceName"],"type":"object","properties":{"title":{"description":"The title of the individual making the enquiry","type":"string"},"forename":{"description":"The forename of the individual making the enquiry","type":"string"},"surname":{"description":"The surname of the individual making the enquiry","type":"string"},"position":{"description":"The selling position of the individual making the enquiry (renting/instructedThisAgent/instructedOtherAgent/privateSale/notOnMarket)","type":"string"},"enquiryType":{"description":"The type of enquiry. Enquiries can created for applicants interested in buying/renting, as well as prospective vendors and landlords (salesApplicant/lettingsApplicant/salesProperty/lettingsProperty)","type":"string"},"message":{"description":"Textual information about the nature of the enquiry - usually the message text from the individual making the enquiry","type":"string"},"officeId":{"description":"The unique identifier of the related office","type":"string"},"marketingConsent":{"description":"The marketing consent status of the individual making the enquiry (grant/deny/notAsked)","type":"string"},"sourceName":{"description":"The name of the source that the enquiry was generated from","type":"string"},"homePhone":{"description":"The home phone number of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"workPhone":{"description":"The work phone number of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"mobilePhone":{"description":"The mobile phone number of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"email":{"description":"The email of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"address":{"description":"Request body used to create a enquiries address","type":"object","properties":{"buildingName":{"description":"Sets the building name","type":"string"},"buildingNumber":{"description":"Sets the building number","type":"string"},"line1":{"description":"Sets the first line of the address","type":"string"},"line2":{"description":"Sets the second line of the address","type":"string"},"line3":{"description":"Sets the third line of the address","type":"string"},"line4":{"description":"Sets the fourth line of the address","type":"string"},"postcode":{"description":"Sets the postcode","type":"string"},"countryId":{"description":"Sets the ISO-3166 country code that the address resides within","type":"string"}}},"buying":{"description":"The details specific to a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"renting":{"description":"The details specific to renting enquiry. When type is renting.","type":"object","properties":{"rentFrom":{"format":"int32","description":"The lower bound of the prospective tenant's budget","type":"integer"},"rentTo":{"format":"int32","description":"The upper bound of the prospective tenant's budget","type":"integer"},"rentFrequency":{"description":"The desired rent collection frequency specified by the prospective tenant (weekly/monthly/annually).","type":"string"}}},"bedrooms":{"format":"int32","description":"The number of bedrooms the prospective buyer or tenant requires","type":"integer"},"propertyIds":{"description":"A list of unique property identifiers that the enquiry relates to. Used to indicate the properties that a sales or lettings applicant has expressed an interest in","type":"array","items":{"type":"string"}},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator who has been assigned to the enquiry","type":"string"}},"example":{"title":"Mr","forename":"John","surname":"Smith","position":"renting","enquiryType":"salesApplicant","message":"Sales enquiry from Rightmove for 10 High Street, Solihull","officeId":"OXF","marketingConsent":"grant","sourceName":"Rightmove","homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":null,"postcode":"B91 2XX","countryId":"GB"},"buying":{"priceFrom":0,"priceTo":0},"renting":null,"bedrooms":null,"propertyIds":["OXF190012"],"leadNegotiatorId":"ALL"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/enquiries/{id}":{"get":{"tags":["Enquiries"],"summary":"Get a single enquiry by its' unique identifier","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the enquiry to return","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an enquiry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"format":"int32","description":"The unique identifier of the enquiry","type":"integer"},"created":{"format":"date-time","description":"The date and time when the enquiry was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the enquiry was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The title of the individual making the enquiry","type":"string"},"forename":{"description":"The forename of the individual making the enquiry","type":"string"},"surname":{"description":"The surname of the individual making the enquiry","type":"string"},"enquiryType":{"description":"The type of enquiry. Enquiries can created for applicants interested in buying/renting, as well as prospective vendors and landlords (salesApplicant/lettingsApplicant/salesProperty/lettingsProperty)","type":"string"},"message":{"description":"Textual information about the nature of the enquiry - usually the message text from the individual making the enquiry","type":"string"},"status":{"description":"The status of the enquiry (pending/added/rejected/alreadyExists/duplicateEntry/spam)","type":"string"},"marketingConsent":{"description":"The marketing consent status of the individual making the enquiry (grant/deny/notAsked)","type":"string"},"position":{"description":"The selling position of the individual making the enquiry (renting/instructedThisAgent/instructedOtherAgent/privateSale/notOnMarket)","type":"string"},"officeId":{"description":"The unique identifier of the office related to the enquiry","type":"string"},"applicantId":{"description":"The unique identifier of the applicant related to the enquiry","type":"string"},"createdPropertyId":{"description":"The unique identifier of the created property related to the enquiry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator related to the enquiry","type":"string"},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator who has been assigned to the enquiry","type":"string"},"sourceName":{"description":"The name of the source that the enquiry was generated by","type":"string"},"homePhone":{"description":"The home phone number of the individual making the enquiry","type":"string"},"workPhone":{"description":"The work phone number of the individual making the enquiry","type":"string"},"mobilePhone":{"description":"The mobile phone number of the individual making the enquiry","type":"string"},"email":{"description":"The email of the individual making the enquiry","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"buying":{"description":"Request body used to create a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"renting":{"description":"The details specific to enquiries with a type of lettingsApplicant","type":"object","properties":{"rentFrom":{"format":"double","description":"The lower bound of the prospective tenant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the prospective tenant's budget","type":"number"},"rentFrequency":{"description":"How often the tenant would like to pay the rent (weekly/monthly/annually)","type":"string"}}},"bedrooms":{"format":"int32","description":"The number of bedrooms the prospective buyer or tenant requires","type":"integer"},"propertyIds":{"description":"A list of unique property identifiers that this enquiry relates to. Used to indicate the properties that a sales or lettings applicant has expressed an interest in","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the enquiry. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":45,"created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","title":"Mr","forename":"John","surname":"Smith","enquiryType":"salesApplicant","message":"Sales enquiry from Rightmove for 10 High Street, Solihull","status":"pending","marketingConsent":"grant","position":"renting","officeId":"OXF","applicantId":null,"createdPropertyId":null,"negotiatorId":null,"leadNegotiatorId":"ALL","sourceName":"Rightmove","homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"buying":{"priceFrom":null,"priceTo":null},"renting":{"rentFrom":null,"rentTo":null,"rentFrequency":null},"bedrooms":null,"propertyIds":["OXF190012"],"_eTag":null,"_links":{"self":{"href":"/enquiries/45"},"properties":{"href":"/properties/?id=OXF190012"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Enquiries"],"summary":"Updates an existing enquiry.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the enquiry to update.","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","description":"The model containing data to be used to update the enquiry.","schema":{"description":"Request body used to update an existing enquiry.","type":"object","properties":{"applicantId":{"description":"The unique identifier of the applicant associated to the enquiry.","type":"string"},"createdPropertyId":{"description":"The unique identifier of the property associated to the enquiry.","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the enquiry.","type":"string"},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator assigned to the enquiry.","type":"string"},"status":{"description":"The status of the enquiry (added/alreadyExists/duplicateEntry/pending/rejected/spam).","type":"string"}},"example":{"applicantId":"APP19000001","createdPropertyId":"OXF190012","negotiatorId":"ASD","leadNegotiatorId":"ALL","status":"added"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/identityChecks/":{"get":{"tags":["IdentityChecks"],"summary":"Retrieves a collection of identity checks","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of identity checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the identity checks returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["contact","document1","document2","documentType1","documentType2"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return identity checks where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"contactId","description":"Only return identity checks where the `contactId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return identity checks where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"status","description":"Only return identity checks where the `status` field matches one or more values provided. ","type":"array","items":{"enum":["unknown","unchecked","pending","fail","cancelled","warnings","pass"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"checkDateFrom","description":"Only return identity checks where the `checkDate` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"checkDateTo","description":"Only return identity checks where the `checkDate` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return identity checks where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return identity checks where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return identity checks where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return identity checks where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return identity checks where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a contact identity check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the identity check","type":"string"},"contactId":{"description":"The unique identifier of the contact/company associated to the identity check","type":"string"},"contactType":{"description":"The type of contact associated to the identity check (contact/company)","type":"string"},"created":{"format":"date-time","description":"The date and time when the identity check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the identity check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"identityDocument2":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"rightToRent":{"description":"The result of the right to rent check (NoRightToReside (NR), TimeLimitedRightToReside (TL), PermanentRightToReside (PR), null)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the identity check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the identity check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF19002002","contactId":"OXF19000001","contactType":null,"created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","checkDate":"2020-01-22","status":"pending","negotiatorId":"JAS","identityDocument1":{"documentId":"OXF19000022","typeId":"DL","expiry":"2050-03-22","details":"Driving License"},"identityDocument2":{"documentId":"OXF19000023","typeId":"PP","expiry":"2045-12-01","details":"Passport"},"rightToRent":"permanentRightToReside","metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/identityChecks/OXF19002002"},"contact":{"href":"/contacts/OXF19000001"},"documentType1":{"href":"/configuration/identityDocumentTypes/DL"},"document1":{"href":"/documents/OXF19000022"},"documentType2":{"href":"/configuration/identityDocumentTypes/PP"},"document2":{"href":"/documents/OXF19000023"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/identityChecks/?PageNumber=1&PageSize=1"},"first":{"href":"/identityChecks/?PageNumber=1&PageSize=1"},"next":{"href":"/identityChecks/?PageNumber=2&PageSize=1"},"last":{"href":"/identityChecks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["IdentityChecks"],"summary":"Create a new identity check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Model to create an identity check","schema":{"description":"Request body used to create a new contact identity check","required":["contactId","checkDate","status","negotiatorId"],"type":"object","properties":{"contactId":{"description":"The unique identifier of the contact associated to the identity check","type":"string"},"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Request body to attach an identity document to a new contact identity check\r\nA second identity document is not required and can be ignored by being set to null","required":["typeId"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number) (Required when 'fileData' is not given)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl) (Required when 'details' are not given)\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"name":{"description":"The filename to store the document as (Required when 'details' are not given)","type":"string"}}},"identityDocument2":{"description":"Request body to attach an identity document to a new contact identity check\r\nA second identity document is not required and can be ignored by being set to null","required":["typeId"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number) (Required when 'fileData' is not given)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl) (Required when 'details' are not given)\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"name":{"description":"The filename to store the document as (Required when 'details' are not given)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the identity check","type":"object","additionalProperties":{}}},"example":{"contactId":"OXF19000001","checkDate":"2020-01-22","status":"pending","negotiatorId":"JAS","identityDocument1":{"typeId":"DL","expiry":"2050-03-22","details":"Driving License","fileData":null,"fileUrl":null,"name":null},"identityDocument2":{"typeId":"PP","expiry":"2045-12-01","details":"Passport","fileData":null,"fileUrl":null,"name":null},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/identityChecks/{id}":{"get":{"tags":["IdentityChecks"],"summary":"Retrieves details of a specific identity check","operationId":"GetIdCheckById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Identity checks unique identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the identity check returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["contact","document1","document2","documentType1","documentType2"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a contact identity check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the identity check","type":"string"},"contactId":{"description":"The unique identifier of the contact/company associated to the identity check","type":"string"},"contactType":{"description":"The type of contact associated to the identity check (contact/company)","type":"string"},"created":{"format":"date-time","description":"The date and time when the identity check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the identity check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"identityDocument2":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"rightToRent":{"description":"The result of the right to rent check (NoRightToReside (NR), TimeLimitedRightToReside (TL), PermanentRightToReside (PR), null)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the identity check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the identity check. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF19002002","contactId":"OXF19000001","contactType":null,"created":"2019-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","checkDate":"2020-01-22","status":"pending","negotiatorId":"JAS","identityDocument1":{"documentId":"OXF19000022","typeId":"DL","expiry":"2050-03-22","details":"Driving License"},"identityDocument2":{"documentId":"OXF19000023","typeId":"PP","expiry":"2045-12-01","details":"Passport"},"rightToRent":"permanentRightToReside","metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/identityChecks/OXF19002002"},"contact":{"href":"/contacts/OXF19000001"},"documentType1":{"href":"/configuration/identityDocumentTypes/DL"},"document1":{"href":"/documents/OXF19000022"},"documentType2":{"href":"/configuration/identityDocumentTypes/PP"},"document2":{"href":"/documents/OXF19000023"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["IdentityChecks"],"summary":"Updates an identity check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The identification check id","required":true,"type":"string"},{"in":"body","name":"body","description":"Model to update an identity check","schema":{"description":"Request body used to update an exist contact identity check","type":"object","properties":{"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Request body to update an identity document attached to an existing contact identity check","type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl)\r\nThe total request payload cannot exceed 6Mb, regardless of the number of documents being sent","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to (This supports files up to 30MB)","type":"string"},"name":{"description":"The filename to store the document as","type":"string"}}},"identityDocument2":{"description":"Request body to update an identity document attached to an existing contact identity check","type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl)\r\nThe total request payload cannot exceed 6Mb, regardless of the number of documents being sent","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to (This supports files up to 30MB)","type":"string"},"name":{"description":"The filename to store the document as","type":"string"}}},"metadata":{"description":"App specific metadata to set against the identity check","type":"object","additionalProperties":{}}},"example":{"checkDate":"2020-01-22","status":"pending","negotiatorId":"JAS","identityDocument1":{"typeId":"DL","expiry":"2050-03-22","details":"Driving License","fileData":null,"fileUrl":null,"name":null},"identityDocument2":{"typeId":"PP","expiry":"2045-12-01","details":"Passport","fileData":null,"fileUrl":null,"name":null},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/identityChecks/signedUrl":{"post":{"tags":["IdentityChecks"],"summary":"Creates pre signed urls used for uploading documents between 6MB and 30MB","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create pre signed urls to upload files between 6MB and 30MB","required":["amount"],"type":"object","properties":{"amount":{"format":"int32","description":"The number of pre signed urls to create","type":"integer"}},"example":{"amount":1}}}],"responses":{"200":{"description":"Success","schema":{"description":"Request body used to create pre signed urls to upload files between 6MB and 30MB","required":["amount"],"type":"object","properties":{"amount":{"format":"int32","description":"The number of pre signed urls to create","type":"integer"}},"example":{"amount":1}}},"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/invoices/":{"get":{"tags":["Invoices"],"summary":"Retrieves a collection of invoices","produces":["application/json"],"parameters":[{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of properties to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/date/due)","type":"string"},{"in":"query","name":"negotiatorId","description":"Only return invoices where the `negotiatorId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return invoices where the `propertyId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"status","description":"Only return invoices where the `status` field matches the value provided. ","type":"array","items":{"enum":["pending","raised","partPaid","partCredited","credited","paid"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"dateFrom","description":"Only return invoices where the `date` field is on or after to the value provided.","type":"string","format":"date-time"},{"in":"query","name":"dateTo","description":"Only return invoices where the `date` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"dueDateFrom","description":"Only return invoices where the `dueDate` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"dueDateTo","description":"Only return invoices where the `dueDate` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return invoices where the `created` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return invoices where the `created` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return invoices where the `modified` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return invoices where the `modified` field is on or before the value provided.","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual invoice","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the invoice","type":"string"},"created":{"format":"date-time","description":"The date and time when the invoice was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the invoice was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"reference":{"description":"The invoice reference","type":"string"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the invoice","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the invoice","type":"string"},"description":{"description":"Description of the invoice","type":"string"},"status":{"description":"The status of the invoice","type":"string"},"date":{"format":"date-time","description":"The date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"dueDate":{"format":"date-time","description":"The due date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"isRaised":{"description":"Flag indicating whether the invoice has been raised","type":"boolean"},"netAmount":{"format":"double","description":"The net amount due for the invoice in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the invoice in the system base currency","type":"number"},"outstandingAmount":{"format":"double","description":"The value of the invoice outstanding in the system base currency","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT20000043","created":"2023-03-30","modified":"2024-03-19","reference":"RPT024","negotiatorId":"RPT","propertyId":"RPT200224","description":"Expenses incurred in March 2023","status":"pending","date":"2023-03-31","dueDate":"2024-09-30","isRaised":true,"netAmount":6986.73,"vatAmount":1397.35,"outstandingAmount":2245.43,"_links":{"self":{"href":"/invoices/RPT20000043"},"payments":{"href":"/invoices/payments?invoiceIds=RPT20000043"},"credits":{"href":"/invoices/credits?invoiceIds=RPT20000043"},"charges":{"href":"/invoices/charges?invoiceIds=RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}],"pageNumber":1,"pageSize":25,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/invoices/?PageNumber=1&PageSize=25"},"first":{"href":"/invoices/?PageNumber=1&PageSize=25"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/invoices/{id}":{"get":{"tags":["Invoices"],"summary":"Retrieves full details of a single invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Detailed representation of an individual invoice","type":"object","properties":{"id":{"description":"Unique identifier of the invoice","type":"string"},"created":{"format":"date-time","description":"The date and time when the invoice was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the invoice was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"reference":{"description":"The invoice reference","type":"string"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the invoice","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the invoice","type":"string"},"description":{"description":"Description of the invoice","type":"string"},"status":{"description":"The status of the invoice","type":"string"},"date":{"format":"date-time","description":"The date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"dueDate":{"format":"date-time","description":"The due date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"isRaised":{"description":"Flag indicating whether the invoice has been raised","type":"boolean"},"netAmount":{"format":"double","description":"The net amount due for the invoice in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the invoice in the system base currency","type":"number"},"outstandingAmount":{"format":"double","description":"The value of the invoice outstanding in the system base currency","type":"number"},"charges":{"description":"Collection of charges associated with the invoice","type":"array","items":{"description":"Representation of an invoice charge","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the charge","type":"string"},"created":{"format":"date-time","description":"The date and time when the charge was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the charge was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of charge (charge/advertising)","type":"string"},"invoiceId":{"description":"The unique identifier of the invoice with which this charge is associated","type":"string"},"propertyId":{"description":"The unique identifier of the property with which this charge is associated","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator with which this charge is associated","type":"string"},"vatCode":{"description":"The code representing the VAT applied to this charge","type":"string"},"description":{"description":"Description of the charge","type":"string"},"netAmount":{"format":"double","description":"The net amount","type":"number"},"vatAmount":{"format":"double","description":"The VAT amount","type":"number"}}}},"credits":{"description":"Collection of credits associated with the invoice","type":"array","items":{"description":"Representation of an individual credit","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the credit","type":"string"},"created":{"format":"date-time","description":"The date and time when the credit was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the credit was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the credit","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the credit","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the credit","type":"string"},"description":{"description":"Description of the credit","type":"string"},"date":{"format":"date-time","description":"The date of the credit","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the credit in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the credit in the system base currency","type":"number"}}}},"payments":{"description":"Collection of payments associated with the invoice","type":"array","items":{"description":"Representation of an individual payment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the payment","type":"string"},"created":{"format":"date-time","description":"The date and time when the payment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the payment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the payment","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the payment","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the payment","type":"string"},"description":{"description":"Description of the payment","type":"string"},"type":{"description":"The type of payment","type":"string"},"date":{"format":"date-time","description":"The date of the payment","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the payment in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the payment in the system base currency","type":"number"}}}},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true}}},"examples":{"application/json":{"id":"RPT20000043","created":"2023-03-30","modified":"2024-03-19","reference":"RPT024","negotiatorId":"RPT","propertyId":"RPT200224","description":"Expenses incurred in March 2023","status":"pending","date":"2023-03-31","dueDate":"2024-09-30","isRaised":true,"netAmount":6986.73,"vatAmount":1397.35,"outstandingAmount":2245.43,"charges":[{"id":"RPT20000043","created":"2023-03-30","modified":"2024-03-19","type":"charge","invoiceId":"INV2204567","propertyId":"RPT200224","negotiatorId":"RPT","vatCode":"UK20","description":"Expenses incurred in March 2023","netAmount":6986.73,"vatAmount":1397.35,"_links":{"self":{"href":"/invoices/charges/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"},"invoice":{"href":"/invoices/INV2204567"}},"_embedded":null}],"credits":[{"id":"RPT20000044","created":"2023-03-30","modified":"2024-03-19","negotiatorId":"RPT","propertyId":"RPT200224","invoiceId":"RPT20000043","description":"Credit applied May 2023","date":"2023-05-04","netAmount":1000,"vatAmount":0,"_links":{"self":{"href":"/invoices/credits/RPT20000044"},"invoice":{"href":"/invoices/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}],"payments":[{"id":"RPT20000044","created":"2023-03-30","modified":"2024-03-19","negotiatorId":"RPT","propertyId":"RPT200224","invoiceId":"RPT20000043","description":"Payment received April 2023","type":"accountPayment","date":"2023-04-11","netAmount":2986.73,"vatAmount":397.35,"_links":{"self":{"href":"/invoices/payments/RPT20000044"},"invoice":{"href":"/invoices/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}],"_links":{"self":{"href":"/invoices/RPT20000043"},"payments":{"href":"/invoices/payments?invoiceIds=RPT20000043"},"credits":{"href":"/invoices/credits?invoiceIds=RPT20000043"},"charges":{"href":"/invoices/charges?invoiceIds=RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/invoices/payments":{"get":{"tags":["Invoices"],"summary":"Retrieves a collection of payments","produces":["application/json"],"parameters":[{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of properties to be returned per page. Value can range between 1 and 100.","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/date)","type":"string"},{"in":"query","name":"negotiatorId","description":"Only return payments where the `negotiatorId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return payments where the `propertyId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"invoiceId","description":"Only return payments where the `invoiceId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"type","description":"Only return payments where the `type` field matches the value provided. ","type":"array","items":{"enum":["payment","accountPayment","advertisingPayment","buyerDeposit"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"dateFrom","description":"Only return payments where the `date` field is on or after to the value provided.","type":"string","format":"date-time"},{"in":"query","name":"dateTo","description":"Only return payments where the `date` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return payments where the `created` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return payments where the `created` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return payments where the `modified` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return payments where the `modified` field is on or before the value provided.","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual payment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the payment","type":"string"},"created":{"format":"date-time","description":"The date and time when the payment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the payment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the payment","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the payment","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the payment","type":"string"},"description":{"description":"Description of the payment","type":"string"},"type":{"description":"The type of payment","type":"string"},"date":{"format":"date-time","description":"The date of the payment","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the payment in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the payment in the system base currency","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT20000044","created":"2023-03-30","modified":"2024-03-19","negotiatorId":"RPT","propertyId":"RPT200224","invoiceId":"RPT20000043","description":"Payment received April 2023","type":"accountPayment","date":"2023-04-11","netAmount":2986.73,"vatAmount":397.35,"_links":{"self":{"href":"/invoices/payments/RPT20000044"},"invoice":{"href":"/invoices/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}],"pageNumber":1,"pageSize":25,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/invoices/payments/?PageNumber=1&PageSize=25"},"first":{"href":"/invoices/payments/?PageNumber=1&PageSize=25"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/invoices/payments/{id}":{"get":{"tags":["Invoices"],"summary":"Retrieves details of a single payment","produces":["application/json"],"parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an individual payment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the payment","type":"string"},"created":{"format":"date-time","description":"The date and time when the payment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the payment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the payment","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the payment","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the payment","type":"string"},"description":{"description":"Description of the payment","type":"string"},"type":{"description":"The type of payment","type":"string"},"date":{"format":"date-time","description":"The date of the payment","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the payment in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the payment in the system base currency","type":"number"}}},"examples":{"application/json":{"id":"RPT20000044","created":"2023-03-30","modified":"2024-03-19","negotiatorId":"RPT","propertyId":"RPT200224","invoiceId":"RPT20000043","description":"Payment received April 2023","type":"accountPayment","date":"2023-04-11","netAmount":2986.73,"vatAmount":397.35,"_links":{"self":{"href":"/invoices/payments/RPT20000044"},"invoice":{"href":"/invoices/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/invoices/credits":{"get":{"tags":["Invoices"],"summary":"Retrieves a collection of credits","produces":["application/json"],"parameters":[{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of properties to be returned per page. Value can range between 1 and 100.","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/date)","type":"string"},{"in":"query","name":"negotiatorId","description":"Only return credits where the `negotiatorId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return credits where the `propertyId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"invoiceId","description":"Only return credits where the `invoiceId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"dateFrom","description":"Only return credits where the `date` field is on or after to the value provided.","type":"string","format":"date-time"},{"in":"query","name":"dateTo","description":"Only return credits where the `date` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return credits where the `created` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return credits where the `created` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return credits where the `modified` field is on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return credits where the `modified` field is on or before the value provided.","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual credit","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the credit","type":"string"},"created":{"format":"date-time","description":"The date and time when the credit was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the credit was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the credit","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the credit","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the credit","type":"string"},"description":{"description":"Description of the credit","type":"string"},"date":{"format":"date-time","description":"The date of the credit","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the credit in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the credit in the system base currency","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT20000044","created":"2023-03-30","modified":"2024-03-19","negotiatorId":"RPT","propertyId":"RPT200224","invoiceId":"RPT20000043","description":"Credit applied May 2023","date":"2023-05-04","netAmount":1000,"vatAmount":0,"_links":{"self":{"href":"/invoices/credits/RPT20000044"},"invoice":{"href":"/invoices/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}],"pageNumber":1,"pageSize":25,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/invoices/credits/?PageNumber=1&PageSize=25"},"first":{"href":"/invoices/credits/?PageNumber=1&PageSize=25"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/invoices/credits/{id}":{"get":{"tags":["Invoices"],"summary":"Retrieves details of a single credit","produces":["application/json"],"parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an individual credit","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the credit","type":"string"},"created":{"format":"date-time","description":"The date and time when the credit was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the credit was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the credit","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the credit","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the credit","type":"string"},"description":{"description":"Description of the credit","type":"string"},"date":{"format":"date-time","description":"The date of the credit","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the credit in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the credit in the system base currency","type":"number"}}},"examples":{"application/json":{"id":"RPT20000044","created":"2023-03-30","modified":"2024-03-19","negotiatorId":"RPT","propertyId":"RPT200224","invoiceId":"RPT20000043","description":"Credit applied May 2023","date":"2023-05-04","netAmount":1000,"vatAmount":0,"_links":{"self":{"href":"/invoices/credits/RPT20000044"},"invoice":{"href":"/invoices/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/invoices/charges":{"get":{"tags":["Invoices"],"summary":"Retrieves a collection of charges","produces":["application/json"],"parameters":[{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of properties to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/date/due)","type":"string"},{"in":"query","name":"negotiatorId","description":"Only return charges where the `negotiatorId` field matches one or more of the values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return charges where the `propertyId` field matches one or more of the values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"invoiceId","description":"Only return charges where the `invoiceId` field matches one or more of the the value provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"createdFrom","description":"Only return charges where the `created` field is on or after to the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return charges where the `created` field is on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return charges where the `modified` field is on or after to the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return charges where the `modified` field is on or before the value provided.","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an invoice charge","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the charge","type":"string"},"created":{"format":"date-time","description":"The date and time when the charge was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the charge was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of charge (charge/advertising)","type":"string"},"invoiceId":{"description":"The unique identifier of the invoice with which this charge is associated","type":"string"},"propertyId":{"description":"The unique identifier of the property with which this charge is associated","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator with which this charge is associated","type":"string"},"vatCode":{"description":"The code representing the VAT applied to this charge","type":"string"},"description":{"description":"Description of the charge","type":"string"},"netAmount":{"format":"double","description":"The net amount","type":"number"},"vatAmount":{"format":"double","description":"The VAT amount","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT20000043","created":"2023-03-30","modified":"2024-03-19","type":"charge","invoiceId":"INV2204567","propertyId":"RPT200224","negotiatorId":"RPT","vatCode":"UK20","description":"Expenses incurred in March 2023","netAmount":6986.73,"vatAmount":1397.35,"_links":{"self":{"href":"/invoices/charges/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"},"invoice":{"href":"/invoices/INV2204567"}},"_embedded":null}],"pageNumber":1,"pageSize":25,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/invoices/?PageNumber=1&PageSize=25"},"first":{"href":"/invoices/?PageNumber=1&PageSize=25"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/invoices/charges/{id}":{"get":{"tags":["Invoices"],"summary":"Retrieves details of a single charge","produces":["application/json"],"parameters":[{"in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an invoice charge","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the charge","type":"string"},"created":{"format":"date-time","description":"The date and time when the charge was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the charge was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of charge (charge/advertising)","type":"string"},"invoiceId":{"description":"The unique identifier of the invoice with which this charge is associated","type":"string"},"propertyId":{"description":"The unique identifier of the property with which this charge is associated","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator with which this charge is associated","type":"string"},"vatCode":{"description":"The code representing the VAT applied to this charge","type":"string"},"description":{"description":"Description of the charge","type":"string"},"netAmount":{"format":"double","description":"The net amount","type":"number"},"vatAmount":{"format":"double","description":"The VAT amount","type":"number"}}},"examples":{"application/json":{"id":"RPT20000043","created":"2023-03-30","modified":"2024-03-19","type":"charge","invoiceId":"INV2204567","propertyId":"RPT200224","negotiatorId":"RPT","vatCode":"UK20","description":"Expenses incurred in March 2023","netAmount":6986.73,"vatAmount":1397.35,"_links":{"self":{"href":"/invoices/charges/RPT20000043"},"property":{"href":"/properties/RPT200224"},"negotiator":{"href":"/negotiators/RPT"},"invoice":{"href":"/invoices/INV2204567"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"description":{"description":"The detailed information regarding this error event","type":"string"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"security":[{"Authorization":[]}]}},"/journalEntries/":{"get":{"tags":["JournalEntries"],"summary":"Retrieves a collection of journal entries - timestamped events relating to one or more entities.\r\nAssociated type must be specified to retrieve `tenancy` and `worksOrder` related journal entries","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of journal entries to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/typeId)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the journal entries returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["property","negotiator","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"associatedType","description":"Only return journal entries where the `AssociatedType` field matches this value.\r\nTo retrieve `tenancy` or `worksOrder` related journal entries this must be selected. (applicant/contact/company/enquiry/landlord/tenancy/worksOrder)","type":"string"},{"in":"query","name":"associatedId","description":"Only return journal entries where the `AssociatedId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return journal entries where the `NegotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return journal entries where the `PropertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"typeId","description":"Only return journal entries where the `TypeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"createdFrom","description":"Only return journal entries where the `created` field is after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return journal entries where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a journal entry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"created":{"format":"date-time","description":"The date and time when the journal entry was created","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type","type":"string"},"associatedType":{"description":"The entity type the journal entry has been raised against (applicant/contact/company/enquiry/landlord/tenancy/worksOrder)","type":"string"},"associatedId":{"description":"The unique identifier of the entity the journal entry has been raised against. Can additionally be associated to a property","type":"string"},"typeId":{"description":"The type of journal entry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that created the entry","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"created":"2019-01-25T15:44:28Z","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","typeId":"DS","negotiatorId":"JAS","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","_links":{"negotiator":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF190022"},"type":{"href":"/configuration/journalEntryTypes/DS"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/journalEntries/?PageNumber=1&PageSize=1"},"first":{"href":"/journalEntries/?PageNumber=1&PageSize=1"},"next":{"href":"/journalEntries/?PageNumber=2&PageSize=1"},"last":{"href":"/journalEntries/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["JournalEntries"],"summary":"Create a new journal entry event against an entity","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the journal entry","schema":{"description":"Request body to create a journal entry","required":["description"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type the journal entry is related to.\r\nDefault value set to MI","type":"string"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type (Required when 'associatedId' is not given)","type":"string"},"associatedType":{"description":"The entity type the journal entry has been raised against (applicant/contact/company/enquiry/landlord/tenancy/worksOrder) (Required when 'associatedId' is given)\r\nTypeId must be set to WO when passing worksOrder","type":"string"},"associatedId":{"description":"The unique identifier of the entity the journal entry has been raised against. Can additionally be associated to a property (Required when 'propertyId' is not given)","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"},"negotiatorId":{"description":"The identifier of the negotiator recording the journal entry","type":"string"}},"example":{"typeId":"MI","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","negotiatorId":"JAS"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/journalEntries/landlords":{"get":{"tags":["JournalEntries"],"summary":"Retrieves a collection of landlord journal entries","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of journal entries to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/typeId)","type":"string"},{"in":"query","name":"landlordId","description":"Only return journal entries where the `LandlordId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return journal entries where the `NegotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return journal entries where the `PropertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"type","description":"Only return journal entries where the `Type` field matches the value provided (bankDetailsChange/detailsChange/telephoneContact)","type":"string"},{"in":"query","name":"createdFrom","description":"Only return journal entries where the `created` field is after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return journal entries where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a landlord related journal entry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"created":{"format":"date-time","description":"The date and time when the journal entry was created","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the journal entry is related to.","type":"string"},"type":{"description":"The type of journal entry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that created the entry","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"created":"2019-01-25T15:44:28Z","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","typeId":"DS","negotiatorId":"JAS","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","_links":{"negotiator":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF190022"},"type":{"href":"/configuration/journalEntryTypes/DS"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/journalEntries/?PageNumber=1&PageSize=1"},"first":{"href":"/journalEntries/?PageNumber=1&PageSize=1"},"next":{"href":"/journalEntries/?PageNumber=2&PageSize=1"},"last":{"href":"/journalEntries/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/journalEntries/bulk":{"post":{"tags":["JournalEntries"],"summary":"Create up to 100 journal entry events against an entity","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the journal entry","schema":{"description":"Request body to create bulk journal entry","type":"object","properties":{"createJournalEntry":{"description":"Collection of journal entries","type":"array","items":{"description":"Request body to create a journal entry","required":["description"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type the journal entry is related to.\r\nDefault value set to MI","type":"string"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type (Required when 'associatedId' is not given)","type":"string"},"associatedType":{"description":"The entity type the journal entry has been raised against (applicant/contact/company/enquiry/landlord/tenancy/worksOrder) (Required when 'associatedId' is given)\r\nTypeId must be set to WO when passing worksOrder","type":"string"},"associatedId":{"description":"The unique identifier of the entity the journal entry has been raised against. Can additionally be associated to a property (Required when 'propertyId' is not given)","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"},"negotiatorId":{"description":"The identifier of the negotiator recording the journal entry","type":"string"}},"example":{"typeId":"MI","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","negotiatorId":"JAS"}}}},"example":{"createJournalEntry":[{"typeId":"MI","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","negotiatorId":"JAS"},{"typeId":"WO","propertyId":"OXF190033","associatedType":"worksOrder","associatedId":"OXF190002","description":"Mr Paul Smith contacted us via phone call regarding 1 malden road","negotiatorId":"JAS"}]}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/landlords/":{"get":{"tags":["Landlords"],"summary":"Gets a paged collection of landlords","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of landlords to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the landlords returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","documents","office","properties","solicitor","source"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return landlords where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"email","description":"Only return landlords where the contacts `email` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return landlords where the `officeId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"active","description":"Only return landlords where the `active` field matches the value provided","type":"boolean"},{"in":"query","name":"address","description":"Only return landlords where the `address` field of a `related` contact matches the value provided","type":"string"},{"in":"query","name":"name","description":"Only return landlords where the `name` field of a `related` contact matches the value provided","type":"string"},{"in":"query","name":"createdFrom","description":"Only return landlords where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return landlords where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return landlords where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return landlords where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return landlords where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a landlord","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the landlord was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the landlord was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"active":{"description":"A flag determining whether or not the landlord is currently active","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Representation of a landlord's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the landlord. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact associated to a landlord","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the landlord","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the landlord. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF180001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","active":true,"solicitorId":"OXF19000101","officeId":"OXF","statementPreferences":["email","post"],"source":{"id":"GGL","type":"source"},"related":[{"id":"OXF19000101","name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"primaryAddress":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"additionalContactDetails":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/landlords/OXF180001"},"documents":{"href":"/documents/?associatedType=landlord&associatedId=OXF180001"},"appointments":{"href":"/appointments/?attendeeType=landlord&attendeeId=OXF180001"},"office":{"href":"/offices/OXF"},"properties":{"href":"/properties/?landlordId=OXF180001"},"relationships":{"href":"/landlords/OXF180001/relationships"},"solicitor":{"href":"/companies/OXF19000101"},"source":{"href":"/sources/GGL"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/landlords/?PageNumber=1&PageSize=1"},"first":{"href":"/landlords/?PageNumber=1&PageSize=1"},"next":{"href":"/landlords/?PageNumber=2&PageSize=1"},"last":{"href":"/landlords/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Landlords"],"summary":"Creates a new landlord","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model to create a landlord","schema":{"description":"Request body used to create a new landlord","required":["officeId","related"],"type":"object","properties":{"active":{"description":"A flag determining whether or not the landlord is currently active","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Request body used to set the source of a new landlord","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the landlord. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"Request body used to create a new relationship between a landlord and a contact or company","type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"}}}},"metadata":{"description":"App specific metadata that to set against the landlord","type":"object","additionalProperties":{}}},"example":{"active":true,"solicitorId":"OXF12300101","officeId":"OXF","statementPreferences":null,"source":{"id":"GGL","type":"source"},"related":[{"associatedId":"OXF12300101","associatedType":"contact"}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/landlords/{id}":{"get":{"tags":["Landlords"],"summary":"Gets a single landlord by its' unique identifier","operationId":"GetLandlordById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique landlord identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the landlord returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","documents","office","properties","solicitor","source"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a landlord","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the landlord was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the landlord was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"active":{"description":"A flag determining whether or not the landlord is currently active","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Representation of a landlord's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the landlord. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact associated to a landlord","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the landlord","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the landlord. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF180001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","active":true,"solicitorId":"OXF19000101","officeId":"OXF","statementPreferences":["email","post"],"source":{"id":"GGL","type":"source"},"related":[{"id":"OXF19000101","name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"primaryAddress":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"additionalContactDetails":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/landlords/OXF180001"},"documents":{"href":"/documents/?associatedType=landlord&associatedId=OXF180001"},"appointments":{"href":"/appointments/?attendeeType=landlord&attendeeId=OXF180001"},"office":{"href":"/offices/OXF"},"properties":{"href":"/properties/?landlordId=OXF180001"},"relationships":{"href":"/landlords/OXF180001/relationships"},"solicitor":{"href":"/companies/OXF19000101"},"source":{"href":"/sources/GGL"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Landlords"],"summary":"Updates a landlord","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the landlord to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update an existing landlord.","type":"object","properties":{"active":{"description":"A flag determining whether or not the landlord is currently active.","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor.","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord.","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Request body used to update the source of an existing landlord","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"metadata":{"description":"App specific metadata that to set against the landlord.","type":"object","additionalProperties":{}}},"example":{"active":true,"solicitorId":"OXF12300101","officeId":"OXF","statementPreferences":null,"source":{"id":"GGL","type":"source"},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/landlords/{id}/relationships":{"get":{"tags":["Landlords"],"summary":"Gets this landlords contact/company relationships","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique landlord identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of landlord relationships to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of relationship between a landlord and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord relationship","type":"string"},"landlordId":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not the relationship should be regarded as the main relationship for the parent landlord entity","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":[{"id":"OXF20002002","landlordId":"OXF190001","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"_links":{"self":{"href":"/landlords/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}]}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Landlords"],"summary":"Creates a relationship between this landlord and a contact/company","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique landlord identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"Model containing information used to create or update the relationship","schema":{"description":"Request body used to create or update a relationship between a landlord and a contact or company","required":["associatedId","associatedType","isMain"],"type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"},"isMain":{"description":"Flag denoting whether or not this relationship should be considered to be the main/primary relationship. Setting to true will automatically demote the existing primary relationship","type":"boolean"}},"example":{"associatedId":"OXF18000001","associatedType":"contact","isMain":false}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/landlords/{id}/relationships/{relationshipId}":{"get":{"tags":["Landlords"],"summary":"Gets a single relationship between this landlord and a contact/company","operationId":"GetLandlordRelationshipById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique landlord identifier","required":true,"type":"string"},{"in":"path","name":"relationshipId","description":"Unique relationship identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of relationship between a landlord and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord relationship","type":"string"},"landlordId":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not the relationship should be regarded as the main relationship for the parent landlord entity","type":"boolean"}}},"examples":{"application/json":{"id":"OXF20002002","landlordId":"OXF190001","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"_links":{"self":{"href":"/landlords/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Landlords"],"summary":"Deletes a specific relationship between this landlord and a contact/company","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique landlord identifier","required":true,"type":"string"},{"in":"path","name":"relationshipId","description":"Unique relationship identifier","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/metadata/":{"get":{"tags":["Metadata"],"summary":"Retrieves a collection of metadata records","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of metadata records to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"entityType","description":"The metadata entity type to filter by. This can represent a Foundations inbuilt type (an entity presented in our APIs) or it can be a custom entity type (a dynamic standalone metadata entity that you create).\r\n            \r\nInbuilt types: applicant, appointment, company, contact, conveyancing, identityCheck, landlord, negotiator, offer, office, property, task, vendor, worksOrder","type":"string"},{"in":"query","name":"id","description":"The unique identifier of the metadata record - more than one can be provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"entityId","description":"The unique identifier of the associated entity to fetch metadata for - more than one can be provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"filter","description":"The metadata filter expression - more than one can be provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"useTokenBasedPaging","description":"A flag to determine whether to use token based paging","type":"boolean"},{"in":"query","name":"nextPageToken","description":"The token used to retrieve the next page","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing the state of a metadata record for a given entity","type":"object","properties":{"id":{"description":"The unique identifier of this metadata record","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this metadata record was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"entityType":{"description":"The name of the entity type that this metadata record is associated to","type":"string"},"entityId":{"description":"The unique identifier of the the entity that this metadata is associated to","type":"string"},"metadata":{"description":"The JSON document content","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"SBOX_customEntityType_75c46440-5cb9-4db1-801d-f57eab8999e2_OXF19000001","modified":"2020-05-25T12:12:30.0000000Z","entityType":"customEntityType","entityId":"OXF19000001","metadata":{"CustomStringField":"my string","CustomBoolField":false,"CustomNumericField":100.5,"CustomDateField":"2019-06-15T13:45:30Z"}}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/metadata/?PageNumber=1&PageSize=1"},"first":{"href":"/metadata/?PageNumber=1&PageSize=1"},"next":{"href":"/metadata/?PageNumber=2&PageSize=1"},"last":{"href":"/metadata/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request"}},"security":[{"Authorization":[]}]},"post":{"tags":["Metadata"],"summary":"Creates a new metadata record","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"body","name":"body","description":"The create metadata record payload.","schema":{"description":"Payload to create a metadata record","required":["entityType","metadata"],"type":"object","properties":{"entityType":{"description":"The type of the entity that this metadata is related to. This can represent a Foundations inbuilt type (an entity presented in our APIs) or it can be a custom entity type (a dynamic standalone metadata entity that you create).\r\n            \r\nInbuilt types: applicant, appointment, company, contact, conveyancing, identityCheck, landlord, negotiator, offer, office, property, task, vendor, worksOrder","type":"string"},"entityId":{"description":"The unique identifier of the entity that this metadata is related to.\r\nFor custom entities, this can be left blank and an id will be generated for you.","type":"string"},"metadata":{"description":"The JSON document to store","type":"object","additionalProperties":{}}},"example":{"entityType":"customEntityType","entityId":"75c46440-5cb9-4db1-801d-f57eab8999e2","metadata":{"CustomStringField":"my string","CustomBoolField":false,"CustomNumericField":100.5,"CustomDateField":"2019-06-15T13:45:30Z"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/metadata/{id}":{"get":{"tags":["Metadata"],"summary":"Retrieves a specific metadata record","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the metadata record to return","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Model representing the state of a metadata record for a given entity","type":"object","properties":{"id":{"description":"The unique identifier of this metadata record","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this metadata record was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"entityType":{"description":"The name of the entity type that this metadata record is associated to","type":"string"},"entityId":{"description":"The unique identifier of the the entity that this metadata is associated to","type":"string"},"metadata":{"description":"The JSON document content","type":"object","additionalProperties":{}}}},"examples":{"application/json":{"id":"SBOX_customEntityType_75c46440-5cb9-4db1-801d-f57eab8999e2_OXF19000001","modified":"2020-05-25T12:12:30.0000000Z","entityType":"customEntityType","entityId":"OXF19000001","metadata":{"CustomStringField":"my string","CustomBoolField":false,"CustomNumericField":100.5,"CustomDateField":"2019-06-15T13:45:30Z"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"put":{"tags":["Metadata"],"summary":"Updates a metadata record","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the metadata record to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The update metadata payload.","schema":{"description":"Payload to update a metadata record","required":["metadata"],"type":"object","properties":{"metadata":{"description":"The updated JSON document to store","type":"object","additionalProperties":{}}},"example":{"metadata":{"CustomStringField":"my string","CustomBoolField":false,"CustomNumericField":100.5,"CustomDateField":"2019-06-15T13:45:30Z"}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Metadata"],"summary":"Updates a metadata record using a JSON patch document","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the metadata record to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The patch metadata payload.","schema":{"description":"The patch metadata payload.","type":"array","items":{"type":"object","properties":{"operationType":{"format":"int32","enum":[0,1,2,3,4,5,6],"type":"integer"},"path":{"type":"string"},"op":{"type":"string"},"from":{"type":"string"},"value":{"type":"object"}},"example":{"value":true,"path":"CustomBoolField","op":"replace"}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Metadata"],"summary":"Deletes a specific metadata record","parameters":[{"in":"path","name":"id","description":"Unique identifier of the metadata record to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/metadata/metadataSchema/{id}":{"get":{"tags":["MetadataSchema"],"summary":"Retrieves a specific metadata schema, used to validate a metadata entity","operationId":"GetSchemaById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the JSON schema to return","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Model representing a JSON schema used to validate a specific entity type","type":"object","properties":{"id":{"description":"The unique identifier of this JSON schema","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this JSON schema was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"schema":{"description":"The JSON schema document","type":"string"}}},"examples":{"application/json":{"id":"customEntityType","modified":"2020-01-26T09:24:02.0000000Z","schema":"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"type\": \"object\",  \"properties\": { \"CustomNumericField\": { \"type\": \"integer\" }}}"}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"put":{"tags":["MetadataSchema"],"summary":"Updates an existing metadata schema, used to validate a metadata entity","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the JSON schema to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The update JSON schema request.","schema":{"description":"Payload to update a JSON schema","required":["schema"],"type":"object","properties":{"schema":{"description":"The updated JSON schema to store","type":"string"}},"example":{"schema":"{\"$schema\": \"http://json-schema.org/draft-04/schema#\", \"type\": \"object\",  \"properties\": { \"CustomStringField\": { \"type\": \"string\" }}}"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/metadata/metadataSchema":{"get":{"tags":["MetadataSchema"],"summary":"Retrieves a paged collection of metadata schemas, used to validate metadata entities","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of JSON schemas to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"entityType","description":"The name of the entity type that this JSON schema is associated to","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing a JSON schema used to validate a specific entity type","type":"object","properties":{"id":{"description":"The unique identifier of this JSON schema","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this JSON schema was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"schema":{"description":"The JSON schema document","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"customEntityType","modified":"2020-01-26T09:24:02.0000000Z","schema":"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"type\": \"object\",  \"properties\": { \"CustomNumericField\": { \"type\": \"integer\" }}}"}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/schema/?PageNumber=1&PageSize=1"},"first":{"href":"/schema/?PageNumber=1&PageSize=1"},"next":{"href":"/schema/?PageNumber=2&PageSize=1"},"last":{"href":"/schema/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request"}},"security":[{"Authorization":[]}]},"post":{"tags":["MetadataSchema"],"summary":"Creates a new metadata schema, used to validate a metadata entity","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"body","name":"body","description":"The create JSON schema request.","schema":{"description":"Payload to create a JSON schema for metadata validation","required":["entityType","schema"],"type":"object","properties":{"entityType":{"description":"The name of the entity type that this schema is related to","type":"string"},"schema":{"description":"The JSON schema used to validate entities of this type","type":"string"}},"example":{"entityType":"customEntityType","schema":"{\"$schema\": \"http://json-schema.org/draft-04/schema#\",\"type\": \"object\", \"properties\": { \"CustomNumericField\": { \"type\": \"integer\" }}}"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/negotiators/":{"get":{"tags":["Negotiators"],"summary":"Gets a collection of negotiators matching the filter criteria provided","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of negotiators to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (name/officeId)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the negotiators returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["office"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return negotiators where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return negotiators where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"email","description":"Only return negotiators where the `email` field matches the value provided","type":"string"},{"in":"query","name":"name","description":"Only return negotiators where the `name` field matches the value provided","type":"string"},{"in":"query","name":"createdFrom","description":"Only return negotiators where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return negotiators where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return negotiators where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return negotiators where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"active","description":"Only return negotiators where the 'active' field matches the value provided","type":"boolean"},{"in":"query","name":"metadata","description":"Only return negotiators where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a negotiator","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the negotiator","type":"string"},"created":{"format":"date-time","description":"The date and time when the negotiator was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the negotiator was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"officeId":{"description":"The unique identifier of the office that the negotiator is attached to","type":"string"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"profileImageUrl":{"description":"The URL of the optional negotiator profile image","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the negotiator","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the negotiator. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"JAS","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","name":"Mr John Smith","jobTitle":"Senior Sales Negotiator","officeId":"OXF","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","profileImageUrl":null,"active":true,"diaryNegotiatorIds":["ADV","TST"],"diaryOfficeIds":["OXF","RPT"],"additionalContactDetails":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/negotiators/JAS"},"office":{"href":"/offices/OXF"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/negotiators/?PageNumber=1&PageSize=1"},"first":{"href":"/negotiators/?PageNumber=1&PageSize=1"},"next":{"href":"/negotiators/?PageNumber=2&PageSize=1"},"last":{"href":"/negotiators/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Negotiators"],"summary":"Creates a new negotiator","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create an negotiator","schema":{"description":"Request body used to create a new negotiator","required":["name","officeId"],"type":"object","properties":{"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"officeId":{"description":"The unique identifier of the office that the negotiator is attached to","type":"string"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the negotiator","type":"object","additionalProperties":{}}},"example":{"name":"Mr John Smith","jobTitle":"Senior Sales Negotiator","active":true,"officeId":"OXF","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","diaryNegotiatorIds":null,"diaryOfficeIds":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/negotiators/{id}":{"get":{"tags":["Negotiators"],"summary":"Gets a specific negotiator by unique identifier","operationId":"GetNegotiatorById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the negotiator","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the negotiator returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["office"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a negotiator","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the negotiator","type":"string"},"created":{"format":"date-time","description":"The date and time when the negotiator was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the negotiator was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"officeId":{"description":"The unique identifier of the office that the negotiator is attached to","type":"string"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"profileImageUrl":{"description":"The URL of the optional negotiator profile image","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the negotiator","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the negotiator. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"JAS","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","name":"Mr John Smith","jobTitle":"Senior Sales Negotiator","officeId":"OXF","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","profileImageUrl":null,"active":true,"diaryNegotiatorIds":["ADV","TST"],"diaryOfficeIds":["OXF","RPT"],"additionalContactDetails":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/negotiators/JAS"},"office":{"href":"/offices/OXF"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Negotiators"],"summary":"Updates a negotiator by unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the negotiator to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the negotiator.","schema":{"description":"Request body used to update an existing negotiator","type":"object","properties":{"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the negotiator","type":"object","additionalProperties":{}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Request body used to update an existing negotiator additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}},"example":{"name":"Mr John Smith","jobTitle":"Senior Sales Negotiator","active":true,"workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","diaryNegotiatorIds":null,"diaryOfficeIds":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"additionalContactDetails":[{"type":"DX Number","value":"01234 567890"},{"type":"Online Number","value":"07123 456789"}]}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/notifications/":{"post":{"tags":["Notifications"],"summary":"Publishes a new notification to deliver to one or more recipients - please note this endpoint cannot be used via the DeveloperPortal and must be used in the context of your own app","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"body","name":"body","description":"The notification to publish","schema":{"description":"Payload for creating a notification","type":"object","properties":{"type":{"description":"The notification type (telephony)","type":"string"},"subType":{"description":"The sub category type (answeredCall/endedCall/incomingCall/missedCall)","type":"string"},"products":{"description":"The products the notification is associated to, and will be delivered to","type":"array","items":{"type":"string"}},"targets":{"description":"Payload for defining notification targets","type":"object","properties":{"negotiatorId":{"description":"The identifier of the negotiators whom should receive the notification","type":"array","items":{"type":"string"}}}},"payload":{"description":"The payload to deliver to the specified target(s). Note that the payload must match the expected format\r\nbased on the type/subType combination and will be validated accordingly. Please refer to [the documentation](https://foundations-documentation.reapit.cloud/api/notifications)\r\nfor more information"}},"example":{"type":"telephony","subType":"missedCall","products":["AgencyCloud"],"targets":{"negotiatorId":["ADV"]},"payload":{}}}}],"responses":{"202":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"Authorization":[]}]}},"/offers/":{"get":{"tags":["Offers"],"summary":"Gets a paged collection of offers","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of offers to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/propertyId/applicantId/status/amount)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the offers returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["applicant","conveyancing","property","negotiator"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return offers where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"applicantId","description":"Only return offers where the `applicantId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return offers where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"status","description":"Only return offers where the `status` field matches one or more values provided ","type":"array","items":{"enum":["pending","withdrawn","rejected","accepted","noteOfInterest","noteOfInterestWithdrawn"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"address","description":"Only return offers where the `address` field of a `related` contact matches the value provided","type":"string"},{"in":"query","name":"name","description":"Only return offers where the `name` field of a `related` contact matches the value provided","type":"string"},{"in":"query","name":"amountFrom","description":"Only return offers where the `amount` field is greater than or equal to the value provided","type":"number","format":"double"},{"in":"query","name":"amountTo","description":"Only return offers where the `amount` field is less than or equal to the value provided","type":"number","format":"double"},{"in":"query","name":"dateFrom","description":"Only return offers where the `date` field is on or after the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"dateTo","description":"Only return offers where the `date` field is on or before the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return offers where the `created` field is on or after the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return offers where the `created` field is on or before the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return offers where the `modified` field is on or after the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return offers where the `modified` field is on or before the ISO8601 date value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return offers where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an offer","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The the date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the offer was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"applicantId":{"description":"The unique identifier of the applicant associated to the offer","type":"string"},"companyId":{"description":"The unique identifier of the company associated to the offer","type":"string"},"contactId":{"description":"The unique identifier of the contact associated to the offer","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the offer","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"related":{"description":"A collection of contacts associated to the offer","type":"array","items":{"description":"A summarised view of the details of a contact associated to an offer","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the offer","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the offer. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF2000001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","currency":"GBP","applicantId":"OXF123001","companyId":null,"contactId":null,"propertyId":"OXF123022","negotiatorId":"JAS","date":"2018-11-05","amount":245000,"status":"pending","inclusions":"White goods must be left","exclusions":"Curtains must be removed","conditions":"Must move in within 3 months.","related":[{"id":"OXF12300101","name":"Reapit","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"primaryAddress":{"buildingName":null,"buildingNumber":"1","line1":"Test House","line2":"Test Lane","line3":"County of Test","line4":"Test City","postcode":"A11 2BB","countryId":"GB"},"additionalContactDetails":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/offers/OXF2000001"},"negotiator":{"href":"/negotiators/JAS"},"applicant":{"href":"/applicants/OXF123001"},"property":{"href":"/properties/OXF123022"},"conveyancing":{"href":"/conveyancing/OXF2000001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/offers/?PageNumber=1&PageSize=1"},"first":{"href":"/offers/?PageNumber=1&PageSize=1"},"next":{"href":"/offers/?PageNumber=2&PageSize=1"},"last":{"href":"/offers/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Offers"],"summary":"Creates a new offer","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create a new offer","required":["applicantId","propertyId","date","amount","status"],"type":"object","properties":{"applicantId":{"description":"The unique identifier of the applicant associated to the offer","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the offer","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"metadata":{"description":"App specific metadata to set against the offer","type":"object","additionalProperties":{}}},"example":{"applicantId":"OXF123001","propertyId":"OXF123022","negotiatorId":"JAS","date":"2018-11-05","amount":245000,"status":"pending","inclusions":"White goods must be left","exclusions":"Curtains must be removed","conditions":"Must move in within 3 months.","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/offers/{id}":{"get":{"tags":["Offers"],"summary":"Gets a specific offer by unique identifier","operationId":"GetOfferById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the offer","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the offer returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["applicant","conveyancing","property","negotiator"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an offer","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The the date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the offer was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"applicantId":{"description":"The unique identifier of the applicant associated to the offer","type":"string"},"companyId":{"description":"The unique identifier of the company associated to the offer","type":"string"},"contactId":{"description":"The unique identifier of the contact associated to the offer","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the offer","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"related":{"description":"A collection of contacts associated to the offer","type":"array","items":{"description":"A summarised view of the details of a contact associated to an offer","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the offer","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the offer. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF2000001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","currency":"GBP","applicantId":"OXF123001","companyId":null,"contactId":null,"propertyId":"OXF123022","negotiatorId":"JAS","date":"2018-11-05","amount":245000,"status":"pending","inclusions":"White goods must be left","exclusions":"Curtains must be removed","conditions":"Must move in within 3 months.","related":[{"id":"OXF12300101","name":"Reapit","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"primaryAddress":{"buildingName":null,"buildingNumber":"1","line1":"Test House","line2":"Test Lane","line3":"County of Test","line4":"Test City","postcode":"A11 2BB","countryId":"GB"},"additionalContactDetails":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/offers/OXF2000001"},"negotiator":{"href":"/negotiators/JAS"},"applicant":{"href":"/applicants/OXF123001"},"property":{"href":"/properties/OXF123022"},"conveyancing":{"href":"/conveyancing/OXF2000001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Offers"],"summary":"Updates an offer by unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the offer to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the offer.","schema":{"description":"Request body used to update an existing offer","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"metadata":{"description":"App specific metadata to set against the offer","type":"object","additionalProperties":{}}},"example":{"negotiatorId":"JAS","date":"2018-11-05","amount":245000,"status":"pending","inclusions":"White goods must be left","exclusions":"Curtains must be removed","conditions":"Must move in within 3 months.","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/offices/":{"get":{"tags":["Offices"],"summary":"Gets a collection of offices matching the filter criteria provided","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of offices to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/name/address)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the offices returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["negotiators"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"address","type":"string"},{"in":"query","name":"name","type":"string"},{"in":"query","name":"region","type":"string"},{"in":"query","name":"active","type":"boolean"},{"in":"query","name":"createdFrom","description":"Only return offices where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return offices where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return offices where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return offices where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return offices where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an office","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the office","type":"string"},"created":{"format":"date-time","description":"The date and time when the office was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the office was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the office","type":"string"},"manager":{"description":"The name of the office manager","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"region":{"description":"The region that the office is in","type":"string"},"referTo":{"description":"The referral postcodes.","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"onlineServices":{"description":"Gets or sets the collection of online services associated with the office.","type":"array","items":{"description":"Representation of an online service associated with an office","type":"object","properties":{"id":{"description":"Online service identifier","type":"string"},"name":{"description":"Online service name","type":"string"},"code":{"description":"Branch code associated with the online service","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the office","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the office. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","name":"Reapit","manager":"Mr John Smith","active":false,"region":null,"referTo":"B91, B90","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":0,"longitude":0}},"additionalContactDetails":null,"workPhone":"01234 567890","email":"example@email.com","onlineServices":[],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"extrasField":null,"_links":{"self":{"href":"/offices/OXF"},"negotiators":{"href":"/negotiators/?officeId=OXF"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/offices/?PageNumber=1&PageSize=1"},"first":{"href":"/offices/?PageNumber=1&PageSize=1"},"next":{"href":"/offices/?PageNumber=2&PageSize=1"},"last":{"href":"/offices/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Offices"],"summary":"Creates a new office","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create an office","schema":{"description":"Request body used to create a new office","required":["name","address"],"type":"object","properties":{"name":{"description":"The name of the office","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"manager":{"description":"The name of the office manager","type":"string"},"address":{"description":"Request body used to set the address of a new office","required":["line1"],"type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of a new address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"metadata":{"description":"App specific metadata to set against the office","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","active":true,"manager":"Mr John Smith","address":{"buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":0,"longitude":0}},"workPhone":"01234 567890","email":"example@email.com","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/offices/{id}":{"get":{"tags":["Offices"],"summary":"Gets a specific office by unique identifier","operationId":"GetOfficeById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the office","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the office returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["negotiators"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of an office","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the office","type":"string"},"created":{"format":"date-time","description":"The date and time when the office was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the office was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the office","type":"string"},"manager":{"description":"The name of the office manager","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"region":{"description":"The region that the office is in","type":"string"},"referTo":{"description":"The referral postcodes.","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"onlineServices":{"description":"Gets or sets the collection of online services associated with the office.","type":"array","items":{"description":"Representation of an online service associated with an office","type":"object","properties":{"id":{"description":"Online service identifier","type":"string"},"name":{"description":"Online service name","type":"string"},"code":{"description":"Branch code associated with the online service","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the office","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the office. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}},"examples":{"application/json":{"id":"OXF","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","name":"Reapit","manager":"Mr John Smith","active":false,"region":null,"referTo":"B91, B90","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":0,"longitude":0}},"additionalContactDetails":null,"workPhone":"01234 567890","email":"example@email.com","onlineServices":[],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"extrasField":null,"_links":{"self":{"href":"/offices/OXF"},"negotiators":{"href":"/negotiators/?officeId=OXF"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Offices"],"summary":"Updates an office by unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the office to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the office.","schema":{"description":"Request body used to update an existing office","type":"object","properties":{"name":{"description":"The name of the office","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"manager":{"description":"The name of the office manager","type":"string"},"address":{"description":"Request body used to update the address of an existing office","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of an existing address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"metadata":{"description":"App specific metadata to set against the office","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","active":null,"manager":"Mr John Smith","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":0,"longitude":0}},"workPhone":"01234 567890","email":"example@email.com","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/properties/":{"get":{"tags":["Properties"],"summary":"Gets a collection of properties","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of properties to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/address/bedrooms/negotiatorId/officeId/price/rent)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the properties returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","area","certificates","department","documents","images","keys","landlord","multilingual","negotiator","offers","offices","tenancies","vendor"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return properties where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"age","description":"Only return properties where the `age` field contains one or more values provided ","type":"array","items":{"enum":["period","new","modern","old"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"agentRole","description":"Only return properties where the `letting.agentRole` field matches one or more values provided ","type":"array","items":{"enum":["managed","rentCollection","collectFirstPayment","collectRentToDate","lettingOnly","introducingTenant"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"areaId","description":"Only return properties where the `areaId` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"excludeAreaId","description":"Only return properties where the `areaId` field does not match any of the values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"landlordId","description":"Only return properties where the `landlordId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"lettingStatus","description":"Only return properties where the `lettingStatus` field matches one or more values provided ","type":"array","items":{"enum":["valuation","toLet","toLetUnavailable","underOffer","underOfferUnavailable","arrangingTenancyUnavailable","arrangingTenancy","tenancyCurrentUnavailable","tenancyCurrent","tenancyFinished","tenancyCancelled","sold","letByOtherAgent","letPrivately","provisional","withdrawn"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"locality","description":"Only return properties where the `locality` field contains one or more values provided ","type":"array","items":{"enum":["rural","village","townCity"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"marketingMode","description":"Only return properties where the `marketingMode` field matches one or more values provided. Note that querying for single marketing mode properties (eg `selling`) will also return properties that are marketed in both modes (`selling` AND `sellingAndLetting`) ","type":"array","items":{"enum":["selling","letting","sellingAndLetting"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"masterId","description":"Only return properties where the master property id matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return properties where the `negotiatorIds` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return properties where the `officeIds` field matches one or more values provided.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"parking","description":"Only return properties where the `parking` field contains one or more values provided ","type":"array","items":{"enum":["residents","offStreet","secure","underground","garage","doubleGarage","tripleGarage","carport"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"sellingStatus","description":"Only return properties where the `sellingStatus` field matches or more values provided ","type":"array","items":{"enum":["preAppraisal","valuation","paidValuation","forSale","forSaleUnavailable","underOffer","underOfferUnavailable","reserved","exchanged","completed","soldExternally","withdrawn"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"situation","description":"Only return properties where the `garden` field contains one or more values provided ","type":"array","items":{"enum":["garden","land","patio","roofTerrace","conservatory","balcony","communalGardens","outsideSpace"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"style","description":"Only return properties where the `style` field contains one or more values provided ","type":"array","items":{"enum":["terraced","endTerrace","detached","semiDetached","linkDetached","mews","basement","lowerGroundFloor","groundFloor","firstFloor","upperFloor","upperFloorWithLift","penthouse","duplex"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"type","description":"Only return properties where the `type` field contains one or more values provided ","type":"array","items":{"enum":["house","bungalow","flatApartment","maisonette","land","farm","cottage","studio","townhouse","developmentPlot"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"market","description":"Only return properties where the `market` field contains one or more values provided ","type":"array","items":{"enum":["local","openA","openB","openC","openD"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"address","description":"Only return properties where the `address` field matches the value provided","type":"string"},{"in":"query","name":"countryId","description":"Only return properties where the `countryId` in the `address` field matches the value provided","type":"string"},{"in":"query","name":"departmentId","description":"Only return properties where the `departmentId` field matches the value provided","type":"string"},{"in":"query","name":"bedroomsFrom","description":"Only return properties where the `bedrooms` field is more than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"bedroomsTo","description":"Only return properties where the `bedrooms` field is less than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"priceFrom","description":"Only return properties where the `selling.price` field is more than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"priceTo","description":"Only return properties where the `selling.price` field is less than or equal to the value provided","type":"integer","format":"int32"},{"in":"query","name":"priceFiltersCurrency","description":"The currency to filter by when `priceFrom` and/or `priceTo` are provided (This will default to the base currency when not provided)","type":"string"},{"in":"query","name":"rentFrom","description":"Only return properties where the `letting.rent` field is more than or equal to the value provided","type":"number","format":"double"},{"in":"query","name":"rentTo","description":"Only return properties where the `letting.rent` field is less than or equal to the value provided","type":"number","format":"double"},{"in":"query","name":"rentFrequency","description":"The rent collection frequency that 'rentFrom' and 'rentTo' parameters are in relation to. Defaults to monthly. ","type":"array","items":{"enum":["weekly","monthly","annually"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"internetAdvertising","description":"Only return properties where the `internetAdvertising` field matches the value provided","type":"boolean"},{"in":"query","name":"isExternal","description":"Only return properties where the `isExternal` field matches the value provided","type":"boolean"},{"in":"query","name":"fromArchive","description":"Only return properties where the `fromArchive` field matches the value given","type":"boolean"},{"in":"query","name":"availableFrom","description":"Only return properties where the 'letting.availableFrom' field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return properties where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return properties where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return properties which have been modified/created since the given ISO8601 date and time provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return properties which have been modified/created before the given ISO8601 date and time provided.","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return properties where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property. Properties can be grouped into developments in the source data, functionality that is typically used by New Homes departments.\r\nThe _links collection will expose specific links to allow developers to navigate through a particular development, should a property be configured in this manner. Refer to commentary on the _links collection for more details","type":"object","properties":{"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the property","type":"string"},"created":{"format":"date-time","description":"The date and time when the property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"marketingMode":{"description":"The marketing mode of the property (selling/letting/sellingAndLetting)","type":"string"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"localTimeZone":{"description":"The local timezone for the address, based on the Geolocation coordinates","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"listingAdvertisementNumber":{"description":"The listing advertisement number of the property","type":"string"},"localAuthorityCompanyId":{"description":"The property's local authority","type":"string"},"localAuthorityCompanyName":{"description":"The name of the property's local authority","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"departmentId":{"description":"The unique identifier of the department the property is associated with. The property will only match to applicants with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"clientAccountsAssistantId":{"description":"The unique identifier of the client accounts assistant of the property","type":"string"},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property or properties. This is typically used when marketing development sites and would be set on the master record. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"disabledPortalIds":{"description":"A collection of identifiers of portals that the property should not be displayed on","type":"array","items":{"type":"string"}},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"isExternal":{"description":"A flag denoting whether or not the property has been instructed by another estate agent","type":"boolean"},"depositSchemeAccepted":{"description":"A flag denoting whether or not the property accepts deposit schemes","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information about the property.","type":"string"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"featuredImageUrl":{"format":"uri","description":"The properties featured image url","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"what3Words":{"description":"The What3Words identifier for the property.","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14"},"floorLevel":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"archivedOn":{"format":"date-time","description":"The date and time the property was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the property is archived","type":"boolean"},"rural":{"description":"Details specific to rural properties","type":"object","properties":{"tenureId":{"description":"Details of the rural tenure associated with the property.","type":"string"},"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"externalArea":{"description":"Representation of the plot size of a property","type":"object","properties":{"type":{"description":"The unit of area (acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Representation of the internal dimensions of a property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"epc":{"description":"Representation of EPC statistics","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerRating":{"description":"The current energy efficiency letter rating (A-G). This is generated from the `eer` value\r\nfor systems that do not have an explicit EPC Rating component","type":"string"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eerPotentialRating":{"description":"The potential energy efficiency letter rating (A-G). This is generated from the `eerPotential` value","type":"string"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirRating":{"description":"The current environment impact letter rating (A-G). This is generated from the `eir` value","type":"string"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"eirPotentialRating":{"description":"The potential environment impact letter rating (A-G). This is generated from the `eirPotential` value","type":"string"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Representation of a commercial EPC statistics","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"rightsRestrictions":{"description":"Details specific to a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Details specific to a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"selling":{"description":"Representation of property details specific to sales marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"double","description":"The marketing price of the property","type":"number"},"priceTo":{"format":"double","description":"The maximum price of a property on the development plot","type":"number"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Representation of the tenure of a property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"vendorId":{"description":"The unique identifier of the vendor selling the property","type":"string"},"agency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when Agency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"exchangedCompanyFee":{"format":"double","description":"The actual fee amount to be collected by the agent - often based on the exchange price of the property","type":"number"},"estimatedMonthlyRetailValue":{"format":"double","description":"The estimated monthly retail amount","type":"number"},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"exchangedPrice":{"format":"int32","description":"The price the property exchanged/sold for","type":"integer"},"exchangedOfficeId":{"description":"The unique identifier of the office that sold the property","type":"string"},"grossYieldPercentage":{"format":"double","description":"The gross yield amount","type":"number"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"letting":{"description":"Representation of property details specific to lettings marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"The minimum number of months the property can be let out for","type":"integer"},"numberOfCheques":{"format":"int32","description":"The number of cheques payment required to rent the property","type":"integer"},"propertyManagerId":{"description":"The unique identifier of the negotiator that manages the property","type":"string"},"managementCompanyIds":{"description":"The unique identifiers of the management companies associated to the property","type":"array","items":{"type":"string"}},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"managementFee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Representation of the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Representation of property details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property licencing","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date","description":"The date the licence was applied for","type":"string","example":"2019-08-14"},"granted":{"format":"date","description":"The date the licence application was granted","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The date the licence will expire","type":"string","example":"2019-08-14"}}}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"withdrawalReason":{"description":"Representation of withdrawal details specific to lettings marketing","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}},"preferredSuppliers":{"description":"List of preferred suppliers of the property","type":"array","items":{"description":"Representation of the preferred supplier details to lettings marketing.","type":"object","properties":{"id":{"description":"Unique identifier of the supplier.","type":"string"},"name":{"description":"Name of the supplier.","type":"string"}}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"commercial":{"description":"An properties commercial details","type":"object","properties":{"useClass":{"description":"The commercial use attributes (eg a1, a2, b1), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Any specific details relating to the marketing of a property in Guernsey","type":"object","properties":{"market":{"description":"Attributes describing which markets the property is available in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"irl":{"description":"Any specific details relating to the marketing of a property in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Any specific details relating to energy performance ratings for properties marketed in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The attributes describing the property's special features (eg swimmingPool, tennisCourt), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedAttributes":{"description":"The attributes associated to the property which are not currently mapped. These are defined the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped attribute type","type":"object","properties":{"type":{"description":"The type of unmapped attribute (style/type/situation/parking/age/locality/special)","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"availableServicesIds":{"description":"Identifiers of any services connected at the property","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"lostInstructionDate":{"format":"date-time","description":"The date that this property became a lost instruction","type":"string","example":"2019-08-14T12:30:02Z"},"lostInstructionNote":{"description":"The notes regarding the lost instruction","type":"string"},"developmentSiteType":{"description":"The type of development","type":"string"},"metadata":{"description":"App specific metadata that has been set against the property","type":"object","additionalProperties":{}},"keywords":{"description":"The keywords associated with property","type":"array","items":{"type":"string"}},"completionStatus":{"description":"The completion status of the property (notSet/completed/offPlan/completedPrimary/offPlanPrimary)","type":"string"},"paymentMethod":{"description":"The payment method of the property (notSet/cash/installments/cashOrInstallments)","type":"string"},"activeLanguages":{"description":"The languages currently set for the property.","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the property. Used for managing update concurrency","type":"string","readOnly":true},"_links":{"description":"Collection containing relative URLs to data associated with the property.\r\nIn the case of a development - where a property is grouped with, or associated to another property by way of a parent/child relationship,\r\nthe collection will contain a _master_ or _subPlot_ link depending on the property type. Where the property is the master record in a development (the parent),\r\na _subPlots_ link will be included in the collection giving you access to all the plots (the children) within the development. Where the property is a sub plot that forms part of a \r\ndevelopment, a _master_ link will be included in the collection giving you access to the master record.","type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF200008","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","lastCall":null,"nextCall":null,"marketingMode":"sellingAndLetting","currency":"GBP","alternateId":"10001","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","localTimeZone":null,"geolocation":{"latitude":52.4158586,"longitude":1.7773383}},"areaId":"BRM","strapline":null,"description":"We are delighted to offer for sale this EXTENDED THREE BEDROOMED SEMI DETACHED PROPERTY situated in a much sought after residential location of Greasby, having the benefits of two separate entertaining rooms, morning room, extended kitchen. To the first floor there are three bedrooms, spacious family bathroom, gas central heating gardens front and rear and off road parking.","longDescription":"The ground floor accommodation comprises of a spacious reception hall with a wet bar, a grand drawing room, master bedroom suite and a further bedroom suite. The lower floor comprises of an eat in kitchen leading to converted vaults which could be used as staff accommodation or a study. There is also separate dining room and a further bedroom suite.","listingAdvertisementNumber":"RERA10000105","localAuthorityCompanyId":null,"localAuthorityCompanyName":null,"summary":null,"departmentId":"G","negotiatorId":"JAS","clientAccountsAssistantId":null,"bedrooms":4,"bedroomsMax":6,"receptions":1,"receptionsMax":2,"bathrooms":2,"bathroomsMax":3,"numberOfUnits":null,"parkingSpaces":0,"councilTax":"A","disabledPortalIds":["LM","MT"],"internetAdvertising":true,"isExternal":false,"depositSchemeAccepted":false,"viewingArrangements":"Accompanied viewings after 3PM only","videoUrl":"https://www.example.com/property/123/videoTour","videoCaption":"Virtual property tour","video2Url":"https://www.example.com/property/123/3dVideoTour","video2Caption":"3d virtual property tour","notes":"Property was on the market previously with another agent but struggled to get much interest","additionalInformation":"Additional information about the property","boardStatus":"FS","boardNotes":"Include 'sold in a week' slip","featuredImageUrl":null,"url":"https://www.example.com/property/15-example-street/OXF200008","urlCaption":"View Property on Website","what3Words":"///limit.broom.flip","groundRent":24,"groundRentComment":"Payable in two bi-annual instalments","groundRentReviewDate":"2021-10-05","groundRentIncrease":24.55,"groundRentType":"confirmed","serviceCharge":24,"serviceChargeComment":"Payable in two bi-annual instalments","serviceChargeReviewDate":"2026-06-28T18:13:38.9063649+00:00","floorLevel":null,"internalFloors":null,"totalFloors":null,"boardUpdated":"2021-07-02","valuation":"2021-04-05","archivedOn":null,"fromArchive":false,"rural":{"tenureId":"LH","buildingsDescription":"2 barns and a stable","landDescription":"400 acres of mixed arable"},"externalArea":{"type":"acres","min":1,"max":2},"internalArea":{"type":"squareFeet","min":1500,"max":2000},"epc":{"created":null,"exempt":false,"eer":45,"eerRating":null,"eerPotential":71,"eerPotentialRating":null,"eir":53,"eirRating":null,"eirPotential":81,"eirPotentialRating":null,"fullDocumentUrl":null,"firstPageDocumentUrl":null,"commercial":{"exempt":true,"epcRating":65,"created":"2021-12-26","fullDocumentUrl":"https://www.example.com/property/123/commercialEpc","_links":null,"_embedded":null}},"rightsRestrictions":null,"floodErosion":null,"accessibility":null,"selling":{"instructed":"2018-11-18","price":250000,"priceTo":null,"matchPriceFrom":240000,"matchPriceTo":260000,"reservationFee":0,"qualifier":"askingPrice","furnishing":["partFurnished"],"status":"underOffer","disposal":"privateTreaty","completed":"2019-08-27","exchanged":"2019-08-15","accountPaid":"2019-08-29","tenure":{"type":"leasehold","expiry":"2019-05-01"},"vendorId":"OXF123001","agency":"ownToSell","agencyId":null,"agreementExpiry":"2019-01-20","fee":{"type":"fixed","amount":2000},"exchangedCompanyFee":2000,"estimatedMonthlyRetailValue":null,"recommendedPrice":550000,"valuationPrice":null,"brochureId":"DOC21000002","publicBrochureUrl":null,"exchangedPrice":null,"exchangedOfficeId":null,"grossYieldPercentage":0,"decoration":null,"sharedOwnership":{"sharedPercentage":55.44,"rent":1250.55,"rentFrequency":"weekly"},"subAgentTerms":{"feeAvailable":true,"type":"fixed","amount":100},"jointAgents":null},"letting":{"instructed":"2018-11-18","availableFrom":"2018-12-26","availableTo":"2019-03-23","agreementSigned":null,"rent":750,"rentFrequency":"monthly","rentIncludes":null,"furnishing":["furnished","partFurnished"],"term":"long","status":"toLet","agentRole":"managed","landlordId":"OXF123001","worksOrderNote":"Please arrange access to property directly with the tenant","minimumTerm":12,"numberOfCheques":2,"propertyManagerId":"JAS","managementCompanyIds":["CMP21000001","OXF21000004"],"brochureId":"DOC21000001","publicBrochureUrl":null,"managementFee":{"type":"percentage","amount":7.5},"lettingFee":{"firstReduction":{"type":"fixed","reducingTo":140,"reducingAfterMonths":6},"secondReduction":{"type":"fixed","reducingTo":125,"reducingAfterMonths":12},"type":"fixed","amount":155},"qualifier":"askingRent","utilities":{"hasGas":true,"gasCompanyId":"OXF21000001","gasMeterPoint":"123","electricityCompanyId":"OXF21000003","electricityMeterPoint":"789","waterCompanyId":"OXF21000002","waterMeterPoint":"456","telephoneCompanyId":"OXF21000006","internetCompanyId":"OXF21000004","cableTvCompanyId":"OXF21000005"},"deposit":{"type":"months","amount":1},"rentInsurance":null,"licencing":{"licenceRequired":true,"licenceTypeRequired":"additional","licenceType":"additional","referenceNumber":"A001","households":1,"occupants":2,"aboveCommercialPremises":false,"licenceComplianceStatus":"compliant","section257Property":"yes","article4":"yes","hasRestrictions":true,"restrictionDetails":null,"currentTenancyHouseholds":1,"application":{"status":"landlordApplying","referenceNumber":"0001","date":"2022-12-26","granted":"2023-01-15","expiry":"2023-07-15"},"_links":null,"_embedded":null},"subAgentTerms":{"feeAvailable":true,"type":"percent","amount":10},"withdrawalReason":{"typeId":"ER","reason":"Example Reason","withdrawalDate":"2024-08-30","instructedAgentId":"OHO14000061"},"preferredSuppliers":[{"id":"OXF19000001","name":"British Gas"},{"id":"OXF19000002","name":"British Energy"}],"jointAgents":null},"commercial":null,"regional":null,"type":["house"],"style":["detached"],"situation":["garden","land","patio"],"parking":["secure","doubleGarage"],"age":["period"],"locality":["rural","village"],"specialFeatures":null,"unmappedAttributes":null,"availableServicesIds":["MW","GA","FB"],"rooms":[{"dimensionsAlt":null,"name":"Kitchen","dimensions":"4.5m x 5.2m","description":"The breakfast kitchen, with utility, comprises a matching range of wall and base units with ceramic hob and eye level double oven. A side door leads to the front courtyard area."},{"dimensionsAlt":null,"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a Clearview stove, provides an ideal space to relax and unwind, whilst enjoying views over the Golf Course."},{"dimensionsAlt":null,"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room is the perfect space to entertain and provides access to the useful study."}],"roomDetailsApproved":false,"officeIds":["OXF","SOL"],"lostInstructionDate":"2021-02-23","lostInstructionNote":"Other agent charged £300 less","developmentSiteType":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"keywords":null,"completionStatus":"offPlan","paymentMethod":"cash","activeLanguages":null,"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/properties/OXF200008"},"images":{"href":"/propertyImages/?propertyId=OXF200008"},"documents":{"href":"/documents/?associatedType=property&associatedId=OXF200008"},"offers":{"href":"/offers/?propertyId=OXF200008"},"appointments":{"href":"/appointments/?propertyId=OXF200008"},"negotiator":{"href":"/negotiators/JAS"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"department":{"href":"/departments/G"},"vendor":{"href":"/vendors/OXF123001"},"landlord":{"href":"/landlords/OXF123001"},"area":{"href":"/areas/BRM"},"sellingBrochure":{"href":"/documents/DOC21000002"},"lettingBrochure":{"href":"/documents/DOC21000001"},"boardStatus":{"href":"/configuration/boardStatuses/FS"},"ruralTenure":{"href":"/configuration/ruralTenancyTypes/LH"},"portalType":{"href":"/configuration/portalTypes/?id=LM&id=MT"},"gasCompany":{"href":"/companies/OXF21000001"},"electricityCompany":{"href":"/companies/OXF21000003"},"waterCompany":{"href":"/companies/OXF21000002"},"internetCompany":{"href":"/companies/OXF21000004"},"telephoneCompany":{"href":"/companies/OXF21000006"},"cableTvCompany":{"href":"/companies/OXF21000005"},"propertyManager":{"href":"/negotiators/JAS"},"managementCompanies":{"href":"/companies/?id=CMP21000001&id=OXF21000004"},"availableServices":{"href":"/configuration/propertyServiceTypes/?id=MW&id=GA&id=FB"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Creates a new property","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create a new property","required":["marketingMode","departmentId","address","negotiatorId","officeIds"],"type":"object","properties":{"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"marketingMode":{"description":"The marketing mode of the property (selling/letting/sellingAndLetting)","type":"string"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model\r\nWhen not supplied this will default to the customers default currency.","type":"string"},"departmentId":{"description":"The unique identifier of the department the property is associated with. The property will only match to applicants with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"specialFeatures":{"description":"The property's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"address":{"description":"Request body used to set the address of a new property","required":["line1"],"type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of a new property's address","required":["latitude","longitude"],"type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please refer to the glossary for support [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information for the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"floorLevel":{"format":"int32","description":"The floor level the property is on. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"epc":{"description":"Request body used to set the EPC statistic of a new property","type":"object","properties":{"created":{"format":"date-time","description":"The created EPC date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Request body used to set the Commercial EPC statistic of a property","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The created EPC date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"rightsRestrictions":{"description":"Request body to set a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Request body to set a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"externalArea":{"description":"Request body to set the plot size of a new property","type":"object","properties":{"type":{"description":"The unit of area (acres/hectares). (This will be converted and returned as acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Request body to set the internal dimensions of a new property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"rural":{"description":"Request body used to set details specific to rural properties","type":"object","properties":{"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"selling":{"description":"Request body used to set details specific to sales marketing on a new property. When creating a new sales property, a vendor record is automatically created. Please refer to the [Platform Glossary](http://foundations.link/glossary#vendor) for full details","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The marketing price of the property","type":"integer"},"priceTo":{"format":"int32","description":"The maximum marketing price of the property","type":"integer"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Request body used to set the tenure of a new property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"sellingAgency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when SellingAgency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Request body used to create the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}}}},"letting":{"description":"Request body used to set details specific to lettings marketing on a new property","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"Sets the minimum number of months the property can be let out for","type":"integer"},"managementFee":{"description":"Request body used to create the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Request body used to create the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}}}},"regional":{"description":"Request body used to set region specific property details. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"irl":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"The base model containing data for reading, creating or updating a room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"}}}},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date-time","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"keywords":{"description":"The keywords associated with the property.","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the property","type":"object","additionalProperties":{}}},"example":{"lastCall":"2021-04-01","nextCall":"2021-06-01","marketingMode":"sellingAndLetting","currency":null,"departmentId":"G","strapline":null,"description":"We are delighted to offer for sale this EXTENDED THREE BEDROOMED SEMI DETACHED PROPERTY situated in a much sought after residential location of Greasby, having the benefits of two separate entertaining rooms, morning room, extended kitchen. To the first floor there are three bedrooms, spacious family bathroom, gas central heating gardens front and rear and off road parking.","summary":null,"alternateId":"10001","specialFeatures":null,"address":{"buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":52.4158586,"longitude":1.7773383}},"bedrooms":4,"bedroomsMax":5,"numberOfUnits":0,"receptions":1,"receptionsMax":2,"bathrooms":2,"bathroomsMax":3,"parkingSpaces":0,"councilTax":"A","internetAdvertising":true,"viewingArrangements":"Accompanied viewings after 3PM only","videoUrl":"https://www.example.com/property/123/videoTour","videoCaption":"Virtual property tour","video2Url":"https://www.example.com/property/123/3dVideoTour","video2Caption":"3d virtual property tour","notes":"Property was on the market previously with another agent but struggled to get much interest","additionalInformation":"Additional information of the property","longDescription":"The ground floor accommodation comprises of a spacious reception hall with a wet bar, a grand drawing room, master bedroom suite and a further bedroom suite. The lower floor comprises of an eat in kitchen leading to converted vaults which could be used as staff accommodation or a study. There is also separate dining room and a further bedroom suite.","floorLevel":null,"internalFloors":null,"totalFloors":null,"boardStatus":"FS","boardNotes":"Include 'sold in a week' slip","boardUpdated":"2021-07-02","valuation":"2021-04-05","epc":{"created":"2021-04-05","exempt":false,"eer":45,"eerPotential":71,"eir":53,"eirPotential":81,"fullDocumentUrl":null,"firstPageDocumentUrl":null,"commercial":{"exempt":false,"epcRating":45,"created":"2021-04-05","fullDocumentUrl":"https://www.example.com/property/123/epc"}},"rightsRestrictions":{"listed":true,"restrictions":true,"easementsOrServitudesOrWayleaves":true,"rightOfWay":true},"floodErosion":{"floodedInLastFiveYears":false,"floodDefences":true,"floodSources":["lake","river"],"lastFlood":"2021-04-12"},"accessibility":["levelAccess","liftAccess"],"externalArea":{"type":"acres","min":1,"max":2},"internalArea":{"type":"squareFeet","min":1500,"max":2000},"rural":{"buildingsDescription":"2 barns and a stable","landDescription":"400 acres of mixed arable"},"selling":{"instructed":"2018-11-18","price":250000,"priceTo":null,"matchPriceFrom":0,"matchPriceTo":0,"reservationFee":0,"qualifier":"askingPrice","status":"underOffer","disposal":"privateTreaty","completed":"2019-08-27","exchanged":"2019-08-15","accountPaid":"2019-08-29","tenure":{"type":"leasehold","expiry":"2019-05-01"},"sellingAgency":"ownToSell","agencyId":null,"agreementExpiry":"2019-01-20","fee":{"type":"percentage","amount":2.5},"recommendedPrice":250000,"valuationPrice":null,"decoration":["good","veryGood"],"sharedOwnership":{"sharedPercentage":55.44,"rent":1250.55,"rentFrequency":"weekly"}},"letting":{"instructed":"2018-11-18","availableFrom":"2018-12-26","availableTo":"2019-03-23","agreementSigned":null,"rent":750,"rentFrequency":"monthly","rentIncludes":null,"furnishing":["furnished","partFurnished"],"agentRole":"managed","term":"long","status":"toLet","landlordId":"LLD210001","worksOrderNote":"Please arrange access to property directly with the tenant","minimumTerm":12,"managementFee":{"type":"fixed","amount":150},"lettingFee":{"firstReduction":{"type":"percentage","reducingTo":1.2,"reducingAfterMonths":6},"secondReduction":{"type":"percentage","reducingTo":1.1,"reducingAfterMonths":12},"type":"percentage","amount":1.3},"qualifier":"askingRent","utilities":{"hasGas":true,"gasCompanyId":"OXF21000001","gasMeterPoint":"123","electricityCompanyId":"OXF21000003","electricityMeterPoint":"789","waterCompanyId":"OXF21000002","waterMeterPoint":"456","telephoneCompanyId":"OXF21000006","internetCompanyId":"OXF21000004","cableTvCompanyId":"OXF21000005"},"deposit":{"type":"months","amount":1}},"regional":null,"type":["house"],"style":["detached"],"situation":["garden","land","patio"],"parking":["secure","doubleGarage"],"age":["period"],"locality":["rural","village"],"rooms":[{"name":"Kitchen","dimensions":"4.5m x 5.2m","description":"The breakfast kitchen, with utility, comprises a matching range of wall and base units with ceramic hob and eye level double oven. A side door leads to the front courtyard area."},{"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a Clearview stove, provides an ideal space to relax and unwind, whilst enjoying views over the Golf Course."},{"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room is the perfect space to entertain and provides access to the useful study."}],"roomDetailsApproved":false,"negotiatorId":"JAS","officeIds":["OXF","SOL"],"areaId":"BRM","url":"https://www.example.com/property/15-example-street/OXF200008","urlCaption":"View Property on Website","groundRent":24,"groundRentComment":"Payable in two bi-annual instalments","groundRentReviewDate":"2021-10-05","groundRentIncrease":42.66,"groundRentType":"confirmed","serviceCharge":24,"serviceChargeComment":"Payable in two bi-annual instalments","serviceChargeReviewDate":"2026-09-18T18:13:39.0463907+00:00","keywords":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/properties/{id}":{"get":{"tags":["Properties"],"summary":"Gets a single property by its' unique identifier","operationId":"GetPropertyById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the property returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","area","certificates","department","documents","images","keys","landlord","multilingual","negotiator","offers","offices","tenancies","vendor"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a property. Properties can be grouped into developments in the source data, functionality that is typically used by New Homes departments.\r\nThe _links collection will expose specific links to allow developers to navigate through a particular development, should a property be configured in this manner. Refer to commentary on the _links collection for more details","type":"object","properties":{"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the property","type":"string"},"created":{"format":"date-time","description":"The date and time when the property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"marketingMode":{"description":"The marketing mode of the property (selling/letting/sellingAndLetting)","type":"string"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"localTimeZone":{"description":"The local timezone for the address, based on the Geolocation coordinates","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"listingAdvertisementNumber":{"description":"The listing advertisement number of the property","type":"string"},"localAuthorityCompanyId":{"description":"The property's local authority","type":"string"},"localAuthorityCompanyName":{"description":"The name of the property's local authority","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"departmentId":{"description":"The unique identifier of the department the property is associated with. The property will only match to applicants with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"clientAccountsAssistantId":{"description":"The unique identifier of the client accounts assistant of the property","type":"string"},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property or properties. This is typically used when marketing development sites and would be set on the master record. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"disabledPortalIds":{"description":"A collection of identifiers of portals that the property should not be displayed on","type":"array","items":{"type":"string"}},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"isExternal":{"description":"A flag denoting whether or not the property has been instructed by another estate agent","type":"boolean"},"depositSchemeAccepted":{"description":"A flag denoting whether or not the property accepts deposit schemes","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information about the property.","type":"string"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"featuredImageUrl":{"format":"uri","description":"The properties featured image url","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"what3Words":{"description":"The What3Words identifier for the property.","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14"},"floorLevel":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"archivedOn":{"format":"date-time","description":"The date and time the property was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the property is archived","type":"boolean"},"rural":{"description":"Details specific to rural properties","type":"object","properties":{"tenureId":{"description":"Details of the rural tenure associated with the property.","type":"string"},"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"externalArea":{"description":"Representation of the plot size of a property","type":"object","properties":{"type":{"description":"The unit of area (acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Representation of the internal dimensions of a property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"epc":{"description":"Representation of EPC statistics","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerRating":{"description":"The current energy efficiency letter rating (A-G). This is generated from the `eer` value\r\nfor systems that do not have an explicit EPC Rating component","type":"string"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eerPotentialRating":{"description":"The potential energy efficiency letter rating (A-G). This is generated from the `eerPotential` value","type":"string"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirRating":{"description":"The current environment impact letter rating (A-G). This is generated from the `eir` value","type":"string"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"eirPotentialRating":{"description":"The potential environment impact letter rating (A-G). This is generated from the `eirPotential` value","type":"string"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Representation of a commercial EPC statistics","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"rightsRestrictions":{"description":"Details specific to a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Details specific to a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"selling":{"description":"Representation of property details specific to sales marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"double","description":"The marketing price of the property","type":"number"},"priceTo":{"format":"double","description":"The maximum price of a property on the development plot","type":"number"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Representation of the tenure of a property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"vendorId":{"description":"The unique identifier of the vendor selling the property","type":"string"},"agency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when Agency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"exchangedCompanyFee":{"format":"double","description":"The actual fee amount to be collected by the agent - often based on the exchange price of the property","type":"number"},"estimatedMonthlyRetailValue":{"format":"double","description":"The estimated monthly retail amount","type":"number"},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"exchangedPrice":{"format":"int32","description":"The price the property exchanged/sold for","type":"integer"},"exchangedOfficeId":{"description":"The unique identifier of the office that sold the property","type":"string"},"grossYieldPercentage":{"format":"double","description":"The gross yield amount","type":"number"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"letting":{"description":"Representation of property details specific to lettings marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"The minimum number of months the property can be let out for","type":"integer"},"numberOfCheques":{"format":"int32","description":"The number of cheques payment required to rent the property","type":"integer"},"propertyManagerId":{"description":"The unique identifier of the negotiator that manages the property","type":"string"},"managementCompanyIds":{"description":"The unique identifiers of the management companies associated to the property","type":"array","items":{"type":"string"}},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"managementFee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Representation of the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Representation of property details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property licencing","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date","description":"The date the licence was applied for","type":"string","example":"2019-08-14"},"granted":{"format":"date","description":"The date the licence application was granted","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The date the licence will expire","type":"string","example":"2019-08-14"}}}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"withdrawalReason":{"description":"Representation of withdrawal details specific to lettings marketing","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}},"preferredSuppliers":{"description":"List of preferred suppliers of the property","type":"array","items":{"description":"Representation of the preferred supplier details to lettings marketing.","type":"object","properties":{"id":{"description":"Unique identifier of the supplier.","type":"string"},"name":{"description":"Name of the supplier.","type":"string"}}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"commercial":{"description":"An properties commercial details","type":"object","properties":{"useClass":{"description":"The commercial use attributes (eg a1, a2, b1), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Any specific details relating to the marketing of a property in Guernsey","type":"object","properties":{"market":{"description":"Attributes describing which markets the property is available in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"irl":{"description":"Any specific details relating to the marketing of a property in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Any specific details relating to energy performance ratings for properties marketed in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The attributes describing the property's special features (eg swimmingPool, tennisCourt), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedAttributes":{"description":"The attributes associated to the property which are not currently mapped. These are defined the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped attribute type","type":"object","properties":{"type":{"description":"The type of unmapped attribute (style/type/situation/parking/age/locality/special)","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"availableServicesIds":{"description":"Identifiers of any services connected at the property","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"lostInstructionDate":{"format":"date-time","description":"The date that this property became a lost instruction","type":"string","example":"2019-08-14T12:30:02Z"},"lostInstructionNote":{"description":"The notes regarding the lost instruction","type":"string"},"developmentSiteType":{"description":"The type of development","type":"string"},"metadata":{"description":"App specific metadata that has been set against the property","type":"object","additionalProperties":{}},"keywords":{"description":"The keywords associated with property","type":"array","items":{"type":"string"}},"completionStatus":{"description":"The completion status of the property (notSet/completed/offPlan/completedPrimary/offPlanPrimary)","type":"string"},"paymentMethod":{"description":"The payment method of the property (notSet/cash/installments/cashOrInstallments)","type":"string"},"activeLanguages":{"description":"The languages currently set for the property.","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the property. Used for managing update concurrency","type":"string","readOnly":true},"_links":{"description":"Collection containing relative URLs to data associated with the property.\r\nIn the case of a development - where a property is grouped with, or associated to another property by way of a parent/child relationship,\r\nthe collection will contain a _master_ or _subPlot_ link depending on the property type. Where the property is the master record in a development (the parent),\r\na _subPlots_ link will be included in the collection giving you access to all the plots (the children) within the development. Where the property is a sub plot that forms part of a \r\ndevelopment, a _master_ link will be included in the collection giving you access to the master record.","type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true}}},"examples":{"application/json":{"id":"OXF200008","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","lastCall":null,"nextCall":null,"marketingMode":"sellingAndLetting","currency":"GBP","alternateId":"10001","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","localTimeZone":null,"geolocation":{"latitude":52.4158586,"longitude":1.7773383}},"areaId":"BRM","strapline":null,"description":"We are delighted to offer for sale this EXTENDED THREE BEDROOMED SEMI DETACHED PROPERTY situated in a much sought after residential location of Greasby, having the benefits of two separate entertaining rooms, morning room, extended kitchen. To the first floor there are three bedrooms, spacious family bathroom, gas central heating gardens front and rear and off road parking.","longDescription":"The ground floor accommodation comprises of a spacious reception hall with a wet bar, a grand drawing room, master bedroom suite and a further bedroom suite. The lower floor comprises of an eat in kitchen leading to converted vaults which could be used as staff accommodation or a study. There is also separate dining room and a further bedroom suite.","listingAdvertisementNumber":"RERA10000105","localAuthorityCompanyId":null,"localAuthorityCompanyName":null,"summary":null,"departmentId":"G","negotiatorId":"JAS","clientAccountsAssistantId":null,"bedrooms":4,"bedroomsMax":6,"receptions":1,"receptionsMax":2,"bathrooms":2,"bathroomsMax":3,"numberOfUnits":null,"parkingSpaces":0,"councilTax":"A","disabledPortalIds":["LM","MT"],"internetAdvertising":true,"isExternal":false,"depositSchemeAccepted":false,"viewingArrangements":"Accompanied viewings after 3PM only","videoUrl":"https://www.example.com/property/123/videoTour","videoCaption":"Virtual property tour","video2Url":"https://www.example.com/property/123/3dVideoTour","video2Caption":"3d virtual property tour","notes":"Property was on the market previously with another agent but struggled to get much interest","additionalInformation":"Additional information about the property","boardStatus":"FS","boardNotes":"Include 'sold in a week' slip","featuredImageUrl":null,"url":"https://www.example.com/property/15-example-street/OXF200008","urlCaption":"View Property on Website","what3Words":"///limit.broom.flip","groundRent":24,"groundRentComment":"Payable in two bi-annual instalments","groundRentReviewDate":"2021-10-05","groundRentIncrease":24.55,"groundRentType":"confirmed","serviceCharge":24,"serviceChargeComment":"Payable in two bi-annual instalments","serviceChargeReviewDate":"2026-06-28T18:13:39.0529782+00:00","floorLevel":null,"internalFloors":null,"totalFloors":null,"boardUpdated":"2021-07-02","valuation":"2021-04-05","archivedOn":null,"fromArchive":false,"rural":{"tenureId":"LH","buildingsDescription":"2 barns and a stable","landDescription":"400 acres of mixed arable"},"externalArea":{"type":"acres","min":1,"max":2},"internalArea":{"type":"squareFeet","min":1500,"max":2000},"epc":{"created":null,"exempt":false,"eer":45,"eerRating":null,"eerPotential":71,"eerPotentialRating":null,"eir":53,"eirRating":null,"eirPotential":81,"eirPotentialRating":null,"fullDocumentUrl":null,"firstPageDocumentUrl":null,"commercial":{"exempt":true,"epcRating":65,"created":"2021-12-26","fullDocumentUrl":"https://www.example.com/property/123/commercialEpc","_links":null,"_embedded":null}},"rightsRestrictions":null,"floodErosion":null,"accessibility":null,"selling":{"instructed":"2018-11-18","price":250000,"priceTo":null,"matchPriceFrom":240000,"matchPriceTo":260000,"reservationFee":0,"qualifier":"askingPrice","furnishing":["partFurnished"],"status":"underOffer","disposal":"privateTreaty","completed":"2019-08-27","exchanged":"2019-08-15","accountPaid":"2019-08-29","tenure":{"type":"leasehold","expiry":"2019-05-01"},"vendorId":"OXF123001","agency":"ownToSell","agencyId":null,"agreementExpiry":"2019-01-20","fee":{"type":"fixed","amount":2000},"exchangedCompanyFee":2000,"estimatedMonthlyRetailValue":null,"recommendedPrice":550000,"valuationPrice":null,"brochureId":"DOC21000002","publicBrochureUrl":null,"exchangedPrice":null,"exchangedOfficeId":null,"grossYieldPercentage":0,"decoration":null,"sharedOwnership":{"sharedPercentage":55.44,"rent":1250.55,"rentFrequency":"weekly"},"subAgentTerms":{"feeAvailable":true,"type":"fixed","amount":100},"jointAgents":null},"letting":{"instructed":"2018-11-18","availableFrom":"2018-12-26","availableTo":"2019-03-23","agreementSigned":null,"rent":750,"rentFrequency":"monthly","rentIncludes":null,"furnishing":["furnished","partFurnished"],"term":"long","status":"toLet","agentRole":"managed","landlordId":"OXF123001","worksOrderNote":"Please arrange access to property directly with the tenant","minimumTerm":12,"numberOfCheques":2,"propertyManagerId":"JAS","managementCompanyIds":["CMP21000001","OXF21000004"],"brochureId":"DOC21000001","publicBrochureUrl":null,"managementFee":{"type":"percentage","amount":7.5},"lettingFee":{"firstReduction":{"type":"fixed","reducingTo":140,"reducingAfterMonths":6},"secondReduction":{"type":"fixed","reducingTo":125,"reducingAfterMonths":12},"type":"fixed","amount":155},"qualifier":"askingRent","utilities":{"hasGas":true,"gasCompanyId":"OXF21000001","gasMeterPoint":"123","electricityCompanyId":"OXF21000003","electricityMeterPoint":"789","waterCompanyId":"OXF21000002","waterMeterPoint":"456","telephoneCompanyId":"OXF21000006","internetCompanyId":"OXF21000004","cableTvCompanyId":"OXF21000005"},"deposit":{"type":"months","amount":1},"rentInsurance":null,"licencing":{"licenceRequired":true,"licenceTypeRequired":"additional","licenceType":"additional","referenceNumber":"A001","households":1,"occupants":2,"aboveCommercialPremises":false,"licenceComplianceStatus":"compliant","section257Property":"yes","article4":"yes","hasRestrictions":true,"restrictionDetails":null,"currentTenancyHouseholds":1,"application":{"status":"landlordApplying","referenceNumber":"0001","date":"2022-12-26","granted":"2023-01-15","expiry":"2023-07-15"},"_links":null,"_embedded":null},"subAgentTerms":{"feeAvailable":true,"type":"percent","amount":10},"withdrawalReason":{"typeId":"ER","reason":"Example Reason","withdrawalDate":"2024-08-30","instructedAgentId":"OHO14000061"},"preferredSuppliers":[{"id":"OXF19000001","name":"British Gas"},{"id":"OXF19000002","name":"British Energy"}],"jointAgents":null},"commercial":null,"regional":null,"type":["house"],"style":["detached"],"situation":["garden","land","patio"],"parking":["secure","doubleGarage"],"age":["period"],"locality":["rural","village"],"specialFeatures":null,"unmappedAttributes":null,"availableServicesIds":["MW","GA","FB"],"rooms":[{"dimensionsAlt":null,"name":"Kitchen","dimensions":"4.5m x 5.2m","description":"The breakfast kitchen, with utility, comprises a matching range of wall and base units with ceramic hob and eye level double oven. A side door leads to the front courtyard area."},{"dimensionsAlt":null,"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a Clearview stove, provides an ideal space to relax and unwind, whilst enjoying views over the Golf Course."},{"dimensionsAlt":null,"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room is the perfect space to entertain and provides access to the useful study."}],"roomDetailsApproved":false,"officeIds":["OXF","SOL"],"lostInstructionDate":"2021-02-23","lostInstructionNote":"Other agent charged £300 less","developmentSiteType":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"keywords":null,"completionStatus":"offPlan","paymentMethod":"cash","activeLanguages":null,"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/properties/OXF200008"},"images":{"href":"/propertyImages/?propertyId=OXF200008"},"documents":{"href":"/documents/?associatedType=property&associatedId=OXF200008"},"offers":{"href":"/offers/?propertyId=OXF200008"},"appointments":{"href":"/appointments/?propertyId=OXF200008"},"negotiator":{"href":"/negotiators/JAS"},"offices":{"href":"/offices/?id=OXF&id=SOL"},"department":{"href":"/departments/G"},"vendor":{"href":"/vendors/OXF123001"},"landlord":{"href":"/landlords/OXF123001"},"area":{"href":"/areas/BRM"},"sellingBrochure":{"href":"/documents/DOC21000002"},"lettingBrochure":{"href":"/documents/DOC21000001"},"boardStatus":{"href":"/configuration/boardStatuses/FS"},"ruralTenure":{"href":"/configuration/ruralTenancyTypes/LH"},"portalType":{"href":"/configuration/portalTypes/?id=LM&id=MT"},"gasCompany":{"href":"/companies/OXF21000001"},"electricityCompany":{"href":"/companies/OXF21000003"},"waterCompany":{"href":"/companies/OXF21000002"},"internetCompany":{"href":"/companies/OXF21000004"},"telephoneCompany":{"href":"/companies/OXF21000006"},"cableTvCompany":{"href":"/companies/OXF21000005"},"propertyManager":{"href":"/negotiators/JAS"},"managementCompanies":{"href":"/companies/?id=CMP21000001&id=OXF21000004"},"availableServices":{"href":"/configuration/propertyServiceTypes/?id=MW&id=GA&id=FB"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates a property by unique identifier.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier for the property to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the property.","schema":{"description":"Request body used to update an existing property","type":"object","properties":{"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"specialFeatures":{"description":"The property's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"address":{"description":"Request body used to update the address of an existing property","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to update the geolocation coordinates of an existing property's address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please refer to the glossary for support [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information for the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"floorLevel":{"format":"int32","description":"The floor level the property is on. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"epc":{"description":"Request body used to update the EPC statistics of an existing property","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"rightsRestrictions":{"description":"Request body to set a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Request body to set a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"externalArea":{"description":"Request body to update the plot size of an existing property","type":"object","properties":{"type":{"description":"The unit of area (acres/hectares). (This will be converted and returned as acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Request body to update the internal dimensions of an existing property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"selling":{"description":"Request body used to update details specific to sales marketing on an existing property","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The marketing price of the property","type":"integer"},"priceTo":{"format":"int32","description":"The maximum marketing price of the property","type":"integer"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Request body used to set the tenure of an existing property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"sellingAgency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when SellingAgency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Request body used to update the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}}}},"letting":{"description":"Request body used to update details specific to lettings marketing on an existing property","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"Sets the minimum number of months the property can be let out for","type":"integer"},"managementFee":{"description":"Request body used to update the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Request body used to update the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetry amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Request body used to update details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property ;icencing","type":"object","properties":{"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date-time","description":"The date the licence was applied for","type":"string","example":"2019-08-14T12:30:02Z"},"granted":{"format":"date-time","description":"The date the licence application was granted","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The date the licence will expire","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"withdrawalReason":{"description":"Model for the property withdrawal reason update details","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}}}},"regional":{"description":"Request body used to set region specific property details. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"irl":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"rural":{"description":"Request body used to set details specific to rural properties.","type":"object","properties":{"buildingsDescription":{"description":"Details of the building associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"The base model containing data for reading, creating or updating a room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"}}}},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14"},"availableServicesIds":{"description":"Identifiers of any services connected at the property","type":"array","items":{"type":"string"}},"keywords":{"description":"The keywords associated with the property.","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the property","type":"object","additionalProperties":{}}},"example":{"lastCall":"2021-04-01","nextCall":"2021-06-01","roomDetailsApproved":null,"strapline":null,"description":"We are delighted to offer for sale this EXTENDED THREE BEDROOMED SEMI DETACHED PROPERTY situated in a much sought after residential location of Greasby, having the benefits of two separate entertaining rooms, morning room, extended kitchen. To the first floor there are three bedrooms, spacious family bathroom, gas central heating gardens front and rear and off road parking.","summary":null,"alternateId":"10002","specialFeatures":null,"address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":52.4158586,"longitude":1.7773383}},"bedrooms":4,"bedroomsMax":5,"numberOfUnits":0,"receptions":1,"receptionsMax":2,"bathrooms":2,"bathroomsMax":3,"parkingSpaces":0,"councilTax":"A","internetAdvertising":true,"viewingArrangements":"Accompanied viewings after 3PM only","videoUrl":"https://www.example.com/property/123/videoTour","videoCaption":"Virtual property tour","video2Url":"https://www.example.com/property/123/3dVideoTour","video2Caption":"3d virtual property tour","notes":"Property was on the market previously with another agent but struggled to get much interest","additionalInformation":"Additional information of the property","longDescription":"The ground floor accommodation comprises of a spacious reception hall with a wet bar, a grand drawing room, master bedroom suite and a further bedroom suite. The lower floor comprises of an eat in kitchen leading to converted vaults which could be used as staff accommodation or a study. There is also separate dining room and a further bedroom suite.","floorLevel":null,"internalFloors":null,"totalFloors":null,"boardStatus":"FS","boardNotes":"Include 'sold in a week' slip","boardUpdated":"2021-07-02","valuation":"2021-04-05","epc":{"created":"2021-04-05","exempt":false,"eer":45,"eerPotential":71,"eir":53,"eirPotential":81,"fullDocumentUrl":null,"firstPageDocumentUrl":null,"commercial":{"created":"2021-04-05","exempt":false,"epcRating":45,"fullDocumentUrl":"https://www.example.com/property/123/epc"}},"rightsRestrictions":{"listed":true,"restrictions":true,"easementsOrServitudesOrWayleaves":true,"rightOfWay":true},"floodErosion":{"floodedInLastFiveYears":false,"floodDefences":true,"floodSources":["lake","river"],"lastFlood":"2021-04-12"},"accessibility":["levelAccess","liftAccess"],"externalArea":{"type":"acres","min":1,"max":2},"internalArea":{"type":"squareFeet","min":1500,"max":2000},"selling":{"instructed":"2018-11-18","price":250000,"priceTo":null,"matchPriceFrom":240000,"matchPriceTo":260000,"reservationFee":0,"qualifier":"askingPrice","status":"underOffer","disposal":"privateTreaty","completed":"2019-08-27","exchanged":"2019-08-15","accountPaid":"2019-08-29","tenure":{"type":"leasehold","expiry":"2019-05-01"},"sellingAgency":"ownToSell","agencyId":null,"agreementExpiry":"2019-01-20","fee":{"type":"fixed","amount":1900},"recommendedPrice":450000,"valuationPrice":null,"brochureId":null,"decoration":["good","veryGood"],"sharedOwnership":{"sharedPercentage":45.55,"rent":1350.25,"rentFrequency":"fourWeekly"}},"letting":{"instructed":"2018-11-18","availableFrom":"2018-12-26","availableTo":"2019-03-23","agreementSigned":"2019-03-24","rent":750,"rentFrequency":"monthly","rentIncludes":null,"furnishing":["furnished","partFurnished"],"term":"long","status":"toLet","agentRole":"managed","landlordId":"LLD210001","brochureId":null,"worksOrderNote":"Please arrange access to property directly with the tenant","minimumTerm":12,"managementFee":{"type":"percentage","amount":11.8},"lettingFee":{"firstReduction":{"type":"fixed","reducingTo":175,"reducingAfterMonths":6},"secondReduction":{"type":"fixed","reducingTo":160,"reducingAfterMonths":12},"type":"fixed","amount":190},"qualifier":"askingRent","utilities":{"hasGas":true,"gasCompanyId":"OXF21000007","gasMeterPoint":"312123","electricityCompanyId":"OXF21000009","electricityMeterPoint":"123876","waterCompanyId":"OXF21000008","waterMeterPoint":"34666","telephoneCompanyId":"OXF21000012","internetCompanyId":"OXF21000010","cableTvCompanyId":"OXF21000011"},"deposit":{"type":"weeks","amount":4},"rentInsurance":null,"licencing":{"licenceRequired":true,"licenceTypeRequired":"additional","licenceType":"additional","referenceNumber":"A001","households":1,"occupants":2,"aboveCommercialPremises":false,"licenceComplianceStatus":"compliant","section257Property":"yes","article4":"no","hasRestrictions":true,"restrictionDetails":"Example restriction details","currentTenancyHouseholds":1,"application":{"status":"landlordApplying","referenceNumber":"0001","date":"2022-12-26","granted":"2023-01-15","expiry":"2023-07-15"}},"withdrawalReason":{"typeId":"Reason Type Id","reason":"Test Reason","withdrawalDate":"2021-04-12","instructedAgentId":null}},"regional":null,"rural":{"buildingsDescription":"2 barns and a stable","landDescription":"400 acres of mixed arable"},"type":["house"],"style":["detached"],"situation":["garden","land","patio"],"parking":["secure","doubleGarage"],"age":["period"],"locality":["rural","village"],"rooms":null,"negotiatorId":"JAS","officeIds":["OXF","SOL"],"areaId":"BRM","url":"https://www.example.com/property/15-example-street/OXF200008","urlCaption":"View Property on Website","groundRent":24,"groundRentComment":"Payable in two bi-annual instalments","groundRentReviewDate":"2021-11-12","groundRentIncrease":35.25,"groundRentType":"confirmed","serviceCharge":24,"serviceChargeComment":"Payable in two bi-annual instalments","serviceChargeReviewDate":"2026-12-18T18:13:39.2059492+00:00","availableServicesIds":["MW","GA","FB"],"keywords":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/properties/{id}/certificates":{"get":{"tags":["Properties"],"summary":"Gets a collection of certificates for a specific property","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of certificates to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"category","description":"Only return certificates where the `category` field matches one or more values provided ","type":"array","items":{"enum":["safetyCertificate","insurancePolicy","warranty"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a cerificate","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The certificate's category (safetyCertificate/insurancePolicy/warranty)","type":"string"},"typeId":{"description":"The certificate's type","type":"string"},"start":{"format":"date-time","description":"The certificate's start date","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The certificate's expiry date","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"companyId":{"description":"The unique identifier of the company","type":"string"},"statusId":{"description":"The unique identifier of the certificates status","type":"string"},"notes":{"description":"Any general notes regarding the certificate","type":"string"},"referenceNumber":{"description":"The certificate's reference number","type":"string"},"responsibleParty":{"description":"The party responsible for the certificate, as defined in property configuration (agent/landlord/notRequired/notSet)","type":"string"},"_eTag":{"description":"The ETag for the current version of the certificate. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"CRT21000001","created":"2021-01-01T13:30:00Z","modified":null,"category":"safetyCertificate","typeId":"GS","start":"2021-01-01","expiry":"2022-01-01","propertyId":"PRP210001","companyId":"CMP210001","statusId":null,"notes":"Some notes about the certificate","referenceNumber":"123456789","responsibleParty":null,"_eTag":null,"_links":{"self":{"href":"/properties/PRP210001/certificates/CRT21000001"},"property":{"href":"/properties/PRP210001"},"documents":{"href":"/documents?associatedType=certificate&associatedId=CRT21000001"},"company":{"href":"/companies/CMP210001"},"type":{"href":"/configuration/certificateTypes/GS"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/PRP210001/certificates/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/PRP210001/certificates/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/PRP210001/certificates/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/PRP210001/certificates/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Creates a new certificate.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to create the certificate.","schema":{"description":"Request body used to create a new certificate.","type":"object","properties":{"category":{"description":"The certificate's category (safetyCertificate/insurancePolicy/warranty).","type":"string"},"typeId":{"description":"The unique identifier of the certificate's type.","type":"string"},"start":{"format":"date","description":"The certificate's start date.","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The certificate's expiry date.","type":"string","example":"2019-08-14"},"companyId":{"description":"The unique identifier of the company that supplied, or is supplying, the certificate.","type":"string"},"notes":{"description":"Any general notes regarding the certificate.","type":"string"},"referenceNumber":{"description":"The certificate's reference number.","type":"string"},"statusId":{"description":"The unique identifier of the certificate's status.","type":"string"}},"example":{"category":"safetyCertificate","typeId":"GS","start":"2021-01-01","expiry":"2022-01-01","companyId":"CMP21000001","notes":"Some notes about the certificate","referenceNumber":"123456789","statusId":null}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/certificates/{certificateId}":{"get":{"tags":["Properties"],"summary":"Gets a specific certificate by its' unique identifier for a specific property","operationId":"GetCertificateById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"certificateId","description":"Unique certificate identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a cerificate","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The certificate's category (safetyCertificate/insurancePolicy/warranty)","type":"string"},"typeId":{"description":"The certificate's type","type":"string"},"start":{"format":"date-time","description":"The certificate's start date","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The certificate's expiry date","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"companyId":{"description":"The unique identifier of the company","type":"string"},"statusId":{"description":"The unique identifier of the certificates status","type":"string"},"notes":{"description":"Any general notes regarding the certificate","type":"string"},"referenceNumber":{"description":"The certificate's reference number","type":"string"},"responsibleParty":{"description":"The party responsible for the certificate, as defined in property configuration (agent/landlord/notRequired/notSet)","type":"string"},"_eTag":{"description":"The ETag for the current version of the certificate. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"CRT21000001","created":"2021-01-01T13:30:00Z","modified":null,"category":"safetyCertificate","typeId":"GS","start":"2021-01-01","expiry":"2022-01-01","propertyId":"PRP210001","companyId":"CMP210001","statusId":null,"notes":"Some notes about the certificate","referenceNumber":"123456789","responsibleParty":null,"_eTag":null,"_links":{"self":{"href":"/properties/PRP210001/certificates/CRT21000001"},"property":{"href":"/properties/PRP210001"},"documents":{"href":"/documents?associatedType=certificate&associatedId=CRT21000001"},"company":{"href":"/companies/CMP210001"},"type":{"href":"/configuration/certificateTypes/GS"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates an existing certificate.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"certificateId","description":"The unique identifier for the certificate to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the certificate.","schema":{"description":"Request body used to update an existing certificate.","type":"object","properties":{"start":{"format":"date-time","description":"The certificate's start date.","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The certificate's expiry date.","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the company.","type":"string"},"notes":{"description":"Any general notes regarding the certificate.","type":"string"},"referenceNumber":{"description":"The certificate's reference number.","type":"string"},"statusId":{"description":"The unique identifier of the certificate's status.","type":"string"}},"example":{"start":"2021-01-01","expiry":"2022-01-01","companyId":"CMP21000001","notes":"Some notes about the certificate","referenceNumber":"123456789","statusId":null}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/properties/{id}/certificates/responsibilities":{"get":{"tags":["Properties"],"summary":"Get the defined responsible parties for certificate types of a property","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of certificate responsibilities configured for a property","type":"object","properties":{"id":{"description":"The id of the property to which the configured certificate responsibilities apply","type":"string"},"created":{"format":"date-time","description":"The date and time on which the property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time on which the property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"responsibleParties":{"description":"The configured certificate responsibilities","type":"array","items":{"description":"Record describing the responsible party for a given type of certificate within a property entry","type":"object","properties":{"typeId":{"description":"Identifier for the type of certificate for which the party is responsible","type":"string"},"responsibleParty":{"description":"The party responsible for the specified certificate type (landlord/agent/notRequired/notSet)","type":"string"}}}},"_eTag":{"description":"The ETag for the current version of the property. Used for managing update concurrency","type":"string","readOnly":true}}}}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Update the party responsible for specified types of certificates for a property","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the property to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"A collection describing responsibilities for specified certificate types within the property represented by propertyId.","schema":{"description":"Object containing a collection of certificate type to responsible party mappings","type":"object","properties":{"responsibleParties":{"description":"A collection of certificate type to responsible party mappings","type":"array","items":{"description":"Record describing the responsible party for a given type of certificate within a property entry","type":"object","properties":{"typeId":{"description":"Identifier for the type of certificate for which the party is responsible","type":"string"},"responsibleParty":{"description":"The party responsible for the specified certificate type (landlord/agent/notRequired/notSet)","type":"string"}}}}},"example":{"responsibleParties":[{"typeId":"BI","responsibleParty":"landlord"},{"typeId":"FS","responsibleParty":"agent"},{"typeId":"SI","responsibleParty":"notRequired"},{"typeId":"MW","responsibleParty":"notSet"}]}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}}},"security":[{"Authorization":[]}]}},"/properties/{id}/keys":{"get":{"tags":["Properties"],"summary":"Gets a collection of keys for a specific property","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of keys to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a set of keys","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key","type":"string"},"created":{"format":"date-time","description":"The date and time when the key was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"number":{"description":"The number assigned to the key - key numbers can only be occupied by a single property within an office concurrently","type":"string"},"typeId":{"description":"The unique identifier of the key type","type":"string"},"officeId":{"description":"The unique identifier of the office responsible for the key","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key belongs to","type":"string"},"status":{"description":"The status of the key (checkedIn/checkedOut/noLongerHeld)","type":"string"},"keysInSet":{"description":"A listing of the individual keys included in the set","type":"array","items":{"description":"Representation of an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF2000001","created":"2018-12-12T13:30:00Z","modified":"2019-01-08T13:35:00Z","number":"#11231","typeId":"LE","officeId":"OXF","propertyId":"OXF2012345","status":"checkedIn","keysInSet":[{"name":"Front door key"},{"name":"Porch key"}],"_eTag":null,"_links":{"self":{"href":"/properties/OXF2012345/keys/OXF2000001"},"property":{"href":"/properties/OXF2012345"},"office":{"href":"/offices/OXF"},"type":{"href":"/configuration/keyTypes/LE"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/OXF2012345/keys/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/OXF2012345/keys/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/OXF2012345/keys/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/OXF2012345/keys/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Creates a new set of keys against this property","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The model","schema":{"description":"Request body used to create a new set of keys","type":"object","properties":{"number":{"description":"The number assigned to the key - key numbers can only be occupied by a single property within an office concurrently","type":"string"},"typeId":{"description":"The unique identifier of the key type","type":"string"},"officeId":{"description":"The unique identifier of the office responsible for the key","type":"string"},"keysInSet":{"description":"A listing of the individual keys included in the set","type":"array","items":{"description":"Request body used to create an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}}}},"example":{"number":"#11231","typeId":"LE","officeId":"OXF","keysInSet":[{"name":"Front door key"},{"name":"Porch key"}]}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/keys/{keyId}":{"get":{"tags":["Properties"],"summary":"Gets a specific key set by its' unique identifier for a specific property","operationId":"GetKeyById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"keyId","description":"Unique key set identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a set of keys","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key","type":"string"},"created":{"format":"date-time","description":"The date and time when the key was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"number":{"description":"The number assigned to the key - key numbers can only be occupied by a single property within an office concurrently","type":"string"},"typeId":{"description":"The unique identifier of the key type","type":"string"},"officeId":{"description":"The unique identifier of the office responsible for the key","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key belongs to","type":"string"},"status":{"description":"The status of the key (checkedIn/checkedOut/noLongerHeld)","type":"string"},"keysInSet":{"description":"A listing of the individual keys included in the set","type":"array","items":{"description":"Representation of an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF2000001","created":"2018-12-12T13:30:00Z","modified":"2019-01-08T13:35:00Z","number":"#11231","typeId":"LE","officeId":"OXF","propertyId":"OXF2012345","status":"checkedIn","keysInSet":[{"name":"Front door key"},{"name":"Porch key"}],"_eTag":null,"_links":{"self":{"href":"/properties/OXF2012345/keys/OXF2000001"},"property":{"href":"/properties/OXF2012345"},"office":{"href":"/offices/OXF"},"type":{"href":"/configuration/keyTypes/LE"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/keys/{keyId}/movements":{"get":{"tags":["Properties"],"summary":"Gets a collection of movements (check ins / check outs) for a set of keys","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"keyId","description":"Unique key identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of key movements to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a key movement","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key movement","type":"string"},"created":{"format":"date-time","description":"The date and time when the key movement was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key movement was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"keyId":{"description":"The unique identifier of the key set this movement belongs to","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key set belongs to","type":"string"},"checkOutToId":{"description":"The unique identifier of the contact/negotiator that the key is checked out with","type":"string"},"checkOutToType":{"description":"The type of entity that checked out the key (contact/negotiator)","type":"string"},"checkOutAt":{"format":"date-time","description":"The date and time of when the key set was checked out","type":"string","example":"2019-08-14T12:30:02Z"},"checkOutNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check out","type":"string"},"checkInAt":{"format":"date-time","description":"The date and time of when the key set was checked in","type":"string","example":"2019-08-14T12:30:02Z"},"checkInNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check in","type":"string"},"_eTag":{"description":"The ETag for the current version of the key movement. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF2000200","created":"2018-12-12T13:30:00Z","modified":"2019-01-08T13:35:00Z","keyId":"OXF2000001","propertyId":"OXF200008","checkOutToId":"CMM","checkOutToType":"negotiator","checkOutAt":"2018-12-12T13:30:00Z","checkOutNegotiatorId":"BYZ","checkInAt":"2018-12-12T15:30:00Z","checkInNegotiatorId":"TTT","_eTag":null,"_links":{"self":{"href":"/properties/OXF200008/keys/OXF2000001/movements/OXF2000200"},"key":{"href":"/properties/OXF200008/keys/OXF2000001"},"property":{"href":"/properties/OXF200008"},"checkOutNegotiator":{"href":"/negotiators/BYZ"},"checkInNegotiator":{"href":"/negotiators/TTT"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/OXF200008/keys/OXF2000001/movements/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/OXF200008/keys/OXF2000001/movements/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/OXF200008/keys/OXF2000001/movements/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/OXF200008/keys/OXF2000001/movements/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Creates a new movement for a specific key set - to check out or return the key","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"keyId","description":"Unique key identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The model","schema":{"description":"Request body used to create a new key movement","type":"object","properties":{"checkInRequired":{"description":"Indicates whether the key is expected to be checked back in. Set to true when the key is no longer held (eg. returned to the landlord)","type":"boolean"},"checkOutToId":{"description":"The unique identifier of the contact or negotiator to check out the key with - this person will be recorded as holding the key","type":"string"},"checkOutToType":{"description":"The type of entity that checked out the key (contact/negotiator)","type":"string"},"checkOutNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check out","type":"string"}},"example":{"checkInRequired":true,"checkOutToId":"CMB","checkOutToType":"negotiator","checkOutNegotiatorId":"PLL"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/keys/{keyId}/movements/{movementId}":{"get":{"tags":["Properties"],"summary":"Gets a specific movement by its' unique identifier for a specific key set","operationId":"GetKeyMovementById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"keyId","description":"Unique key set identifier","required":true,"type":"string"},{"in":"path","name":"movementId","description":"Unique key movement identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a key movement","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key movement","type":"string"},"created":{"format":"date-time","description":"The date and time when the key movement was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key movement was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"keyId":{"description":"The unique identifier of the key set this movement belongs to","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key set belongs to","type":"string"},"checkOutToId":{"description":"The unique identifier of the contact/negotiator that the key is checked out with","type":"string"},"checkOutToType":{"description":"The type of entity that checked out the key (contact/negotiator)","type":"string"},"checkOutAt":{"format":"date-time","description":"The date and time of when the key set was checked out","type":"string","example":"2019-08-14T12:30:02Z"},"checkOutNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check out","type":"string"},"checkInAt":{"format":"date-time","description":"The date and time of when the key set was checked in","type":"string","example":"2019-08-14T12:30:02Z"},"checkInNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check in","type":"string"},"_eTag":{"description":"The ETag for the current version of the key movement. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF2000200","created":"2018-12-12T13:30:00Z","modified":"2019-01-08T13:35:00Z","keyId":"OXF2000001","propertyId":"OXF200008","checkOutToId":"CMM","checkOutToType":"negotiator","checkOutAt":"2018-12-12T13:30:00Z","checkOutNegotiatorId":"BYZ","checkInAt":"2018-12-12T15:30:00Z","checkInNegotiatorId":"TTT","_eTag":null,"_links":{"self":{"href":"/properties/OXF200008/keys/OXF2000001/movements/OXF2000200"},"key":{"href":"/properties/OXF200008/keys/OXF2000001"},"property":{"href":"/properties/OXF200008"},"checkOutNegotiator":{"href":"/negotiators/BYZ"},"checkInNegotiator":{"href":"/negotiators/TTT"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"put":{"tags":["Properties"],"summary":"Updates a specific key movement, allowing it to be checked back into the office","operationId":"CheckInKey","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"keyId","description":"Unique key set identifier","required":true,"type":"string"},{"in":"path","name":"movementId","description":"Unique key movement identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The model","schema":{"description":"Request body used for checking in a key","type":"object","properties":{"checkInNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check in","type":"string"}},"example":{"checkInNegotiatorId":"JAS"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/modifiedChecks":{"get":{"tags":["Properties"],"summary":"Gets a collection of modified checks for all properties.","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of checks to be returned per page.\r\nValue can range between 1 and 100, and the default is 25.","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"type","description":"Only return checks with this `type` (preInstruction/certificate/offer/breakClause/allowance/responsibility)","type":"string"},{"in":"query","name":"modifiedFrom","description":"Only return checks which have been modified/created since the given ISO8601 date and time provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return checks which have been modified/created since the given ISO8601 date and time provided.","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the check","type":"string"},"created":{"format":"date-time","description":"The date and time when the check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the check relates to","type":"string"},"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the check (preInstruction/certificate/offer/breakClause/allowance/responsibility)","type":"string"},"propertyId":{"description":"The unique identifier of the property that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","description":"Ad-Hoc Check","status":"needed","type":"preInstruction","propertyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/properties/OXF190001/checks/OXF20002002"},"property":{"href":"/properties/OXF190001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/modifiedChecks/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/modifiedChecks/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/modifiedChecks/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/modifiedChecks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/checks":{"get":{"tags":["Properties"],"summary":"Retrieves a collection of checks associated to a property (eg Pre-Instruction checks)","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"type","description":"Only return checks with this `type` (preInstruction)","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the check","type":"string"},"created":{"format":"date-time","description":"The date and time when the check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the check relates to","type":"string"},"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the check (preInstruction/certificate/offer/breakClause/allowance/responsibility)","type":"string"},"propertyId":{"description":"The unique identifier of the property that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","description":"Ad-Hoc Check","status":"needed","type":"preInstruction","propertyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/properties/OXF190001/checks/OXF20002002"},"property":{"href":"/properties/OXF190001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/OXF190001/checks/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/OXF190001/checks/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/OXF190001/checks/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/OXF190001/checks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Creates a new property check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a property check","schema":{"description":"Request body used to create a new check","required":["description","type","status"],"type":"object","properties":{"description":{"description":"Short, descriptive text describing the purpose of the check","type":"string"},"type":{"description":"The type of the check (preInstruction)","type":"string"},"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"}},"example":{"description":"Ad-Hoc Check","type":"preInstruction","status":"needed"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/properties/{id}/checks/{checkId}":{"get":{"tags":["Properties"],"summary":"Retrieves a specific property check","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique check identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the check","type":"string"},"created":{"format":"date-time","description":"The date and time when the check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the check relates to","type":"string"},"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the check (preInstruction/certificate/offer/breakClause/allowance/responsibility)","type":"string"},"propertyId":{"description":"The unique identifier of the property that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the check. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","description":"Ad-Hoc Check","status":"needed","type":"preInstruction","propertyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/properties/OXF190001/checks/OXF20002002"},"property":{"href":"/properties/OXF190001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates an existing property check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the property that owns the check","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique identifier of the check to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Model for the update of an existing check","type":"object","properties":{"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"}},"example":{"status":"needed"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Properties"],"summary":"Deletes an existing property check","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the property that owns the check","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique identifier of the check to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/certificates":{"get":{"tags":["Properties"],"summary":"Get a collection of certificates across properties","produces":["application/json"],"parameters":[{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of certificates to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (expiry/created/modified)","type":"string"},{"in":"query","name":"expiryDateFrom","description":"Only return certificates with an expiry date on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"expiryDateTo","description":"Only return certificates with an expiry date on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return certificates with a creation date on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return certificates with a creation date on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return certificates with a last modified date on or after the value provided.","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return certificates with a last modified date on or before the value provided.","type":"string","format":"date-time"},{"in":"query","name":"categories","description":"Only return certificates with a category matching one of the provided values (safetyCertificate/insurancePolicy/warranty).","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"typeIds","description":"Only return certificates with a type matching one of the provided values.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyIds","description":"Only return certificates associated with a property matching one of the provided ID values.","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"embed","description":"Embed additional resources into the properties returned\r\nThis is a convenience mechanism that still contributes to your API consumption.\r\nPlease see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information.\r\n","type":"array","items":{"enum":["property"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a cerificate","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The certificate's category (safetyCertificate/insurancePolicy/warranty)","type":"string"},"typeId":{"description":"The certificate's type","type":"string"},"start":{"format":"date-time","description":"The certificate's start date","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The certificate's expiry date","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"companyId":{"description":"The unique identifier of the company","type":"string"},"statusId":{"description":"The unique identifier of the certificates status","type":"string"},"notes":{"description":"Any general notes regarding the certificate","type":"string"},"referenceNumber":{"description":"The certificate's reference number","type":"string"},"responsibleParty":{"description":"The party responsible for the certificate, as defined in property configuration (agent/landlord/notRequired/notSet)","type":"string"},"_eTag":{"description":"The ETag for the current version of the certificate. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"CRT21000001","created":"2021-01-01T13:30:00Z","modified":null,"category":"safetyCertificate","typeId":"GS","start":"2021-01-01","expiry":"2022-01-01","propertyId":"PRP210001","companyId":"CMP210001","statusId":null,"notes":"Some notes about the certificate","referenceNumber":"123456789","responsibleParty":null,"_eTag":null,"_links":{"self":{"href":"/properties/PRP210001/certificates/CRT21000001"},"property":{"href":"/properties/PRP210001"},"documents":{"href":"/documents?associatedType=certificate&associatedId=CRT21000001"},"company":{"href":"/companies/CMP210001"},"type":{"href":"/configuration/certificateTypes/GS"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/PRP210001/certificates/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/PRP210001/certificates/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/PRP210001/certificates/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/PRP210001/certificates/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}}},"security":[{"Authorization":[]}]}},"/properties/{id}/appraisals":{"get":{"tags":["Properties"],"summary":"Get a collection of appraisals for a property","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the property","required":true,"type":"string"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"Maximum number of records per page","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property appraisal","type":"object","properties":{"id":{"description":"Unique identifier of the appraisal","type":"string"},"created":{"format":"date-time","description":"The date and time on which the property appraisal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time on which the property appraisal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"isExternal":{"description":"Flag indicating whether the appraisal is internal or external","type":"boolean"},"date":{"format":"date","description":"The date of the appraisal","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"},"_eTag":{"type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT22045601","created":"2019-12-15T14:51:19Z","modified":"2021-01-13T04:30:02Z","companyId":"MKT123456","isExternal":true,"date":"2020-01-31","price":204995,"fee":{"type":"fixed","amount":9994.99},"notes":"Appraised before modifications to the rear of the property.","_eTag":null}],"pageNumber":1,"pageSize":10,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/properties/RPT220001/appraisals/?PageNumber=1&PageSize=10"},"first":{"href":"/properties/RPT220001/appraisals/?PageNumber=1&PageSize=10"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Record a new property appraisal","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the property","required":true,"type":"string"},{"in":"body","name":"body","description":"The appraisal to create","schema":{"description":"Model for the creation of a new property appraisal","type":"object","properties":{"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"date":{"format":"date","description":"The date of the appraisal","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"}},"example":{"companyId":"RPT22000001","date":"2024-02-14","price":199995,"fee":{"type":"fixed","amount":4999.95},"notes":"Appraisal based on a virtual showing"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}}},"security":[{"Authorization":[]}]}},"/properties/{id}/appraisals/{appraisalId}":{"get":{"tags":["Properties"],"summary":"Get a single appraisal for a property","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the property","required":true,"type":"string"},{"in":"path","name":"appraisalId","description":"Unique identifier of the appraisal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a property appraisal","type":"object","properties":{"id":{"description":"Unique identifier of the appraisal","type":"string"},"created":{"format":"date-time","description":"The date and time on which the property appraisal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time on which the property appraisal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"isExternal":{"description":"Flag indicating whether the appraisal is internal or external","type":"boolean"},"date":{"format":"date","description":"The date of the appraisal","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"},"_eTag":{"type":"string","readOnly":true}}},"examples":{"application/json":{"id":"RPT22045601","created":"2019-12-15T14:51:19Z","modified":"2021-01-13T04:30:02Z","companyId":"MKT123456","isExternal":true,"date":"2020-01-31","price":204995,"fee":{"type":"fixed","amount":9994.99},"notes":"Appraised before modifications to the rear of the property.","_eTag":null}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Update an existing property appraisal","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the property","required":true,"type":"string"},{"in":"path","name":"appraisalId","description":"Unique identifier of the appraisal","required":true,"type":"string"},{"in":"body","name":"body","description":"The update model","schema":{"description":"Model for the creation of a new property appraisal","type":"object","properties":{"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"date":{"format":"date-time","description":"The date of the appraisal","type":"string","example":"2019-08-14T12:30:02Z"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"}},"example":{"companyId":"RPT22000001","date":"2024-02-14","price":199995,"fee":{"type":"fixed","amount":4999.95},"notes":"Appraisal based on a virtual showing"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}}},"security":[{"Authorization":[]}]}},"/properties/{id}/utilities":{"get":{"tags":["Properties"],"summary":"Gets a properties utility information","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the property","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a properties utilities","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the utilities","type":"string"},"propertyId":{"description":"The unique identifier of property associated to the utilities","type":"string"},"created":{"format":"date-time","description":"The date and time when the utilities were created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the utilities were last modified","type":"string","example":"2019-08-14T12:30:02Z"},"electricity":{"description":"Representation of a properties electricity details","type":"object","properties":{"type":{"description":"The type of electricity supplied (windTurbine/mainsSupply/privateSupply/solar/other)","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company providing the electricity","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"}}},"gas":{"description":"Representation of a properties gas details","type":"object","properties":{"hasGas":{"description":"A flag to determine if the property has gas","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company providing the gas","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"}}},"water":{"description":"Representation of a properties water details","type":"object","properties":{"type":{"description":"The type of water supplied (mainsSupply/privateSupply/other)","type":"string"},"waterCompanyId":{"description":"The unique identifier of company providing the water","type":"string"},"waterMeterPoint":{"description":"The water meter point","type":"string"},"sewerage":{"description":"The type of sewerage supplied (mainsSupply/privateSupply/other)","type":"string"}}},"internet":{"description":"Representation of a properties internet details","type":"object","properties":{"type":{"description":"The types of internet supplied (none/adsl/fttc/fttp/cable/other)","type":"array","items":{"type":"string"}},"internetCompanyId":{"description":"The unique identifier of the company providing the internet","type":"string"}}},"telephoneCompanyId":{"description":"The unique identifier of company providing the telephone lines","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of company providing cable tv","type":"string"},"heating":{"description":"The type of heating supplied to the property (airConditioning/centralHeating/doubleGlazing/ecoFriendly/electric/gas/gasCentral/nightStorage/oil/solar/solarWater/underFloor/woodBurner/openFire/biomassBoiler/groundSourceHeatPump/airSourceHeatPump/solarPvThermal/underFloorHeating/solarThermal/other)","type":"array","items":{"type":"string"}},"mainHeating":{"description":"The main type of heating supplied (independent/communal/independentChilled/communalChilled)","type":"array","items":{"type":"string"}},"mobileSignal":{"description":"Information relating the mobile signal","type":"string"},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true},"parking":{"description":"The type of parking available at the property","type":"array","items":{"type":"string"}}}},"examples":{"application/json":{"propertyId":null,"created":"0001-01-01T00:00:00Z","modified":null,"electricity":{"type":"solar","electricityCompanyId":"CMP2200003","electricityMeterPoint":"123"},"gas":{"hasGas":true,"gasCompanyId":"CMP23000004","gasMeterPoint":"456"},"water":{"type":"privateSupply","waterCompanyId":"CMP23000006","waterMeterPoint":"987","sewerage":"mainsSupply"},"internet":{"type":["fttc","fttp"],"internetCompanyId":"CMP23000005"},"telephoneCompanyId":"CMP2100002","cableTvCompanyId":"CMP21000015","heating":["gas","gasCentral"],"mainHeating":["independent","communal"],"mobileSignal":"Great signal throughout the property.","_eTag":null,"parking":["Communal","Garage"],"_links":null,"_embedded":null}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates a properties utility information","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the property","required":true,"type":"string"},{"in":"body","name":"body","description":"The update model","schema":{"description":"Representation of a properties utilities","type":"object","properties":{"electricity":{"description":"Representation of a properties electricity details","type":"object","properties":{"type":{"description":"The type of electricity supplied (windTurbine/mainsSupply/privateSupply/solar/other)","type":"string"},"electricityCompanyId":{"description":"The unique identifier of company providing the electricity","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point","type":"string"}}},"gas":{"description":"Representation of a properties gas details","type":"object","properties":{"hasGas":{"description":"A flag to determine if the property has gas","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of company providing the gas","type":"string"},"gasMeterPoint":{"description":"The gas meter point","type":"string"}}},"water":{"description":"Representation of a properties water details","type":"object","properties":{"type":{"description":"The type of water supplied (mainsSupply/privateSupply/other)","type":"string"},"waterCompanyId":{"description":"The unique identifier of company providing the water","type":"string"},"waterMeterPoint":{"description":"The water meter point","type":"string"},"sewerage":{"description":"The type of sewerage supplied (mainsSupply/privateSupply/other)","type":"string"}}},"internet":{"description":"Representation of a properties internet details","type":"object","properties":{"type":{"description":"The type of internet supplied (none/adsl/fttc/fttp/cable/other)","type":"array","items":{"type":"string"}},"internetCompanyId":{"description":"The unique identifier of company providing the internet","type":"string"}}},"telephoneCompanyId":{"description":"The unique identifier of company providing the telephone lines","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of company providing cable tv","type":"string"},"heating":{"description":"The type of heating supplied to the property (airConditioning/centralHeating/doubleGlazing/ecoFriendly/electric/gas/gasCentral/nightStorage/oil/solar/solarWater/underFloor/woodBurner/openFire/biomassBoiler/groundSourceHeatPump/airSourceHeatPump/solarPvThermal/underFloorHeating/solarThermal/other)","type":"array","items":{"type":"string"}},"mainHeating":{"description":"The main type of heating supplied (independent/communal/independentChilled/communalChilled)","type":"array","items":{"type":"string"}},"mobileSignal":{"description":"Information relating the mobile signal","type":"string"}},"example":{"electricity":{"type":"solar","electricityCompanyId":"CMP2200003","electricityMeterPoint":"123"},"gas":{"hasGas":true,"gasCompanyId":"CMP23000004","gasMeterPoint":"456"},"water":{"type":"privateSupply","waterCompanyId":"CMP23000006","waterMeterPoint":"987","sewerage":"mainsSupply"},"internet":{"type":["fttc","fttp"],"internetCompanyId":"CMP23000005"},"telephoneCompanyId":"CMP2100002","cableTvCompanyId":"CMP21000015","heating":["gas","gasCentral"],"mainHeating":["communal","independent"],"mobileSignal":"Great signal throughout the property."}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}}},"security":[{"Authorization":[]}]}},"/properties/{id}/developmentPhases":{"get":{"tags":["Properties"],"summary":"Gets a collection of development phases for a specific property.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of keys to be returned per page. Value can range between 1 and\r\n100, and the default is 25.","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0).","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property's development phase.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the development phase.","type":"string"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"},"created":{"format":"date-time","description":"The date and time when the development phase was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the development phase was last modified.","type":"string","example":"2019-08-14T12:30:02Z"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT2400016","propertyId":"RPT240001","phase":"Test Phase","notes":"Test Notes","releaseDate":"2021-01-01","completionDate":"2024-01-01","completed":false,"created":"0001-01-01T00:00:00Z","modified":null,"_eTag":null,"_links":null,"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/RPT240001/developmentPhases/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/RPT240001/developmentPhases/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/RPT240001/developmentPhases/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/RPT240001/developmentPhases/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Creates a new development phase for a specific property.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to create the development phase.","schema":{"description":"Request body used to create a new development phase.","type":"object","properties":{"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"}},"example":{"phase":"Phase Test","notes":"Test Notes","releaseDate":"2021-01-01","completionDate":"2021-01-01","completed":true}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/developmentPhases/{developmentPhaseId}":{"get":{"tags":["Properties"],"summary":"Gets a specific development phase by its' unique identifier for a specific property.","operationId":"GetDevelopmentPhaseById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier for the property.","required":true,"type":"string"},{"in":"path","name":"developmentPhaseId","description":"The unique identifier of the development phase.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a property's development phase.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the development phase.","type":"string"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"},"created":{"format":"date-time","description":"The date and time when the development phase was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the development phase was last modified.","type":"string","example":"2019-08-14T12:30:02Z"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"RPT2400016","propertyId":"RPT240001","phase":"Test Phase","notes":"Test Notes","releaseDate":"2021-01-01","completionDate":"2024-01-01","completed":false,"created":"0001-01-01T00:00:00Z","modified":null,"_eTag":null,"_links":null,"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates an existing development phase for a specific property.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"path","name":"developmentPhaseId","description":"The unique identifier of the development phase.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the development phase.","schema":{"description":"Request body used to update an existing development phase.","type":"object","properties":{"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"}},"example":{"phase":"Phase Test","notes":"Test Notes","releaseDate":"2021-01-01","completionDate":"2021-01-01","completed":true}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Properties"],"summary":"Deletes an existing development phase for a specific property.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"path","name":"developmentPhaseId","description":"The unique identifier of the development phase.","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/negotiators":{"get":{"tags":["Properties"],"summary":"Gets a collection of property negotiators for a specific property.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of keys to be returned per page. Value can range between 1 and\r\n100, and the default is 25.","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0).","type":"integer","format":"int32"},{"in":"query","name":"types","description":"The collection of type IDs used to filter the entities (propertyManager/propertyAdministrator/clientAccountAssistant/salesProgressor/salesPropertyAdministrator)","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property-negotiator relationship.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the property negotiator.","type":"string"},"created":{"format":"date-time","description":"The date and time when the property negotiator was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property negotiator was last modified.","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the negotiator.","type":"string"},"type":{"description":"The type of relationship between the property and the negotiator. List of available types:\r\n- propertyManager\r\n- propertyAdministrator\r\n- clientAccountAssistant\r\n- salesProgressor\r\n- salesPropertyAdministrator","type":"string"},"propertyId":{"description":"The unique identifier of the property.","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator.","type":"string"},"_eTag":{"description":"The ETag for the current version of the property negotiator. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"RPT24000001","created":"2024-08-30","modified":"2024-08-30","name":"John Smith","type":"salesProgressor","propertyId":"RPT240001","negotiatorId":"JSM","_eTag":null,"_links":null,"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/RPT240001/negotiators/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/RPT240001/negotiators/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/RPT240001/negotiators/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/RPT240001/negotiators/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/marketing":{"get":{"tags":["Properties"],"summary":"Gets a specific property descriptions by its' unique identifier for a specific property.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier for the property.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"The read model for property description.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of property associated to the property description.","type":"string"},"created":{"format":"date-time","description":"The date and time when the property description was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property description was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of property associated to the utilities","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"strapLine":{"description":"The strapline description containing a short summary about the property","type":"string"},"description1":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description2":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description3":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description4":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description5":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description6":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}},"examples":{"application/json":{"id":null,"created":"0001-01-01T00:00:00Z","modified":null,"propertyId":"OXF190001","summary":"Account summary data","description":"Description","strapLine":"Test Strapline","description1":{"name":"Long Description","text":"Long Description Test"},"description2":{"name":"Location","text":"Some location text"},"description3":{"name":"Situation","text":"Some situation text"},"description4":{"name":"Directions","text":"Some directions text"},"description5":{"name":"TestCaption5","text":"Some caption text"},"description6":{"name":"TestCaption6","text":"Some caption text"},"_eTag":null,"_links":null,"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates an existing property descriptions.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique property identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the property description.","schema":{"description":"Request body to update the property description of an existing property","type":"object","properties":{"description1":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description2":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description3":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description4":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description5":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description6":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}}},"example":{"description1":{"text":"This is the first description."},"description2":{"text":"This is the second description."},"description3":{"text":"This is the third description."},"description4":{"text":"This is the fourth description."},"description5":{"text":"This is the fifth description."},"description6":{"text":"This is the sixth description."}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/properties/{id}/checklists":{"get":{"tags":["Properties"],"summary":"Gets the checklists for the property given by the unique identifier.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Represents a collection of property checklists.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"propertyId":{"description":"The unique identifier of the property this checklist is associated with.","type":"string","readOnly":true},"checklists":{"description":"The collection of property checklists.","type":"array","items":{"description":"Represents a property checklist.","type":"object","properties":{"name":{"description":"The name of the checklist.","type":"string","readOnly":true},"checks":{"description":"The collection of checks on the list.","type":"array","items":{"description":"Represents a check in a property checklist.","type":"object","properties":{"id":{"description":"The unique identifier of the check, should it exist.","type":"string","readOnly":true},"label":{"description":"The label of the check.","type":"string","readOnly":true},"type":{"description":"The type of the check (string/integer/double/decimal/datetime/boolean)","type":"string","readOnly":true},"value":{"description":"The value of the check, should it exist.","readOnly":true},"notApplicable":{"description":"Flag to determine if this check is applicable for the associated property.","type":"boolean","readOnly":true}}},"readOnly":true}}},"readOnly":true}}},"examples":{"application/json":{"propertyId":"PRP240001","checklists":[{"name":"Pre-completion","checks":[{"id":"CHK24000001","label":"Start date","type":"DateTime","value":"2024-11-01","notApplicable":false},{"id":null,"label":"Reference count","type":"Integer","value":null,"notApplicable":null},{"id":"CHK24000002","label":"Property manager","type":"String","value":"ABC","notApplicable":false},{"id":"CHK24000003","label":"Notes received","type":"Boolean","value":false,"notApplicable":true}]}],"_links":null,"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/alarms":{"get":{"tags":["Properties"],"summary":"Gets a collection of alarms for a specific property.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0).","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of properties to be returned per page. Value can range between 1 and 100,\r\nand the default is 25.","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"The read model for an alarm.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the alarm.","type":"string"},"created":{"format":"date-time","description":"The date the alarm record was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The last modified date.","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this alarm is for.","type":"string"},"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The model for the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"ALM24000001","created":"2024-11-19T12:31:47Z","modified":"2024-11-19T12:31:47Z","propertyId":"PRP240001","categoryId":"SM","typeId":"BT","location":"Upstairs bedroom","checkedDate":"2024-11-18","checkedBy":{"type":"negotiator","value":"RPT"},"serviceDate":"2025-06-13","expiryDate":"2026-08-29","removed":false,"_eTag":null,"_links":{"self":{"href":"/properties/PRP240001/alarms"},"categories":{"href":"/configuration/alarmCategories/SM"},"types":{"href":"/configuration/alarmTypes/BT"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}],"pageNumber":1,"pageSize":25,"pageCount":1,"totalPageCount":1,"totalCount":1,"_links":{"self":{"href":"/properties/PRP240001/alarms/?PageNumber=1&PageSize=25"},"first":{"href":"/properties/PRP240001/alarms/?PageNumber=1&PageSize=25"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Properties"],"summary":"Creates a new alarm against a specific property.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to create the alarm.","schema":{"description":"The model containing data for creating an alarm.","type":"object","properties":{"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The base model for reading, creating or updating the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"}},"example":{"categoryId":"SM","typeId":"BT","location":"Upstairs bedroom","checkedDate":"2024-11-18","checkedBy":{"type":"negotiator","value":"RPT"},"serviceDate":"2025-06-13","expiryDate":"2026-08-29","removed":false}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/alarms/{alarmId}":{"get":{"tags":["Properties"],"summary":"Gets a specific alarm by its unique identifier for a specific property.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"path","name":"alarmId","description":"The unique identifier of the alarm.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"The read model for an alarm.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the alarm.","type":"string"},"created":{"format":"date-time","description":"The date the alarm record was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The last modified date.","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this alarm is for.","type":"string"},"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The model for the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"ALM24000001","created":"2024-11-19T12:31:47Z","modified":"2024-11-19T12:31:47Z","propertyId":"PRP240001","categoryId":"SM","typeId":"BT","location":"Upstairs bedroom","checkedDate":"2024-11-18","checkedBy":{"type":"negotiator","value":"RPT"},"serviceDate":"2025-06-13","expiryDate":"2026-08-29","removed":false,"_eTag":null,"_links":{"self":{"href":"/properties/PRP240001/alarms"},"categories":{"href":"/configuration/alarmCategories/SM"},"types":{"href":"/configuration/alarmTypes/BT"},"negotiator":{"href":"/negotiators/RPT"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates an existing alarm against a specific property.","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"path","name":"alarmId","description":"The unique identifier of the alarm.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the alarm.","schema":{"description":"The model containing data for updating an alarm.","type":"object","properties":{"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The base model for reading, creating or updating the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"}},"example":{"categoryId":"SM","typeId":"BT","location":"Upstairs bedroom","checkedDate":"2024-11-18","checkedBy":{"type":"negotiator","value":"RPT"},"serviceDate":"2025-06-13","expiryDate":"2026-08-29","removed":false}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/properties/{id}/multilingual":{"get":{"tags":["Properties"],"summary":"Gets the multilingual descriptions for a specific property.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0).","type":"integer","format":"int32"},{"in":"query","name":"pageSize","description":"A limit on the number of records to be returned per page. Value can range between 1 and 100,\r\nand the default is 25.","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property for a specific language","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the associated property","type":"string"},"created":{"format":"date-time","description":"The date and time when the associated property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the associated property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"langId":{"description":"The unique identifier of the language","type":"string"},"langName":{"description":"The name of the language","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"accommodationSummary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"brief":{"description":"The brief description of the property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise in a second language","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"rooms":{"description":"The rooms within the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"description1":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description2":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description3":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description4":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description5":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description6":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF2000001","created":"2018-12-12T13:30:00Z","modified":"2019-01-08T13:35:00Z","langId":"es","langName":"Spanish","strapline":"Spanish Strapline","accommodationSummary":"Spanish Accomodation Summary","brief":"Spanish Brief","address":{"buildingName":"Spanish Building Name","buildingNumber":"123","line1":"Spanish line 1","line2":"Spanish line 2","line3":"Spanish Line 3","line4":"Spanish Line 4","postcode":"ES12 345"},"rooms":[{"dimensionsAlt":null,"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a  Clearview stove."},{"dimensionsAlt":null,"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room."}],"description1":{"name":"Location","text":"Spanish Location"},"description2":{"name":"Area Guide","text":"Spanish Area Guide"},"description3":null,"description4":null,"description5":null,"description6":null,"_eTag":null,"_links":{"self":{"href":"/properties/OXF2000001/multilingual/es"},"property":{"href":"/properties/OXF2000001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/properties/OXF2000001/multilingual/?PageNumber=1&PageSize=1"},"first":{"href":"/properties/OXF2000001/multilingual/?PageNumber=1&PageSize=1"},"next":{"href":"/properties/OXF2000001/multilingual/?PageNumber=2&PageSize=1"},"last":{"href":"/properties/OXF2000001/multilingual/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/properties/{id}/multilingual/{langId}":{"get":{"tags":["Properties"],"summary":"Gets the multlinigual details of a specific property for a specific language","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"path","name":"langId","description":"The unique language identifier.","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a property for a specific language","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the associated property","type":"string"},"created":{"format":"date-time","description":"The date and time when the associated property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the associated property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"langId":{"description":"The unique identifier of the language","type":"string"},"langName":{"description":"The name of the language","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"accommodationSummary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"brief":{"description":"The brief description of the property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise in a second language","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"rooms":{"description":"The rooms within the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"description1":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description2":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description3":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description4":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description5":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description6":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF2000001","created":"2018-12-12T13:30:00Z","modified":"2019-01-08T13:35:00Z","langId":"es","langName":"Spanish","strapline":"Spanish Strapline","accommodationSummary":"Spanish Accomodation Summary","brief":"Spanish Brief","address":{"buildingName":"Spanish Building Name","buildingNumber":"123","line1":"Spanish line 1","line2":"Spanish line 2","line3":"Spanish Line 3","line4":"Spanish Line 4","postcode":"ES12 345"},"rooms":[{"dimensionsAlt":null,"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a  Clearview stove."},{"dimensionsAlt":null,"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room."}],"description1":{"name":"Location","text":"Spanish Location"},"description2":{"name":"Area Guide","text":"Spanish Area Guide"},"description3":null,"description4":null,"description5":null,"description6":null,"_eTag":null,"_links":{"self":{"href":"/properties/OXF2000001/multilingual/es"},"property":{"href":"/properties/OXF2000001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Properties"],"summary":"Updates a specific properties multilingual fields for a given language","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the property.","required":true,"type":"string"},{"in":"path","name":"langId","description":"The unique identifier of the language.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the multilingual fields.","schema":{"description":"Request body used to update an existing properties multilingual descriptions","type":"object","properties":{"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"accommodationSummary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"brief":{"description":"The brief description of the property","type":"string"},"address":{"description":"Request body used to update the address of an existing property","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"rooms":{"description":"The rooms within the property","type":"array","items":{"description":"The base model containing data for reading, creating or updating a room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"}}}},"description1":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description2":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description3":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description4":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description5":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description6":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}}},"example":{"strapline":"Spanish Strapline","accommodationSummary":"Spanish Accomodation Summary","brief":"Spanish Brief","address":{"buildingName":"Spanish Building Name","buildingNumber":"123","line1":"Spanish line 1","line2":"Spanish line 2","line3":"Spanish Line 3","line4":"Spanish Line 4","postcode":"ES12 345"},"rooms":[{"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a  Clearview stove."},{"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room."}],"description1":{"text":"Spanish Location"},"description2":{"text":"Spanish Area Guide"},"description3":{"text":null},"description4":{"text":null},"description5":{"text":null},"description6":{"text":null}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/propertyImages/":{"get":{"tags":["PropertyImages"],"summary":"Gets a collection of property images","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of property images to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/order/type/propertyId)","type":"string"},{"in":"query","name":"id","description":"Only return property images where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"embed","description":"Embed additional resources into the property images returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["property"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return property images where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"type","description":"Only return property images where the `type` field matches one or more values provided ","type":"array","items":{"enum":["photograph","map","floorPlan","epc"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"createdFrom","description":"Only return property images where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return property images where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return property images where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return property images where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"fromArchive","description":"Only return contacts where the `fromArchive` field matches the value given","type":"boolean"},{"in":"query","name":"metadata","description":"Only return property images where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property image","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the image, which is also the filename","type":"string"},"created":{"format":"date-time","description":"The date and time when the image was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property image was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property attached to the image","type":"string"},"url":{"description":"The url where the image can be downloaded from. Please note that physical assets for archived images may no longer be available","type":"string"},"thumbnailUrl":{"description":"The url where the image thumbnail can be downloaded from.  Please not that physical assets for archived images may no longer be available","type":"string"},"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"},"order":{"format":"int32","description":"The display order index of the image which can be used to correctly order the whole collection","type":"integer"},"fromArchive":{"description":"A flag determining whether or not the image is archived. Please note that physical assets for archived images may no longer be available","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the image. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF100008_01.jpg","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","propertyId":"OXF100008","url":"https://www.exampleurl.com/images/OXF100008_01.jpg","thumbnailUrl":null,"caption":"Living room","type":"photograph","order":1,"fromArchive":false,"_eTag":null,"_links":{"self":{"href":"/propertyImages/OXF100008_01.jpg"},"property":{"href":"/properties/OXF100008"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/propertyImages/?PageNumber=1&PageSize=1"},"first":{"href":"/propertyImages/?PageNumber=1&PageSize=1"},"next":{"href":"/propertyImages/?PageNumber=2&PageSize=1"},"last":{"href":"/propertyImages/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["PropertyImages"],"summary":"Creates a property image","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the property image.","schema":{"description":"Request body used to create a new property image","required":["propertyId","caption","type"],"type":"object","properties":{"data":{"description":"The base64 encoded file content, prefixed with the content type (eg. data:image/jpeg;base64,VGVzdCBmaWxl)","type":"string"},"fileUrl":{"description":"The presigned s3 url which a property image has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"propertyId":{"description":"The unique identifier of the property attached to the image","type":"string"},"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"}},"example":{"data":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==","fileUrl":null,"propertyId":"OXF100008","caption":"Living room","type":"photograph"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"412":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/propertyImages/{id}":{"get":{"tags":["PropertyImages"],"summary":"Gets a single property image by its' unique identifier","operationId":"GetPropertyImageById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the property image. This is the filename and not the property id","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the property image returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["property"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a property image","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the image, which is also the filename","type":"string"},"created":{"format":"date-time","description":"The date and time when the image was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property image was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property attached to the image","type":"string"},"url":{"description":"The url where the image can be downloaded from. Please note that physical assets for archived images may no longer be available","type":"string"},"thumbnailUrl":{"description":"The url where the image thumbnail can be downloaded from.  Please not that physical assets for archived images may no longer be available","type":"string"},"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"},"order":{"format":"int32","description":"The display order index of the image which can be used to correctly order the whole collection","type":"integer"},"fromArchive":{"description":"A flag determining whether or not the image is archived. Please note that physical assets for archived images may no longer be available","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the image. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF100008_01.jpg","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","propertyId":"OXF100008","url":"https://www.exampleurl.com/images/OXF100008_01.jpg","thumbnailUrl":null,"caption":"Living room","type":"photograph","order":1,"fromArchive":false,"_eTag":null,"_links":{"self":{"href":"/propertyImages/OXF100008_01.jpg"},"property":{"href":"/properties/OXF100008"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["PropertyImages"],"summary":"Updates a property image by unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier for the property image to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the property image.","schema":{"description":"Request body used to update an existing property image","type":"object","properties":{"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"}},"example":{"caption":"Living room","type":"photograph"}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["PropertyImages"],"summary":"Deletes a property image by unique identifier","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier for the property image to delete.","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/propertyImages/signedUrl":{"post":{"tags":["PropertyImages"],"summary":"Creates pre signed urls used for uploading files between 6MB and 30MB","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create pre signed urls to upload files between 6MB and 30MB","required":["amount"],"type":"object","properties":{"amount":{"format":"int32","description":"The number of pre signed urls to create","type":"integer"}},"example":{"amount":1}}}],"responses":{"200":{"description":"Success","schema":{"description":"Request body used to create pre signed urls to upload files between 6MB and 30MB","required":["amount"],"type":"object","properties":{"amount":{"format":"int32","description":"The number of pre signed urls to create","type":"integer"}},"example":{"amount":1}}},"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/propertyImages/reindex":{"post":{"tags":["PropertyImages"],"summary":"Reindex the images for a property","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to reindex property images","type":"object","properties":{"propertyId":{"description":"The unique identifier of the property to update","type":"string"},"imageOrder":{"description":"Ordered collection of image identifiers for the property.\r\nThe first image in the collection will be set as the properties primary image.","type":"array","items":{"type":"string"}}},"example":{"propertyId":"RPT230020","imageOrder":["RPT230020_02.JPG","RPT230020_01.JPG","RPT230020_03.JPG"]}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}}},"security":[{"Authorization":[]}]}},"/referrals/":{"get":{"tags":["Referrals"],"summary":"Retrieves a collection of referrals","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return referrals where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return referrals where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"applicantId","description":"Only return referrals where the `applicantId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"contactId","description":"Only return referrals where the `contactId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return referrals where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"referralTypeId","description":"Only return referrals where the `referralTypeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"status","description":"Only return referrals where the `status` field matches one or more values provided ","type":"array","items":{"enum":["sent","inProgress","succeeded","cancelled","failed","paid","declined"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"embed","description":"Embed additional resources into the referrals returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["applicant","contact","negotiator","property","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"pageSize","description":"A limit on the number of referrals to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"createdFrom","description":"Only return referrals where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return referrals where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return referrals where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return referrals where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a referral","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the referral","type":"string"},"created":{"format":"date-time","description":"The date and time when the referral was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the referral was amended","type":"string","example":"2019-08-14T12:30:02Z"},"referralTypeId":{"description":"The unique identifier of the referralTypeId the referral is associated with, where applicable","type":"string"},"type":{"description":"The type of referral (referral/lead). Please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#referral) for further information","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator the referral is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the referral is associated with, where applicable","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"contactId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"status":{"description":"The status of the referral (sent/succeeded/cancelled/failed/paid/declined/inProgress)","type":"string"},"information":{"description":"The information of the referral","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"paid":{"format":"date-time","description":"The date and time when the referral was paid","type":"string","example":"2019-08-14T12:30:02Z"},"accepted":{"format":"date-time","description":"The date and time when the referral was accepted","type":"string","example":"2019-08-14T12:30:02Z"},"related":{"description":"Representation of a contact","type":"object","properties":{"id":{"type":"string"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the referral","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the referral. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"MKT210001","created":"0001-01-01T00:00:00Z","modified":null,"referralTypeId":"JTS","type":null,"negotiatorId":"RPT","propertyId":"RPT200420","applicantId":"RPT210001","contactId":"RPT22000001","status":"sent","information":"Information notes","amount":0,"paid":null,"accepted":null,"related":null,"metadata":null,"_eTag":null,"extrasField":null,"_links":{"self":{"href":"/referrals/MKT210001"},"negotiator":{"href":"/negotiators/RPT"},"property":{"href":"/properties/RPT200420"},"applicant":{"href":"/applicants/RPT210001"},"contact":{"href":"/contacts/RPT22000001"},"referralType":{"href":"/referrals/types/JTS"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/referrals/?PageNumber=1&PageSize=1"},"first":{"href":"/referrals/?PageNumber=1&PageSize=1"},"next":{"href":"/referrals/?PageNumber=2&PageSize=1"},"last":{"href":"/referrals/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Referrals"],"summary":"Create a referral","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the referral","schema":{"description":"Create Referral Model","required":["referralTypeId","contactId"],"type":"object","properties":{"referralTypeId":{"description":"The unique identifier of the referral type","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator creating the referral","type":"string"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"applicantId":{"description":"The unique identifier of the applicant","type":"string"},"contactId":{"description":"The unique identifier of the contact that has been referred","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"information":{"description":"The information of the referral","type":"string"}},"example":{"referralTypeId":"REF01","negotiatorId":"","propertyId":"PRP1300001","applicantId":null,"contactId":"RPT23000001","amount":10,"information":"Information notes"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/referrals/{id}":{"get":{"tags":["Referrals"],"summary":"Retrieves a specific referral","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the referral to return","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the referral returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["applicant","contact","negotiator","property","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a referral","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the referral","type":"string"},"created":{"format":"date-time","description":"The date and time when the referral was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the referral was amended","type":"string","example":"2019-08-14T12:30:02Z"},"referralTypeId":{"description":"The unique identifier of the referralTypeId the referral is associated with, where applicable","type":"string"},"type":{"description":"The type of referral (referral/lead). Please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#referral) for further information","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator the referral is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the referral is associated with, where applicable","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"contactId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"status":{"description":"The status of the referral (sent/succeeded/cancelled/failed/paid/declined/inProgress)","type":"string"},"information":{"description":"The information of the referral","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"paid":{"format":"date-time","description":"The date and time when the referral was paid","type":"string","example":"2019-08-14T12:30:02Z"},"accepted":{"format":"date-time","description":"The date and time when the referral was accepted","type":"string","example":"2019-08-14T12:30:02Z"},"related":{"description":"Representation of a contact","type":"object","properties":{"id":{"type":"string"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the referral","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the referral. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}},"examples":{"application/json":{"id":"MKT210001","created":"0001-01-01T00:00:00Z","modified":null,"referralTypeId":"JTS","type":null,"negotiatorId":"RPT","propertyId":"RPT200420","applicantId":"RPT210001","contactId":"RPT22000001","status":"sent","information":"Information notes","amount":0,"paid":null,"accepted":null,"related":null,"metadata":null,"_eTag":null,"extrasField":null,"_links":{"self":{"href":"/referrals/MKT210001"},"negotiator":{"href":"/negotiators/RPT"},"property":{"href":"/properties/RPT200420"},"applicant":{"href":"/applicants/RPT210001"},"contact":{"href":"/contacts/RPT22000001"},"referralType":{"href":"/referrals/types/JTS"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Referrals"],"summary":"Updates the details of a specific referral","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the referral","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the referral","schema":{"description":"Update Referral Model","type":"object","properties":{"status":{"description":"The status of the referral (sent/succeeded/cancelled/failed/paid/declined/inProgress)","type":"string"},"information":{"description":"The information of the referral","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"metadata":{"description":"App specific metadata to set against the referral","type":"object","additionalProperties":{}}},"example":{"status":"sent","information":null,"amount":0,"metadata":{}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/referrals/types":{"get":{"tags":["Referrals"],"summary":"Retrieves a collection of referral types","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"Only return referral types where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"pageSize","description":"A limit on the number of referral types to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a referral type","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"type":"string"},"name":{"description":"The name of the referral type","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"MRL","name":"My Removals Ltd","_links":{"self":{"href":"/referrals/types/MRL"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/referrals/types/?PageNumber=1&PageSize=1"},"first":{"href":"/referrals/types/?PageNumber=1&PageSize=1"},"next":{"href":"/referrals/types/?PageNumber=2&PageSize=1"},"last":{"href":"/referrals/types/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/referrals/types/{id}":{"get":{"tags":["Referrals"],"summary":"Retrieves a specific referral type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the referral type to return","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a referral type","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"type":"string"},"name":{"description":"The name of the referral type","type":"string"}}},"examples":{"application/json":{"id":"MRL","name":"My Removals Ltd","_links":{"self":{"href":"/referrals/types/MRL"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/resthooks/":{"get":{"tags":["RestHooks"],"summary":"Retrieves a collection of webhooks","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of webhook subscriptions to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"active","description":"Only return webhook subscriptions where the `active` field matches the value provided","type":"boolean"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a webhook subscription","type":"object","properties":{"id":{"format":"uuid","description":"The unique identifier of the webhook","type":"string"},"created":{"format":"date-time","description":"The date and time when the webhook was created","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"modified":{"format":"date-time","description":"The date and time when the webhook was last modified","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the webhook is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"6f9942e4-a19c-4cc5-8c5e-8eeab708bfb5","created":"2020-08-12T11:30:12.0000000Z","modified":"2020-11-05T17:12:44.0000000Z","url":"https://www.reapit.com/contacts","description":"Webhook for SBOX contact updates","topicIds":["contacts.modified"],"active":true,"ignoreEtagOnlyChanges":true}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/webhooks/?PageNumber=1&PageSize=1"},"first":{"href":"/webhooks/?PageNumber=1&PageSize=1"},"next":{"href":"/webhooks/?PageNumber=2&PageSize=1"},"last":{"href":"/webhooks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["RestHooks"],"summary":"Creates a new webhook subscription","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the new webhook","schema":{"description":"Request body used to create a new webhook subscription","required":["url"],"type":"object","properties":{"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the subscription is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted\r\nPass true to disable emitting of these events","type":"boolean"}},"example":{"url":"https://www.example-url/webhook-reciever","description":"Webhook for SBOX contact updates","topicIds":["contacts.modified"],"active":true,"ignoreEtagOnlyChanges":true}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/resthooks/{id}":{"get":{"tags":["RestHooks"],"summary":"Retrieves a specific webhook","operationId":"GetWebhookById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the webhook to return","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a webhook subscription","type":"object","properties":{"id":{"format":"uuid","description":"The unique identifier of the webhook","type":"string"},"created":{"format":"date-time","description":"The date and time when the webhook was created","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"modified":{"format":"date-time","description":"The date and time when the webhook was last modified","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the webhook is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted","type":"boolean"}}},"examples":{"application/json":{"id":"49189e60-d1ff-410d-8032-e63e3d5cbf07","created":"2020-08-12T11:30:12.0000000Z","modified":"2020-11-05T17:12:44.0000000Z","url":"https://www.reapit.com/contacts","description":"Webhook for SBOX contact updates","topicIds":["contacts.modified"],"active":true,"ignoreEtagOnlyChanges":true}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"put":{"tags":["RestHooks"],"summary":"Update an existing webhook subscription","consumes":["application/json-patch+json","application/json","application/*+json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the webhook subscription to update","required":true,"type":"string","format":"uuid"},{"in":"body","name":"body","description":"The model containing data to be used to update the webhook subscription","schema":{"description":"Request body used to update a webhook subscription","required":["url"],"type":"object","properties":{"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the subscription is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted\r\nPass true to disable emitting of these events","type":"boolean"}},"example":{"url":"https://www.example-url/webhook-reciever","description":"Webhook for SBOX appointment updates","topicIds":["appointments.modified"],"active":true,"ignoreEtagOnlyChanges":true}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["RestHooks"],"summary":"Soft delete an existing webhook subscription","parameters":[{"in":"path","name":"id","description":"The unique identifier of the webhook subscription to delete","required":true,"type":"string","format":"uuid"}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/sources/":{"get":{"tags":["Sources"],"summary":"Gets a paged collection of sources","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of sources to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"id","description":"Only return sources where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return sources where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"departmentId","description":"Only return sources where the `departmentId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"name","description":"Only return sources where the `name` field matches the value provided","type":"string"},{"in":"query","name":"type","description":"Only return sources where the `type` field matches the value provided (advertisement/source)","type":"string"},{"in":"query","name":"createdFrom","description":"Only return sources where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return sources where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return sources where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return sources where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a source of business","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the source","type":"string"},"created":{"format":"date-time","description":"The date and time when the source was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the source was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the source. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"ADV","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","name":"Property Portal","type":"source","officeIds":["OXF"],"departmentIds":["G"],"_eTag":null,"_links":{"self":{"href":"/sources/ADV"},"offices":{"href":"/offices/?id=OXF"},"departments":{"href":"/departments/?id=G"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/sources/?PageNumber=1&PageSize=1"},"first":{"href":"/sources/?PageNumber=1&PageSize=1"},"next":{"href":"/sources/?PageNumber=2&PageSize=1"},"last":{"href":"/sources/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Sources"],"summary":"Create a new source","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model containing data to be used to create the source","schema":{"description":"Request body used to create a new source of business","required":["name","type"],"type":"object","properties":{"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}}},"example":{"name":"Property Portal","type":"source","officeIds":["OXF"],"departmentIds":["G"]}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/sources/{id}":{"get":{"tags":["Sources"],"summary":"Retrieve a specific sources","operationId":"GetSourceById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the sources","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a source of business","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the source","type":"string"},"created":{"format":"date-time","description":"The date and time when the source was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the source was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the source. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"ADV","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","name":"Property Portal","type":"source","officeIds":["OXF"],"departmentIds":["G"],"_eTag":null,"_links":{"self":{"href":"/sources/ADV"},"offices":{"href":"/offices/?id=OXF"},"departments":{"href":"/departments/?id=G"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Sources"],"summary":"Update a source","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier for the source to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the source.","schema":{"description":"Request body used to update an existing source of business","type":"object","properties":{"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}}},"example":{"name":"Property Portal","type":"source","officeIds":["OXF"],"departmentIds":["G"]}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tasks/":{"get":{"tags":["Tasks"],"summary":"Retrieves a collection of tasks","operationId":"GetTasks","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of tasks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/typeId/activates/senderId)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the tasks returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["applicant","contact","landlord","property","tenancy","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return tasks where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"applicantId","description":"Only return tasks where the `applicantId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"contactId","description":"Only return tasks where the `contactId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"landlordId","description":"Only return tasks where the `landlordId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return tasks where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return tasks where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"recipientId","description":"Only return tasks where the `recipientId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"senderId","description":"Only return tasks where the `senderId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"typeId","description":"Only return tasks where the `typeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"tenancyId","description":"Only return tasks where the `tenancyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"activatesFrom","description":"Only return tasks where the `activates` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"activatesTo","description":"Only return tasks where the `activates` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return tasks where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return tasks where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return tasks where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return tasks where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"completedFrom","description":"Only return tasks where the 'completed' date is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"completedTo","description":"Only return tasks where the 'completed' date is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"text","description":"Only return tasks where the text contains the value provided","type":"string"},{"in":"query","name":"metadata","description":"Only return tasks where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a task, which can also be an internal message","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the task","type":"string"},"created":{"format":"date-time","description":"The date and time when the task was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the task was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"activates":{"format":"date","description":"The date the task becomes active","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the task. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF2000001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","activates":"2019-05-12","completed":"2019-07-05","typeId":"MI","senderId":"JAS","text":"Arrange for bathroom photos to be retaken.","landlordId":null,"propertyId":"OXF123022","applicantId":null,"tenancyId":null,"contactId":null,"recipientId":"OXF","recipientType":"office","metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/tasks/OXF2000001"},"sender":{"href":"/negotiators/JAS"},"recipient":{"href":"/offices/OXF"},"type":{"href":"/configuration/taskTypes/MI"},"property":{"href":"/properties/OXF123022"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tasks/?PageNumber=1&PageSize=1"},"first":{"href":"/tasks/?PageNumber=1&PageSize=1"},"next":{"href":"/tasks/?PageNumber=2&PageSize=1"},"last":{"href":"/tasks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tasks"],"summary":"Creates a new task","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to create a new task, which can also be an internal message","required":["senderId","text","recipientId","recipientType"],"type":"object","properties":{"activates":{"format":"date","description":"The date the task becomes active (Required when 'TypeId' is given)","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}}},"example":{"activates":"2019-05-12","completed":"2019-07-05","typeId":"MI","senderId":"JAS","text":"Arrange for bathroom photos to be retaken","landlordId":null,"propertyId":"OXF123022","applicantId":null,"tenancyId":null,"contactId":null,"recipientId":"OXF","recipientType":"office","metadata":{"CustomField1":"CustomValue1","CustomField2":false}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"401":{"description":"Unauthorized"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tasks/{id}":{"get":{"tags":["Tasks"],"summary":"Retrieves a specific task","operationId":"GetTaskById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the task to return","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the task returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["applicant","contact","landlord","property","tenancy","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a task, which can also be an internal message","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the task","type":"string"},"created":{"format":"date-time","description":"The date and time when the task was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the task was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"activates":{"format":"date","description":"The date the task becomes active","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the task. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF2000001","created":"2018-12-12T12:30:23Z","modified":"2019-01-08T12:30:34Z","activates":"2019-05-12","completed":"2019-07-05","typeId":"MI","senderId":"JAS","text":"Arrange for bathroom photos to be retaken.","landlordId":null,"propertyId":"OXF123022","applicantId":null,"tenancyId":null,"contactId":null,"recipientId":"OXF","recipientType":"office","metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/tasks/OXF2000001"},"sender":{"href":"/negotiators/JAS"},"recipient":{"href":"/offices/OXF"},"type":{"href":"/configuration/taskTypes/MI"},"property":{"href":"/properties/OXF123022"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tasks"],"summary":"Updates a task by its unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier of the task to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the task.","schema":{"description":"Request body used to update an existing task, which can also be an internal message","type":"object","properties":{"activates":{"format":"date","description":"The date the task becomes active (Required when 'TypeId' is given)","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}}},"example":{"activates":"2019-05-12","completed":"2019-07-05","typeId":"MI","senderId":"JAS","text":"Arrange for bathroom photos to be retaken","landlordId":null,"propertyId":"OXF123022","applicantId":null,"tenancyId":null,"contactId":null,"recipientId":"OXF","recipientType":"office","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Tasks"],"summary":"Deletes an existing task","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the task to delete.","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/":{"get":{"tags":["Tenancies"],"summary":"Retrieves a collection of tenancies","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of tenancies to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"fromArchive","description":"Only return tenancies where the `fromArchive` field matches the value given","type":"boolean"},{"in":"query","name":"embed","description":"Embed additional resources into the tenancies returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","applicant","extensions","documents","negotiator","property","source","tasks","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return tenancies where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return tenancies where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"applicantId","description":"Only return tenancies where the `applicantId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return tenancies where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"name","description":"Only return tenancies where the `name` field of one of the related contacts matches the value provided. This can be used in conjunction with the nameType parameter to improve search performance","type":"string"},{"in":"query","name":"nameType","description":"Specify the kind of name filter being applied. When not specified, a full name search will be carried out which is slower than a quicker surname/initials search","type":"string"},{"in":"query","name":"status","description":"Only return tenancies where the `status` field matches one or more values provided ","type":"array","items":{"enum":["offerPending","offerWithdrawn","offerRejected","arranging","current","finished","cancelled"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"email","description":"Only return tenancies where the contacts `email` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"createdFrom","description":"Only return tenancies where the `created` field is after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return tenancies where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return tenancies where the `modified` field is after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return tenancies where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"endDateFrom","description":"Only return tenancies where the `endDate` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"endDateTo","description":"Only return tenancies where the `endDate` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"startDateFrom","description":"Only return tenancies where the `startDate` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"startDateTo","description":"Only return tenancies where the `startDate` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return tenancies where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging/current/finished/cancelled)","type":"string"},"agentRole":{"description":"The role that the agent is performing for this tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency\r\nNote that this is the original rent set on the tenancy. For tenancies that have been extended with a rent change you MUST use the extensions endpoint","type":"number"},"currency":{"description":"The currency set against the tenancy","type":"string"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"endDateConfirmed":{"description":"A flag determining whether or not the tenancy is confirmed to finish at the end date","type":"boolean"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"periodicReviewDate":{"format":"date-time","description":"The date that the tenancy is due for a review, only applicable for periodic tenancies","type":"string","example":"2019-08-14T12:30:02Z"},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"initialInspectionFrequencyInDays":{"format":"int64","description":"One time inspection scheduled a specific number of days after the tenancy start date","type":"integer"},"regularInspectionFrequencyInDays":{"format":"int64","description":"Recurring inspections set to occur at specified intervals","type":"integer"},"finishedReason":{"description":"The reason for the tenancy finishing","type":"string"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"isRentersRights":{"description":"If the tenancy has renters' rights","type":"boolean"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"propertyId":{"description":"The unique identifier of the property that relates to the tenancy","type":"string"},"applicantId":{"description":"The unique identifier of the applicant who has applied to be a tenant. Whilst the tenancy is an in arranging state, information about the individual such as name and contact details can be obtained from GET /applicants/{id}. Use the link in the _links collection for a relative URI","type":"string"},"managerId":{"description":"The unique identifier of the negotiator assigned as the manager of the tenancy","type":"string"},"groupPaymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with all tenants in the property","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"daysInArrears":{"format":"int32","description":"The number of days rent invoices can be paid in arrears","type":"integer"},"source":{"description":"A tenancy source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the source for this tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"deposit":{"description":"A tenancy deposit model","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"depositProtection":{"description":"A tenancy deposit protection model","type":"object","properties":{"scheme":{"description":"The unique identifier of the deposit protection","type":"string"},"registeredDate":{"format":"date-time","description":"The date when deposit protection is registered","type":"string","example":"2019-08-14T12:30:02Z"},"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection","type":"string"},"notifiedDate":{"format":"date-time","description":"The notified date of the deposit protection","type":"string","example":"2019-08-14T12:30:02Z"}}},"initiateDepositRelease":{"description":"A flag denoting whether or not the the deposit release has been initiated","type":"boolean"},"occupierCount":{"format":"int32","description":"The number of occupiers the tenancy has","type":"integer"},"related":{"description":"A collection of contact / company tenants associated to the tenancy. The first item in the collection is considered the primary relationship. This collection is only populated once a tenant moves into a property and the tenancy status becomes current","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"paymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with this tenant","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this roie on the system is now archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"occupyOn":{"format":"date","description":"The date the tenant moved in (or will move in) to the property","type":"string","example":"2019-08-14"},"vacateOn":{"format":"date","description":"The date the tenant vacated (or is due to vacate) the property","type":"string","example":"2019-08-14"},"isCurrent":{"description":"Flag to indicate if this is the current tenant","type":"boolean","readOnly":true},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"fromArchive":{"description":"A flag denoting whether or not this tenancy is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the tenancy","type":"object","additionalProperties":{}},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"legalStatusId":{"description":"The identifier of the legal status to set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"renewalOptions":{"description":"Representation of renewal options in a tenancy","type":"object","properties":{"optionId":{"description":"The unique identifier of the renewal option","type":"string"},"optionText":{"description":"The associated renewal option text","type":"string"},"expiry":{"format":"date","description":"The renewal option expiry date","type":"string","example":"2019-08-14"},"conditionIds":{"description":"The renewal options associated condition Ids","type":"array","items":{"type":"string"}}}},"arrears":{"description":"Representation of tenancy arrears data (populated only when Client Accounts functionality is enabled)","type":"object","properties":{"chaseArrears":{"description":"A flag determining whether or not tenancy arrears should be chased","type":"boolean"},"paymentPlan":{"description":"Indicates whether or not a payment plan is set up for a tenancy in arrears (no/yes/negotiating)","type":"string"},"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF190060","created":"2019-06-12T15:44:28Z","modified":"2020-01-26T09:24:02Z","startDate":"2019-08-01","endDate":"2020-08-01","status":"current","agentRole":"managed","rent":650,"currency":null,"rentFrequency":"monthly","endDateConfirmed":true,"isPeriodic":false,"periodicReviewDate":null,"rentInstalmentsFrequency":"quarterly","rentInstalmentsAmount":1800,"rentInstalmentsStart":"2019-08-01","meterReadingGas":"012111","meterReadingGasLastRead":"2022-02-18","meterReadingElectricity":"1000123","meterReadingElectricityLastRead":"2022-02-26","meterReadingWater":"111022","meterReadingWaterLastRead":"2022-02-21","initialInspectionFrequencyInDays":0,"regularInspectionFrequencyInDays":0,"finishedReason":null,"typeId":"AZR","isRentersRights":false,"negotiatorId":"JAS","propertyId":"OXF160871","applicantId":"OXF190121","managerId":null,"groupPaymentReference":null,"lettingFee":{"type":"percentage","amount":5,"frequency":"monthly"},"managementFee":{"type":"fixed","amount":400,"frequency":"quarterly"},"daysInArrears":7,"source":{"id":"RMV","type":"source"},"deposit":{"heldBy":"landlord","period":null,"type":null,"sum":550.5},"depositProtection":{"scheme":"RPT240001","registeredDate":"2020-08-01","deregisteredDate":"2025-01-01","registrationNumber":"RegisterNo1234","notifiedDate":"2020-08-01"},"initiateDepositRelease":false,"occupierCount":null,"related":[{"id":"OXF12300101","name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","paymentReference":null,"fromArchive":false,"marketingConsent":null,"primaryAddress":{"buildingName":null,"buildingNumber":"1","line1":"Test House","line2":"Test Lane","line3":"County of Test","line4":"Test City","postcode":"A11 2BB","countryId":"GB"},"occupyOn":"2019-08-01","vacateOn":"2020-08-01","isCurrent":false,"additionalContactDetails":null}],"fromArchive":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"feeNotes":null,"legalStatusId":null,"preTenancyCheckStatusId":null,"renewalOptions":null,"arrears":{"chaseArrears":false,"paymentPlan":null,"followUpOn":"2024-09-05","status":"Custom Status"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190060"},"documents":{"href":"/documents/?associatedType=tenancy&associatedId=OXF190060"},"tasks":{"href":"/tasks/?tenancyId=OXF190060"},"checks":{"href":"/tenancies/OXF190060/checks"},"appointments":{"href":"/appointments/?attendeeType=tenancy&attendeeId=OXF190060"},"extensions":{"href":"/tenancies/OXF190060/extensions"},"relationships":{"href":"/tenancies/OXF190060/relationships"},"type":{"href":"/configuration/tenancyTypes/AZR"},"negotiator":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF160871"},"applicant":{"href":"/applicants/OXF190121"},"source":{"href":"/sources/RMV"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new pending tenancy","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Request parameters","schema":{"description":"Request body used to create a new tenancy","required":["agentRole","rent","rentFrequency","typeId","negotiatorId","propertyId","applicantId"],"type":"object","properties":{"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging)","type":"string"},"agentRole":{"description":"The role that the agent is performing for the tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"propertyId":{"description":"The unique identifier of the property that relates to the tenancy","type":"string"},"applicantId":{"description":"The unique identifier of the applicant who has applied to be a tenant","type":"string"},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"lettingFee":{"description":"Request body used to set letting fees on a new tenancy","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to set management fees on a new tenancy","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"deposit":{"description":"Request body used to set the deposit of a new tenancy","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"arrears":{"description":"Request body used to set the arrears of a new tenancy.","type":"object","properties":{"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"source":{"description":"Request body used to set the source of a new tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the source for the tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancy","type":"object","additionalProperties":{}}},"example":{"startDate":"2020-01-01","endDate":"2021-01-01","status":"arranging","agentRole":"managed","rent":600,"rentFrequency":"monthly","rentInstalmentsFrequency":"quarterly","rentInstalmentsAmount":1800,"rentInstalmentsStart":"2019-08-01","meterReadingGas":"012111","meterReadingGasLastRead":"2022-02-18","meterReadingElectricity":"1000123","meterReadingElectricityLastRead":"2022-02-26","meterReadingWater":"111022","meterReadingWaterLastRead":"2022-02-21","isPeriodic":true,"typeId":"SL","negotiatorId":"JAS","propertyId":"OXF200497","applicantId":"OXF200012","feeNotes":null,"preTenancyCheckStatusId":null,"lettingFee":{"type":"percentage","amount":5,"frequency":"monthly"},"managementFee":{"type":"fixed","amount":400,"frequency":"quarterly"},"deposit":{"heldBy":"landlordsAgent","period":null,"type":null,"sum":675.75},"arrears":null,"source":{"id":"OXF","type":"office"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the tenancy to return","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the tenancy returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["appointments","applicant","extensions","documents","negotiator","property","source","tasks","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging/current/finished/cancelled)","type":"string"},"agentRole":{"description":"The role that the agent is performing for this tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency\r\nNote that this is the original rent set on the tenancy. For tenancies that have been extended with a rent change you MUST use the extensions endpoint","type":"number"},"currency":{"description":"The currency set against the tenancy","type":"string"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"endDateConfirmed":{"description":"A flag determining whether or not the tenancy is confirmed to finish at the end date","type":"boolean"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"periodicReviewDate":{"format":"date-time","description":"The date that the tenancy is due for a review, only applicable for periodic tenancies","type":"string","example":"2019-08-14T12:30:02Z"},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"initialInspectionFrequencyInDays":{"format":"int64","description":"One time inspection scheduled a specific number of days after the tenancy start date","type":"integer"},"regularInspectionFrequencyInDays":{"format":"int64","description":"Recurring inspections set to occur at specified intervals","type":"integer"},"finishedReason":{"description":"The reason for the tenancy finishing","type":"string"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"isRentersRights":{"description":"If the tenancy has renters' rights","type":"boolean"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"propertyId":{"description":"The unique identifier of the property that relates to the tenancy","type":"string"},"applicantId":{"description":"The unique identifier of the applicant who has applied to be a tenant. Whilst the tenancy is an in arranging state, information about the individual such as name and contact details can be obtained from GET /applicants/{id}. Use the link in the _links collection for a relative URI","type":"string"},"managerId":{"description":"The unique identifier of the negotiator assigned as the manager of the tenancy","type":"string"},"groupPaymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with all tenants in the property","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"daysInArrears":{"format":"int32","description":"The number of days rent invoices can be paid in arrears","type":"integer"},"source":{"description":"A tenancy source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the source for this tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"deposit":{"description":"A tenancy deposit model","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"depositProtection":{"description":"A tenancy deposit protection model","type":"object","properties":{"scheme":{"description":"The unique identifier of the deposit protection","type":"string"},"registeredDate":{"format":"date-time","description":"The date when deposit protection is registered","type":"string","example":"2019-08-14T12:30:02Z"},"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection","type":"string"},"notifiedDate":{"format":"date-time","description":"The notified date of the deposit protection","type":"string","example":"2019-08-14T12:30:02Z"}}},"initiateDepositRelease":{"description":"A flag denoting whether or not the the deposit release has been initiated","type":"boolean"},"occupierCount":{"format":"int32","description":"The number of occupiers the tenancy has","type":"integer"},"related":{"description":"A collection of contact / company tenants associated to the tenancy. The first item in the collection is considered the primary relationship. This collection is only populated once a tenant moves into a property and the tenancy status becomes current","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"paymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with this tenant","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this roie on the system is now archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"occupyOn":{"format":"date","description":"The date the tenant moved in (or will move in) to the property","type":"string","example":"2019-08-14"},"vacateOn":{"format":"date","description":"The date the tenant vacated (or is due to vacate) the property","type":"string","example":"2019-08-14"},"isCurrent":{"description":"Flag to indicate if this is the current tenant","type":"boolean","readOnly":true},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"fromArchive":{"description":"A flag denoting whether or not this tenancy is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the tenancy","type":"object","additionalProperties":{}},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"legalStatusId":{"description":"The identifier of the legal status to set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"renewalOptions":{"description":"Representation of renewal options in a tenancy","type":"object","properties":{"optionId":{"description":"The unique identifier of the renewal option","type":"string"},"optionText":{"description":"The associated renewal option text","type":"string"},"expiry":{"format":"date","description":"The renewal option expiry date","type":"string","example":"2019-08-14"},"conditionIds":{"description":"The renewal options associated condition Ids","type":"array","items":{"type":"string"}}}},"arrears":{"description":"Representation of tenancy arrears data (populated only when Client Accounts functionality is enabled)","type":"object","properties":{"chaseArrears":{"description":"A flag determining whether or not tenancy arrears should be chased","type":"boolean"},"paymentPlan":{"description":"Indicates whether or not a payment plan is set up for a tenancy in arrears (no/yes/negotiating)","type":"string"},"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF190060","created":"2019-06-12T15:44:28Z","modified":"2020-01-26T09:24:02Z","startDate":"2019-08-01","endDate":"2020-08-01","status":"current","agentRole":"managed","rent":650,"currency":null,"rentFrequency":"monthly","endDateConfirmed":true,"isPeriodic":false,"periodicReviewDate":null,"rentInstalmentsFrequency":"quarterly","rentInstalmentsAmount":1800,"rentInstalmentsStart":"2019-08-01","meterReadingGas":"012111","meterReadingGasLastRead":"2022-02-18","meterReadingElectricity":"1000123","meterReadingElectricityLastRead":"2022-02-26","meterReadingWater":"111022","meterReadingWaterLastRead":"2022-02-21","initialInspectionFrequencyInDays":0,"regularInspectionFrequencyInDays":0,"finishedReason":null,"typeId":"AZR","isRentersRights":false,"negotiatorId":"JAS","propertyId":"OXF160871","applicantId":"OXF190121","managerId":null,"groupPaymentReference":null,"lettingFee":{"type":"percentage","amount":5,"frequency":"monthly"},"managementFee":{"type":"fixed","amount":400,"frequency":"quarterly"},"daysInArrears":7,"source":{"id":"RMV","type":"source"},"deposit":{"heldBy":"landlord","period":null,"type":null,"sum":550.5},"depositProtection":{"scheme":"RPT240001","registeredDate":"2020-08-01","deregisteredDate":"2025-01-01","registrationNumber":"RegisterNo1234","notifiedDate":"2020-08-01"},"initiateDepositRelease":false,"occupierCount":null,"related":[{"id":"OXF12300101","name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","paymentReference":null,"fromArchive":false,"marketingConsent":null,"primaryAddress":{"buildingName":null,"buildingNumber":"1","line1":"Test House","line2":"Test Lane","line3":"County of Test","line4":"Test City","postcode":"A11 2BB","countryId":"GB"},"occupyOn":"2019-08-01","vacateOn":"2020-08-01","isCurrent":false,"additionalContactDetails":null}],"fromArchive":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"feeNotes":null,"legalStatusId":null,"preTenancyCheckStatusId":null,"renewalOptions":null,"arrears":{"chaseArrears":false,"paymentPlan":null,"followUpOn":"2024-09-05","status":"Custom Status"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190060"},"documents":{"href":"/documents/?associatedType=tenancy&associatedId=OXF190060"},"tasks":{"href":"/tasks/?tenancyId=OXF190060"},"checks":{"href":"/tenancies/OXF190060/checks"},"appointments":{"href":"/appointments/?attendeeType=tenancy&attendeeId=OXF190060"},"extensions":{"href":"/tenancies/OXF190060/extensions"},"relationships":{"href":"/tenancies/OXF190060/relationships"},"type":{"href":"/configuration/tenancyTypes/AZR"},"negotiator":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF160871"},"applicant":{"href":"/applicants/OXF190121"},"source":{"href":"/sources/RMV"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates a tenancy by unique identifier","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"The unique identifier for the tenacy to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model containing data to be used to update the tenancy.","schema":{"description":"Request body used to update an existing Tenancy","type":"object","properties":{"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging/current/finished/cancelled)","type":"string"},"agentRole":{"description":"The role that the agent is performing for the tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"endDateConfirmed":{"description":"Flag for end date confirmation","type":"boolean"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"source":{"description":"Request body used to set the source of a new tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the source for the tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"legalStatusId":{"description":"The identifier of the legal status to set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"deposit":{"description":"Request body used to set the deposit of a tenancy","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"depositProtection":{"description":"Request body used to update the deposit protection of a tenancy","type":"object","properties":{"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection scheme","type":"string"}}},"arrears":{"description":"Request body used to set the arrears of an existing tenancy.","type":"object","properties":{"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"lettingFee":{"description":"Request body used to update letting fees on an existing tenancy","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to update management fees on an existing tenancy","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancy","type":"object","additionalProperties":{}}},"example":{"startDate":"2019-08-01","endDate":"2021-08-01","status":"arranging","agentRole":"managed","rent":650,"rentFrequency":"monthly","endDateConfirmed":true,"isPeriodic":false,"typeId":"AZ","negotiatorId":"JAS","source":{"id":"RMV","type":"source"},"rentInstalmentsFrequency":"quarterly","rentInstalmentsAmount":1200,"rentInstalmentsStart":"2021-03-09","meterReadingGas":"012114","meterReadingGasLastRead":"2021-01-02","meterReadingElectricity":"1000126","meterReadingElectricityLastRead":"2021-01-02","meterReadingWater":"111025","meterReadingWaterLastRead":"2021-01-02","feeNotes":null,"legalStatusId":null,"preTenancyCheckStatusId":null,"deposit":{"heldBy":"stakeholder","period":null,"type":null,"sum":455.5},"depositProtection":{"deregisteredDate":"2025-01-01","registrationNumber":"REGNO12345678"},"arrears":{"followUpOn":"0001-01-01T00:00:00Z","status":null},"lettingFee":{"type":"percentage","amount":5,"frequency":"monthly"},"managementFee":{"type":"fixed","amount":400,"frequency":"quarterly"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/relationships":{"get":{"tags":["Tenancies"],"summary":"Retrieves the relationship details of the contacts and/or companies associated as tenants\r\n/// Retrieves the relationship details of the contacts and/or companies associated as tenants","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenant relationships to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a relationship between a tenancy and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"tenancyId":{"description":"The unique identifier of the tenancy","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this contact or company should be regarded as the main tenant","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"guarantors":{"description":"Collection of guarantors recorded for this relationship","type":"array","items":{"description":"Read model representing a Guarantor","type":"object","properties":{"id":{"description":"The identifier for the guarantor record","type":"string"},"guarantorAssociatedId":{"description":"The identifier for the contact record associated with the guarantor","type":"string"},"type":{"description":"Value indicating whether a the referenced guarantor is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference requested from the guarantor (notSet/requested/received)","type":"string"}}}},"references":{"description":"Collection of references recorded for this relationship","type":"array","items":{"description":"Read model representing a tenant/applicant reference","type":"object","properties":{"id":{"description":"The identifier for the reference record","type":"string"},"referenceAssociatedId":{"description":"The identifier for the contact/company record associated with the reference","type":"string"},"type":{"description":"Value indicating whether a referenced contact is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference (notSet/requested/received)","type":"string"},"referenceType":{"description":"The type of reference (notSet/accountant/characterReference/employer/previousLandlord)","type":"string"}}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","tenancyId":"OXF190001","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"fromArchive":false,"guarantors":[{"id":"OXF20002456","guarantorAssociatedId":"OXF2000003","type":"contact","referenceStatus":"received"}],"references":[{"id":"OXF20002457","referenceAssociatedId":"OXF2000004","type":"company","referenceStatus":"received","referenceType":"previousLandlord"}],"_links":{"self":{"href":"/tenancies/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF20002002/relationshps/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF20002002/relationshps/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF20002002/relationshps/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF20002002/relationshps/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/relationships/{relationshipId}":{"get":{"tags":["Tenancies"],"summary":"Gets a single relationship between this tenancy and a contact/company","operationId":"GetTenancyRelationshipById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"relationshipId","description":"Unique relationship identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a relationship between a tenancy and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"tenancyId":{"description":"The unique identifier of the tenancy","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this contact or company should be regarded as the main tenant","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"guarantors":{"description":"Collection of guarantors recorded for this relationship","type":"array","items":{"description":"Read model representing a Guarantor","type":"object","properties":{"id":{"description":"The identifier for the guarantor record","type":"string"},"guarantorAssociatedId":{"description":"The identifier for the contact record associated with the guarantor","type":"string"},"type":{"description":"Value indicating whether a the referenced guarantor is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference requested from the guarantor (notSet/requested/received)","type":"string"}}}},"references":{"description":"Collection of references recorded for this relationship","type":"array","items":{"description":"Read model representing a tenant/applicant reference","type":"object","properties":{"id":{"description":"The identifier for the reference record","type":"string"},"referenceAssociatedId":{"description":"The identifier for the contact/company record associated with the reference","type":"string"},"type":{"description":"Value indicating whether a referenced contact is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference (notSet/requested/received)","type":"string"},"referenceType":{"description":"The type of reference (notSet/accountant/characterReference/employer/previousLandlord)","type":"string"}}}}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","tenancyId":"OXF190001","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"fromArchive":false,"guarantors":[{"id":"OXF20002456","guarantorAssociatedId":"OXF2000003","type":"contact","referenceStatus":"received"}],"references":[{"id":"OXF20002457","referenceAssociatedId":"OXF2000004","type":"company","referenceStatus":"received","referenceType":"previousLandlord"}],"_links":{"self":{"href":"/tenancies/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/checks":{"get":{"tags":["Tenancies"],"summary":"Retrieves the pre and post tenancy checks associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"type","description":"Only return checks with this `type` (preTenancy/postTenancy)","type":"string"},{"in":"query","name":"status","description":"Only return checks where the status field matches one or more values provided ","type":"array","items":{"enum":["needed","notNeeded","arranged","completed"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy check - a process that needs to happen before a tenancy can commence or ends","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the tenancy check relates to","type":"string"},"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the tenancy check (preTenancy/postTenancy)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","description":"Tenant welcome pack","status":"needed","type":"preTenancy","checkTypeId":null,"tenancyId":"OXF190001","metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/checks/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"documents":{"href":"/documents/?associatedType=tenancyCheck&associatedId=OXF20002002"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/checks/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/checks/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/checks/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/checks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new tenancy check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a tenancy check","schema":{"description":"Request body used to create a new tenancy check","required":["type","status"],"type":"object","properties":{"description":{"description":"Short, descriptive text describing the purpose of the check. This should be populated\r\nwhen creating a custom tenancy check that does not match any of the existing pre-configured\r\ntenancy check options.\r\nDescription and CheckTypeId must not be supplied in the same payload, but at least one must be provided","type":"string"},"type":{"description":"The type of the tenancy check (preTenancy/postTenancy)","type":"string"},"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This should be populated\r\nwhen an existing tenancy check configuration is desired, rather than a custom one\r\nCheckTypeId and Description must not be supplied in the same payload, but at least one must be provided","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy check","type":"object","additionalProperties":{}}},"example":{"description":"Tenant welcome pack","type":"preTenancy","status":"needed","checkTypeId":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/checks/{checkId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific tenancy check","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique tenancy check identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a tenancy check - a process that needs to happen before a tenancy can commence or ends","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the tenancy check relates to","type":"string"},"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the tenancy check (preTenancy/postTenancy)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","description":"Tenant welcome pack","status":"needed","type":"preTenancy","checkTypeId":null,"tenancyId":"OXF190001","metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/checks/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"documents":{"href":"/documents/?associatedType=tenancyCheck&associatedId=OXF20002002"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing tenancy check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the tenancy that owns the tenancy check","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique identifier of the tenancy check to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Model for updat of an existing tenancy check","type":"object","properties":{"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy check","type":"object","additionalProperties":{}}},"example":{"status":"needed","metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Tenancies"],"summary":"Deletes an existing tenancy check","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the tenancy that owns the tenancy check","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique identifier of the tenancy check to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/breakClauses":{"get":{"tags":["Tenancies"],"summary":"Retrieves the break clauses associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy break clause","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the break clause","type":"string"},"created":{"format":"date-time","description":"The date and time when the break clause was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the break clause last modified","type":"string","example":"2019-08-14T12:30:02Z"},"clauseTypeId":{"description":"The identifier of the associated break clause","type":"string"},"description":{"description":"The break clauses description","type":"string"},"active":{"format":"date","description":"The date the break clause became (or becomes) active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The parties that the break clause applies to (landlord/tenant/mutual)","type":"string"},"letterText":{"description":"Tenancy agreement text relating to the break clause","type":"string"},"breakFrom":{"description":"Representation of a tenancy break clauses break from details","type":"object","properties":{"date":{"format":"date-time","description":"The earliest date at which the tenant/landlord can end the tenancy agreement","type":"string","example":"2019-08-14T12:30:02Z"},"minTermMonths":{"format":"int32","description":"The minimum number of months from the break clause agreement becoming active at which the tenant/landlord can end the tenancy agreement","type":"integer"}}},"noticeRequired":{"description":"Representation of a tenancy break clauses notice requirements","type":"object","properties":{"date":{"format":"date-time","description":"The latest date at which the tenant/landlord must give notice of their decision to end the agreement","type":"string","example":"2019-08-14T12:30:02Z"},"beforeBreakMonths":{"format":"int32","description":"The minimum number of months before the break clause can be invoked at which the tenant/landlord must give notice of their decision to end the tenancy agreement","type":"integer"}}},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the break clause. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","clauseTypeId":"BC01","description":"Landlord must pay council tax.","active":"2022-01-31","appliesTo":"landlord","letterText":null,"breakFrom":null,"noticeRequired":null,"agreements":{"landlord":true,"tenant":false},"tenancyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/breakClauses/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"clauseType":{"href":"/configuration/tenancyBreakClauses/BC01"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/breakClauses/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/breakClauses/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/breakClauses/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/breakClauses/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new break clause","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a break clause","schema":{"description":"Request body used to update tenancy break clause","type":"object","properties":{"typeId":{"description":"The identifier of the associated to the break clause","type":"string"},"active":{"format":"date","description":"The date the break clause becomes/became active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The responsible party (landlord/tenant/mutual)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"breakFrom":{"description":"Request body used to set a break clauses break from details","type":"object","properties":{"date":{"format":"date","description":"The date the break from clause can be used","type":"string","example":"2019-08-14"},"minTermMonths":{"format":"int32","description":"The minimum number of months until the break clause can be used","type":"integer"}}},"noticeRequired":{"description":"Request body used to set a break clauses notice required details","type":"object","properties":{"date":{"format":"date","description":"The date a break clauses notice is required by","type":"string","example":"2019-08-14"},"beforeBreakMonths":{"format":"int32","description":"The number of months the notice is required before the break clause","type":"integer"}}}},"example":{"typeId":"BK001","active":"2022-01-31","appliesTo":"landlord","agreements":{"landlord":true,"tenant":false},"breakFrom":null,"noticeRequired":null}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/breakClauses/{clauseId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific break clause","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"clauseId","description":"Unique break clause identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a tenancy break clause","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the break clause","type":"string"},"created":{"format":"date-time","description":"The date and time when the break clause was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the break clause last modified","type":"string","example":"2019-08-14T12:30:02Z"},"clauseTypeId":{"description":"The identifier of the associated break clause","type":"string"},"description":{"description":"The break clauses description","type":"string"},"active":{"format":"date","description":"The date the break clause became (or becomes) active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The parties that the break clause applies to (landlord/tenant/mutual)","type":"string"},"letterText":{"description":"Tenancy agreement text relating to the break clause","type":"string"},"breakFrom":{"description":"Representation of a tenancy break clauses break from details","type":"object","properties":{"date":{"format":"date-time","description":"The earliest date at which the tenant/landlord can end the tenancy agreement","type":"string","example":"2019-08-14T12:30:02Z"},"minTermMonths":{"format":"int32","description":"The minimum number of months from the break clause agreement becoming active at which the tenant/landlord can end the tenancy agreement","type":"integer"}}},"noticeRequired":{"description":"Representation of a tenancy break clauses notice requirements","type":"object","properties":{"date":{"format":"date-time","description":"The latest date at which the tenant/landlord must give notice of their decision to end the agreement","type":"string","example":"2019-08-14T12:30:02Z"},"beforeBreakMonths":{"format":"int32","description":"The minimum number of months before the break clause can be invoked at which the tenant/landlord must give notice of their decision to end the tenancy agreement","type":"integer"}}},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the break clause. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","clauseTypeId":"BC01","description":"Landlord must pay council tax.","active":"2022-01-31","appliesTo":"landlord","letterText":null,"breakFrom":null,"noticeRequired":null,"agreements":{"landlord":true,"tenant":false},"tenancyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/breakClauses/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"clauseType":{"href":"/configuration/tenancyBreakClauses/BC01"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing break clause","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the tenancy that relates to the break clause","required":true,"type":"string"},{"in":"path","name":"clauseId","description":"Unique identifier of the break clause to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update tenancy break clause","type":"object","properties":{"active":{"format":"date","description":"The date the break clause becomes/became active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The responsible party (landlord/tenant/mutual)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"breakFrom":{"description":"Request body used to set a break clauses break from details","type":"object","properties":{"date":{"format":"date","description":"The date the break from clause can be used","type":"string","example":"2019-08-14"},"minTermMonths":{"format":"int32","description":"The minimum number of months until the break clause can be used","type":"integer"}}},"noticeRequired":{"description":"Request body used to set a break clauses notice required details","type":"object","properties":{"date":{"format":"date","description":"The date a break clauses notice is required by","type":"string","example":"2019-08-14"},"beforeBreakMonths":{"format":"int32","description":"The number of months the notice is required before the break clause","type":"integer"}}}},"example":{"active":"2022-04-10","appliesTo":"tenant","agreements":{"landlord":false,"tenant":true},"breakFrom":null,"noticeRequired":null}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Tenancies"],"summary":"Deletes an existing break clause","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the tenancy related to the break clause","required":true,"type":"string"},{"in":"path","name":"clauseId","description":"Unique identifier of the break clause to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/allowances":{"get":{"tags":["Tenancies"],"summary":"Retrieves the allowances associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy allowance","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the allowance","type":"string"},"created":{"format":"date-time","description":"The date and time when the allowance was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the allowance last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated allowance","type":"string"},"description":{"description":"The break clauses description","type":"string"},"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the allowance","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the allowance. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","typeId":"AL01","description":"Visitors to stay over.","state":"allowed","agreements":{"landlord":true,"tenant":false},"letterText":null,"tenancyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/allowances/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"allowanceType":{"href":"/configuration/allowances/AL01"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/allowances/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/allowances/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/allowances/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/allowances/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new allowance","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a allowance","schema":{"description":"Request body used to set a tenancy allowance","type":"object","properties":{"typeId":{"description":"The identifier of the associated to the allowance","type":"string"},"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"typeId":"ALL001","state":"allowed","agreements":{"landlord":true,"tenant":false}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/allowances/{allowanceId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific allowance","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"allowanceId","description":"Unique allowance identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a tenancy allowance","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the allowance","type":"string"},"created":{"format":"date-time","description":"The date and time when the allowance was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the allowance last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated allowance","type":"string"},"description":{"description":"The break clauses description","type":"string"},"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the allowance","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the allowance. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","typeId":"AL01","description":"Visitors to stay over.","state":"allowed","agreements":{"landlord":true,"tenant":false},"letterText":null,"tenancyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/allowances/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"allowanceType":{"href":"/configuration/allowances/AL01"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing allowance","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the tenancy that relates to the allowance","required":true,"type":"string"},{"in":"path","name":"allowanceId","description":"Unique identifier of the allowance to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update tenancy allowance","type":"object","properties":{"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"state":"notAllowed","agreements":{"landlord":false,"tenant":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Tenancies"],"summary":"Deletes an existing allowance","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the tenancy related to the allowance","required":true,"type":"string"},{"in":"path","name":"allowanceId","description":"Unique identifier of the allowance to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/responsibilities":{"get":{"tags":["Tenancies"],"summary":"Retrieves the responsibilities associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancies responsibility","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the responsibility","type":"string"},"created":{"format":"date-time","description":"The date and time when the responsibility was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the responsibility last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated to the responsibility","type":"string"},"description":{"description":"The responsibilities description","type":"string"},"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the responsibility","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the responsibility. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","typeId":"RES001","description":"White goods must be serviced.","appliesTo":"tenant","agreements":{"landlord":false,"tenant":true},"letterText":null,"tenancyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/responsibilities/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"responsibilityType":{"href":"/configuration/tenancyResponsibilities/RES001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/responsibilities/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/responsibilities/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/responsibilities/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/responsibilities/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new responsibility","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a responsibility","schema":{"description":"Request body used to set a tenancy responsibility","type":"object","properties":{"typeId":{"description":"The identifier of the associated to the responsibility","type":"string"},"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"typeId":"RES1","appliesTo":"landlord","agreements":{"landlord":true,"tenant":false}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/responsibilities/{responsibilityId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific responsibility","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"responsibilityId","description":"Unique responsibility identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a tenancies responsibility","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the responsibility","type":"string"},"created":{"format":"date-time","description":"The date and time when the responsibility was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the responsibility last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated to the responsibility","type":"string"},"description":{"description":"The responsibilities description","type":"string"},"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the responsibility","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the responsibility. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","typeId":"RES001","description":"White goods must be serviced.","appliesTo":"tenant","agreements":{"landlord":false,"tenant":true},"letterText":null,"tenancyId":"OXF190001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/responsibilities/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"responsibilityType":{"href":"/configuration/tenancyResponsibilities/RES001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing responsibility","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the tenancy that owns the responsibility","required":true,"type":"string"},{"in":"path","name":"responsibilityId","description":"Unique identifier of the responsibility to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update tenancy responsibility","type":"object","properties":{"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"appliesTo":"tenant","agreements":{"landlord":false,"tenant":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Tenancies"],"summary":"Deletes an existing responsibility","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the tenancy that owns the responsibility","required":true,"type":"string"},{"in":"path","name":"responsibilityId","description":"Unique identifier of the responsibility to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/renewalNegotiations":{"get":{"tags":["Tenancies"],"summary":"Retrieves the renewal negotiations associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a tenancies renewal negotiation","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the renewal negotiation","type":"string"},"created":{"format":"date-time","description":"The date and time when the renewal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the renewal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","type":"string","example":"2019-08-14"},"endDate":{"format":"date","type":"string","example":"2019-08-14"},"status":{"description":"The status of the renewal (notStarted/started/negotiating/renewed/tenantTerminated/landlordTerminated/periodic)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the renewal","type":"string"},"rent":{"format":"double","description":"The tenancies rent amount","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/4weeks/annually)","type":"string"},"rentChange":{"description":"Represents rent changes in a tenancies renewal","type":"object","properties":{"amount":{"format":"double","description":"The amount the rent has changed in the renewal","type":"number"},"percentage":{"format":"double","description":"The percentage the rent has changed in the renewal","type":"number"}}},"tenancyId":{"description":"The unique identifier of the tenancy associated to the renewal","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy renewal. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","startDate":"2021-02-25","endDate":"2021-03-25","status":"notStarted","negotiatorId":"ADV","rent":250,"rentFrequency":"weekly","rentChange":{"amount":50,"percentage":25},"tenancyId":"OXF190001","lettingFee":{"type":"fixed","amount":200,"frequency":"monthly"},"managementFee":{"type":"percentage","amount":15,"frequency":"monthly"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"negotiator":{"href":"/negotiators/ADV"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new renewal negotiation","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a renewal negotiation","schema":{"description":"Request body used to create a tenancy renewal negotiation","type":"object","properties":{"startDate":{"format":"date-time","description":"The proposed start date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The proposed end date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing this tenancy renewal","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"lettingFee":{"description":"Request body used to create a tenancy renewals letting fee","type":"object","properties":{"type":{"description":"The letting fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The letting fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the letting fee is required (monthly/quarterly/halfYearly/yearly/28days/upfront/upfrontOver2Months/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to create a tenancy renewals management fee","type":"object","properties":{"type":{"description":"The mangement fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The mangement fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the mangement fee is required (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}}},"example":{"startDate":"2021-02-25","endDate":"2021-03-25","negotiatorId":"ADV","rent":250,"rentFrequency":"weekly","lettingFee":{"type":"fixed","amount":200,"frequency":"monthly"},"managementFee":{"type":"percentage","amount":15,"frequency":"monthly"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/renewalNegotiations/{renewalId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific renewal negotiaton","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"renewalId","description":"Unique renewal identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a tenancies renewal negotiation","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the renewal negotiation","type":"string"},"created":{"format":"date-time","description":"The date and time when the renewal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the renewal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","type":"string","example":"2019-08-14"},"endDate":{"format":"date","type":"string","example":"2019-08-14"},"status":{"description":"The status of the renewal (notStarted/started/negotiating/renewed/tenantTerminated/landlordTerminated/periodic)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the renewal","type":"string"},"rent":{"format":"double","description":"The tenancies rent amount","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/4weeks/annually)","type":"string"},"rentChange":{"description":"Represents rent changes in a tenancies renewal","type":"object","properties":{"amount":{"format":"double","description":"The amount the rent has changed in the renewal","type":"number"},"percentage":{"format":"double","description":"The percentage the rent has changed in the renewal","type":"number"}}},"tenancyId":{"description":"The unique identifier of the tenancy associated to the renewal","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy renewal. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","startDate":"2021-02-25","endDate":"2021-03-25","status":"notStarted","negotiatorId":"ADV","rent":250,"rentFrequency":"weekly","rentChange":{"amount":50,"percentage":25},"tenancyId":"OXF190001","lettingFee":{"type":"fixed","amount":200,"frequency":"monthly"},"managementFee":{"type":"percentage","amount":15,"frequency":"monthly"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"},"negotiator":{"href":"/negotiators/ADV"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/renewalNegotiations/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing renewal negotiation","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the tenancy that relates to the renewal","required":true,"type":"string"},{"in":"path","name":"renewalId","description":"Unique identifier of the renewal negotiation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update a tenancy renewal negotiation","type":"object","properties":{"startDate":{"format":"date-time","description":"The proposed start date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The proposed end date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing this tenancy renewal","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"lettingFee":{"description":"Request body used to update a tenancy renewals letting fee","type":"object","properties":{"type":{"description":"The letting fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The letting fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the letting fee is required (monthly/quarterly/halfYearly/yearly/28days/upfront/upfrontOver2Months/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to update a tenancy renewals management fee","type":"object","properties":{"type":{"description":"The mangement fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The mangement fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the mangement fee is required (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}}},"example":{"startDate":"2021-02-25","endDate":"2021-03-25","negotiatorId":"ADV","rent":250,"rentFrequency":"weekly","lettingFee":{"type":"fixed","amount":200,"frequency":"monthly"},"managementFee":{"type":"percentage","amount":15,"frequency":"monthly"}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/extensions":{"get":{"tags":["Tenancies"],"summary":"Retrieves the extensions and/or alterations associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy extensions or alterations to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a tenancy extension or alteration","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the extension or alteration","type":"string"},"created":{"format":"date-time","description":"The date and time when the extension or alteration was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the extension or alteration was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the extension or alteration","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the extension (alterations do not have an end date)","type":"string","example":"2019-08-14"},"type":{"description":"The type of entry (extension|alteration)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the extension or alteration","type":"string"},"rent":{"format":"double","description":"The extension or alteration rent amount","type":"number"},"rentFrequency":{"description":"The rent frequency (weekly/monthly/4weeks/annually)","type":"string"},"payable":{"description":"The frequency of instalments payable on or after the alteration date","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy associated to the extension or alteration","type":"string"},"fee":{"description":"Represents a one off fee associated with tenancy extension or alteration","type":"object","properties":{"amount":{"format":"double","description":"The one fee amount","type":"number"},"summary":{"description":"The one of fee summary text","type":"string"},"type":{"description":"The fee type","type":"string"}}},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy extension or alteration. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/extensions/{extensionId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific tenancy extension or alteration","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"extensionId","description":"Unique extension or alteration identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a tenancy extension or alteration","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the extension or alteration","type":"string"},"created":{"format":"date-time","description":"The date and time when the extension or alteration was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the extension or alteration was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the extension or alteration","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the extension (alterations do not have an end date)","type":"string","example":"2019-08-14"},"type":{"description":"The type of entry (extension|alteration)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the extension or alteration","type":"string"},"rent":{"format":"double","description":"The extension or alteration rent amount","type":"number"},"rentFrequency":{"description":"The rent frequency (weekly/monthly/4weeks/annually)","type":"string"},"payable":{"description":"The frequency of instalments payable on or after the alteration date","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy associated to the extension or alteration","type":"string"},"fee":{"description":"Represents a one off fee associated with tenancy extension or alteration","type":"object","properties":{"amount":{"format":"double","description":"The one fee amount","type":"number"},"summary":{"description":"The one of fee summary text","type":"string"},"type":{"description":"The fee type","type":"string"}}},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy extension or alteration. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/renewalNegotiations/{renewalId}/checks":{"get":{"tags":["Tenancies"],"summary":"Retrieves the renewal negotiation checks associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"renewalId","description":"Unique tenancy renewal identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy renewal check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy renewal check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy renewal check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy renewal check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The status of the tenancy renewal check (needed/notNeeded/arranging/completed)","type":"string"},"description":{"description":"Textual description of what the tenancy renewal check relates to","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"renewalId":{"description":"The unique identifier of the renewal that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy renewal check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","status":"needed","description":null,"checkTypeId":"RC123","tenancyId":"OXF190001","renewalId":"OXF190002","metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"tenancy":{"href":"/tenancies/OXF190001"},"renewal":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002"},"self":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002/checks/OXF20002002"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002/checks/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002/checks/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002/checks/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002/checks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new renewal negotiation check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"renewalId","description":"Unique renewal identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a renewal check","schema":{"description":"Request body used to create a new tenancy renewal check","required":["status"],"type":"object","properties":{"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"description":{"description":"The name of this tenancy check","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy renewal check","type":"object","additionalProperties":{}}},"example":{"status":"needed","checkTypeId":"RC123","description":null,"metadata":{}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/renewalNegotiations/{renewalId}/checks/{checkId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific renewal negotiaton check","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"renewalId","description":"Unique renewal identifier","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique check identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a tenancy renewal check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy renewal check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy renewal check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy renewal check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The status of the tenancy renewal check (needed/notNeeded/arranging/completed)","type":"string"},"description":{"description":"Textual description of what the tenancy renewal check relates to","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"renewalId":{"description":"The unique identifier of the renewal that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy renewal check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","status":"needed","description":null,"checkTypeId":"RC123","tenancyId":"OXF190001","renewalId":"OXF190002","metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"tenancy":{"href":"/tenancies/OXF190001"},"renewal":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002"},"self":{"href":"/tenancies/OXF190001/renewalNegotiations/OXF190002/checks/OXF20002002"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing renewal negotiation check","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the tenancy that relates to the renewal check","required":true,"type":"string"},{"in":"path","name":"renewalId","description":"Unique identifier of the renewal negotiation related to the check","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique identifier of the renewal negotiation check to update","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update a tenancy renewal check","type":"object","properties":{"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy renewal check","type":"object","additionalProperties":{}}},"example":{"status":"notNeeded","metadata":{}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Tenancies"],"summary":"Deletes an existing renewal negotiation check","produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the tenancy that relates to the renewal","required":true,"type":"string"},{"in":"path","name":"renewalId","description":"Unique identifier of the renewal negotiation related to the check to delete","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique identifier of the renewal negotiation check to delete","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/rentReviews":{"get":{"tags":["Tenancies"],"summary":"Retrieves the rent reviews associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a rent review for a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordRecievedDate":{"format":"date","description":"The date the rent review was recieved by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantRecievedDate":{"format":"date","description":"The date the rent review was recieved by the tenant","type":"string","example":"2019-08-14"},"tenancyId":{"description":"The unique identifier of the tenancy this rent review relates to","type":"string"},"terms":{"description":"Represents the rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Represents the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Represents the proposal of the rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Represents the rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the rent review","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the rent review. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","landlordSentDate":"2025-02-10","landlordRecievedDate":"2025-02-15","tenantSentDate":"2025-03-03","tenantRecievedDate":"2025-03-05","tenancyId":"OXF190001","terms":{"proposedOn":"2025-04-01","proposedStart":"2025-05-01","effectiveDate":"2025-06-01","landlordAgreed":true,"tenantAgreed":false,"agreedRent":{"amount":1350,"frequency":"monthly"},"proposedRent":{"amount":1400,"frequency":"monthly"}},"agreement":{"negotiatorId":"JAS","status":"started"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/rentReviews/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/rentReviews/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/rentReviews/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/rentReviews/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/rentReviews/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a new rent review","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to create a rent review","schema":{"description":"Request body used to create a new rent review for a tenancy","type":"object","properties":{"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordReceivedDate":{"format":"date","description":"The date the rent review was received by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantReceivedDate":{"format":"date","description":"The date the rent review was received by the tenant","type":"string","example":"2019-08-14"},"terms":{"description":"Request body used to create a new rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Request body used to create the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Request body used to create the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Request body used to create rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancies rent review","type":"object","additionalProperties":{}}},"example":{"landlordSentDate":"2023-01-01","landlordReceivedDate":"2023-01-15","tenantSentDate":"2023-02-01","tenantReceivedDate":"2023-02-15","terms":{"proposedOn":"2023-03-01","proposedStart":"2023-04-01","effectiveDate":"2023-05-01","landlordAgreed":true,"tenantAgreed":false,"agreedRent":{"amount":1350,"frequency":"monthly"},"proposedRent":{"amount":1400,"frequency":"monthly"}},"agreement":{"negotiatorId":"JAS","status":"started"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/rentReviews/{rentReviewId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves as specific rent review associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"rentReviewId","description":"Unique identifer of a rent review","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Represents a rent review for a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordRecievedDate":{"format":"date","description":"The date the rent review was recieved by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantRecievedDate":{"format":"date","description":"The date the rent review was recieved by the tenant","type":"string","example":"2019-08-14"},"tenancyId":{"description":"The unique identifier of the tenancy this rent review relates to","type":"string"},"terms":{"description":"Represents the rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Represents the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Represents the proposal of the rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Represents the rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the rent review","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the rent review. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","landlordSentDate":"2025-02-10","landlordRecievedDate":"2025-02-15","tenantSentDate":"2025-03-03","tenantRecievedDate":"2025-03-05","tenancyId":"OXF190001","terms":{"proposedOn":"2025-04-01","proposedStart":"2025-05-01","effectiveDate":"2025-06-01","landlordAgreed":true,"tenantAgreed":false,"agreedRent":{"amount":1350,"frequency":"monthly"},"proposedRent":{"amount":1400,"frequency":"monthly"}},"agreement":{"negotiatorId":"JAS","status":"started"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/rentReviews/OXF20002002"},"tenancy":{"href":"/tenancies/OXF190001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing tenancy rent review","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"rentReviewId","description":"Unique rent review identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to update a rent review","schema":{"description":"Request body used to update an existing rent review for a tenancy","type":"object","properties":{"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordReceivedDate":{"format":"date","description":"The date the rent review was received by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantReceivedDate":{"format":"date","description":"The date the rent review was received by the tenant","type":"string","example":"2019-08-14"},"terms":{"description":"Request body used to update an existing rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Request body used to update the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Request body used to update the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Request body used to update the agreement section for a rent review","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancies rent review","type":"object","additionalProperties":{}}},"example":{"landlordSentDate":"2024-01-01","landlordReceivedDate":"2024-01-15","tenantSentDate":"2024-02-01","tenantReceivedDate":"2024-02-15","terms":{"proposedOn":"2024-03-01","proposedStart":"2024-04-01","effectiveDate":"2024-05-01","landlordAgreed":true,"tenantAgreed":true,"agreedRent":{"amount":1450,"frequency":"monthly"},"proposedRent":{"amount":1500,"frequency":"monthly"}},"agreement":{"negotiatorId":"JAS","status":"inNegotiation"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/rentReviews/{rentReviewId}/checks":{"get":{"tags":["Tenancies"],"summary":"Retrieves checks associated to a rent review","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"rentReviewId","description":"Unique rent review identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of tenancy checks to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a rent reviews check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review check","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the rent review check relates to","type":"string"},"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured rent review check. This will only be populated\r\nfor pre-configured rent review checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"rentReviewId":{"description":"The unique identifier of the rent review that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","description":"Rent Review Check 1","status":"needed","checkTypeId":"RRC1","tenancyId":"OXF190001","rentReviewId":"OXF210001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/rentReviews/OXF210001/checks/OXF20002002"},"rentReview":{"href":"/tenancies/OXF190001/rentReviews/OXF210001"},"tenancy":{"href":"/tenancies/OXF190001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/tenancies/OXF190001/rentReviews/OXF210001/checks/?PageNumber=1&PageSize=1"},"first":{"href":"/tenancies/OXF190001/rentReviews/OXF210001/checks/?PageNumber=1&PageSize=1"},"next":{"href":"/tenancies/OXF190001/rentReviews/OXF210001/checks/?PageNumber=2&PageSize=1"},"last":{"href":"/tenancies/OXF190001/rentReviews/OXF210001/checks/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["Tenancies"],"summary":"Creates a rent review check associated to a tenancy","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"rentReviewId","description":"Unique rent review identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The request payload to create a rent review check","schema":{"description":"Request body used to create a new rent review check","required":["status"],"type":"object","properties":{"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured rent review check. This will only be populated\r\nfor pre-configured rent review checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"}},"example":{"status":"needed","checkTypeId":"RR123"}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/rentReviews/{rentReviewId}/checks/{checkId}":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific check associated to a rent review","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"rentReviewId","description":"Unique rent review identifier","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique check identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a rent reviews check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review check","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the rent review check relates to","type":"string"},"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured rent review check. This will only be populated\r\nfor pre-configured rent review checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"rentReviewId":{"description":"The unique identifier of the rent review that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF20002002","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","description":"Rent Review Check 1","status":"needed","checkTypeId":"RRC1","tenancyId":"OXF190001","rentReviewId":"OXF210001","_eTag":null,"_links":{"self":{"href":"/tenancies/OXF190001/rentReviews/OXF210001/checks/OXF20002002"},"rentReview":{"href":"/tenancies/OXF190001/rentReviews/OXF210001"},"tenancy":{"href":"/tenancies/OXF190001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates a rent review check associated to a tenancy","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"rentReviewId","description":"Unique rent review identifier","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique check identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The request payload to update a rent review check","schema":{"description":"Request body used to update a rent review check","required":["status"],"type":"object","properties":{"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"}},"example":{"status":"completed"}}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Tenancies"],"summary":"Deletes a rent review check associated to a tenancy","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"path","name":"rentReviewId","description":"Unique rent review identifier","required":true,"type":"string"},{"in":"path","name":"checkId","description":"Unique check identifier","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/tenancies/{id}/noticeManagement":{"get":{"tags":["Tenancies"],"summary":"Retrieves a specific notice management record","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Represents a tenancy notice management record","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy record","type":"string"},"created":{"format":"date-time","description":"The date and time when the record was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the record was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"tenancyId":{"description":"The unique identifier of the tenancy","type":"string"},"agreedEndDate":{"format":"date","description":"The agreed tenancy end date","type":"string","example":"2019-08-14"},"tenantNotice":{"description":"Represents a notice tenant within notice management","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToLandlord":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"landlordNotice":{"description":"Represents a notice landlord within notice management","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToTenant":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"_eTag":{"description":"The ETag for the current version of the tenancy record. Used for managing update concurrency","type":"string","readOnly":true}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Tenancies"],"summary":"Updates an existing notice management record","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique tenancy identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"The payload required to update a notice management record","schema":{"description":"The payload required to update a tenancy notice management record","type":"object","properties":{"tenantNotice":{"description":"The payload required to update a notice tenant","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToLandlord":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"landlordNotice":{"description":"The payload required to update a notice landlord","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToTenant":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/transactions/":{"get":{"tags":["Transactions"],"summary":"Retrieves a collection of transactions","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of transactions to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"id","description":"Only return transactions where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return transactions where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"landlordId","description":"Only return transactions where the `landlordId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"tenancyId","description":"Only return transactions where the `tenancyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"status","description":"Only return transactions where the `status` field matches one or more values provided ","type":"array","items":{"enum":["awaitingAuthorisation","awaitingPosting","posted","rejected"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"type","description":"Only return transactions where the `type` field matches one or more values provided ","type":"array","items":{"enum":["creditAdjustment","creditNoteCorrection","creditNoteGoodwillPayment","creditNoteRefund","creditNoteRepayment","creditNoteWriteOff","debitAdjustment","deposit","float","invoice","journal","openingBalanceDr","openingBalancingCr","payment","reserveFunds","transfer"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"ledger","description":"Only return transactions where the `ledger` field matches one or more values provided ","type":"array","items":{"enum":["landlord","tenant","vendor"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"category","description":"Only return transactions where the `category` field matches one or more values provided ","type":"array","items":{"enum":["advertisingCharge","accountTransfer","bankCharges","buyerAdminFee","buyerDeposit","buyerPayment","deposit","depositDeduction","depositRefund","depositTransfer","depositTransferToAgent","depositTransferToLandlord","depositTransferToScheme","estateServiceCharge","estateWorksOrder","estateUnitWorksOrder","externalCredit","externalAgentFee","freeholderPayment","float","groundRent","goodwillPayment","holdingDeposit","introducingTenantFee","landlordAdminFee","landlordTax","landlordPayment","landlordToSupplierPayment","landlordWorksOrder","leaseholderAdminFee","leaseholderPayment","leaseholderRepayment","leaseholderWorksOrder","lettingFee","managementFee","paymentSurcharge","receipt","rent","rentGuarantee","rentInsurance","recoveryPayment","reserveFund","tenantAdminFee","tenantPayment","tenantToLandlordPayment","tenantToSupplierPayment","trustAccountingInvoice","tenantWorksOrder","vacantManagementFee","vendorAdminFee","vendorCommission","vendorPayment","vendorToSupplierPayment","worksOrderPayment"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"createdFrom","description":"Only return transactions where the `created` field is after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return transactions where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return transactions where the `modified` field is after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return transactions where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"outstandingFrom","description":"Only return transactions where the `outstanding` field is the same or greater than the value provided","type":"number","format":"double"},{"in":"query","name":"outstandingTo","description":"Only return transactions where the `outstanding` field is the same or less than the value provided","type":"number","format":"double"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing a transaction","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the transaction","type":"string"},"created":{"format":"date-time","description":"The date and time when the transaction was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the transaction was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The transaction category (advertisingCharge,accountTransfer,bankCharges,buyerAdminFee,buyerDeposit,buyerPayment,deposit,depositDeduction,depositRefund,depositTransfer,depositTransferToAgent,depositTransferToLandlord,depositTransferToScheme,estateServiceCharge,estateWorksOrder,estateUnitWorksOrder,externalCredit,externalAgentFee,freeholderPayment,float,groundRent,goodwillPayment,holdingDeposit,introducingTenantFee,landlordAdminFee,landlordTax,landlordPayment,landlordToSupplierPayment,landlordWorksOrder,leaseholderAdminFee,leaseholderPayment,leaseholderRepayment,leaseholderWorksOrder,lettingFee,managementFee,paymentSurcharge,receipt,rent,rentGuarantee,recoveryPayment,reserveFund,tenantAdminFee,tenantPayment,tenantToLandlordPayment,tenantToSupplierPayment,trustAccountingInvoice,tenantWorksOrder,vacantManagementFee,vendorAdminFee,vendorCommission,vendorPayment,vendorToSupplierPayment,worksOrderPayment)","type":"string"},"type":{"description":"The transaction type (bankersDraft,bankTransfer,cash,cheque,creditCard,debitCard,directDebit,housingBenefit,paymentRequest,standingOrder)","type":"string"},"transactionType":{"description":"The type of transaction (credit/debit)","type":"string"},"description":{"description":"The transaction description","type":"string"},"status":{"description":"The status of the transaction (awaitingAuthorisation/awaitingPosting/posted/rejected)","type":"string"},"ledger":{"description":"The ledger the transaction is recorded in","type":"string"},"netAmount":{"format":"double","description":"The transaction net amount","type":"number"},"taxAmount":{"format":"double","description":"The transaction tax amount","type":"number"},"grossAmount":{"format":"double","description":"The transaction gross amount","type":"number"},"outstanding":{"format":"double","description":"The amount outstanding that remains to be paid","type":"number"},"companyId":{"description":"The unique identifier of the company the transaction is associated with, where applicable","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the transaction is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the transaction is associated with, where applicable","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the transaction is associated with, where applicable","type":"string"},"worksOrderId":{"description":"The unique identifier of the workds order the transaction is associated with, where applicable","type":"string"},"rejectReason":{"description":"The reason for rejection of an invoice","type":"string"},"_eTag":{"description":"The ETag for the current version of the transaction. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"PAY20000001","created":"2020-12-28T12:30:23Z","modified":"2021-01-02T10:28:34Z","category":"tenantPayment","type":"invoice","transactionType":"credit","description":"Tenancy Payment for 01/01/2021 to 31/01/2021","status":"awaitingPosting","ledger":"tenant","netAmount":100,"taxAmount":20,"grossAmount":120,"outstanding":60,"companyId":null,"landlordId":null,"propertyId":"PRP210001","tenancyId":"TEN210001","worksOrderId":null,"rejectReason":null,"_eTag":null,"_links":{"self":{"href":"/transactions/PAY20000001"},"property":{"href":"/properties/PRP210001"},"tenancy":{"href":"/tenancies/TEN210001"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/transactions/?PageNumber=1&PageSize=1"},"first":{"href":"/transactions/?PageNumber=1&PageSize=1"},"next":{"href":"/transactions/?PageNumber=2&PageSize=1"},"last":{"href":"/transactions/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/transactions/{id}":{"get":{"tags":["Transactions"],"summary":"Retrieves a specific transaction","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the transaction to return","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Model representing a transaction","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the transaction","type":"string"},"created":{"format":"date-time","description":"The date and time when the transaction was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the transaction was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The transaction category (advertisingCharge,accountTransfer,bankCharges,buyerAdminFee,buyerDeposit,buyerPayment,deposit,depositDeduction,depositRefund,depositTransfer,depositTransferToAgent,depositTransferToLandlord,depositTransferToScheme,estateServiceCharge,estateWorksOrder,estateUnitWorksOrder,externalCredit,externalAgentFee,freeholderPayment,float,groundRent,goodwillPayment,holdingDeposit,introducingTenantFee,landlordAdminFee,landlordTax,landlordPayment,landlordToSupplierPayment,landlordWorksOrder,leaseholderAdminFee,leaseholderPayment,leaseholderRepayment,leaseholderWorksOrder,lettingFee,managementFee,paymentSurcharge,receipt,rent,rentGuarantee,recoveryPayment,reserveFund,tenantAdminFee,tenantPayment,tenantToLandlordPayment,tenantToSupplierPayment,trustAccountingInvoice,tenantWorksOrder,vacantManagementFee,vendorAdminFee,vendorCommission,vendorPayment,vendorToSupplierPayment,worksOrderPayment)","type":"string"},"type":{"description":"The transaction type (bankersDraft,bankTransfer,cash,cheque,creditCard,debitCard,directDebit,housingBenefit,paymentRequest,standingOrder)","type":"string"},"transactionType":{"description":"The type of transaction (credit/debit)","type":"string"},"description":{"description":"The transaction description","type":"string"},"status":{"description":"The status of the transaction (awaitingAuthorisation/awaitingPosting/posted/rejected)","type":"string"},"ledger":{"description":"The ledger the transaction is recorded in","type":"string"},"netAmount":{"format":"double","description":"The transaction net amount","type":"number"},"taxAmount":{"format":"double","description":"The transaction tax amount","type":"number"},"grossAmount":{"format":"double","description":"The transaction gross amount","type":"number"},"outstanding":{"format":"double","description":"The amount outstanding that remains to be paid","type":"number"},"companyId":{"description":"The unique identifier of the company the transaction is associated with, where applicable","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the transaction is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the transaction is associated with, where applicable","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the transaction is associated with, where applicable","type":"string"},"worksOrderId":{"description":"The unique identifier of the workds order the transaction is associated with, where applicable","type":"string"},"rejectReason":{"description":"The reason for rejection of an invoice","type":"string"},"_eTag":{"description":"The ETag for the current version of the transaction. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"PAY20000001","created":"2020-12-28T12:30:23Z","modified":"2021-01-02T10:28:34Z","category":"tenantPayment","type":"invoice","transactionType":"credit","description":"Tenancy Payment for 01/01/2021 to 31/01/2021","status":"awaitingPosting","ledger":"tenant","netAmount":100,"taxAmount":20,"grossAmount":120,"outstanding":60,"companyId":null,"landlordId":null,"propertyId":"PRP210001","tenancyId":"TEN210001","worksOrderId":null,"rejectReason":null,"_eTag":null,"_links":{"self":{"href":"/transactions/PAY20000001"},"property":{"href":"/properties/PRP210001"},"tenancy":{"href":"/tenancies/TEN210001"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/transactions/nominalAccounts":{"get":{"tags":["Transactions"],"summary":"Retrieves a collection of nominal accounts","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of nominal accounts to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified)","type":"string"},{"in":"query","name":"id","description":"Only return nominal accounts where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"appliesToWorksOrders","description":"Only return nominal accounts where the `appliesToWorksOrders` field matches the value provided","type":"boolean"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing a nominal account","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the nominal account","type":"string"},"created":{"format":"date-time","description":"The date and time when the nominal account was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the nominal account was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The nominal account name","type":"string"},"appliesToWorksOrders":{"description":"Flag indicating whether or not the nominal account can be associated with works orders","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"genman","created":"2022-12-02T12:30:23Z","modified":"2022-12-04T10:28:34Z","name":"General Maintenance","appliesToWorksOrders":true,"_links":{"self":{"href":"/nominalAccounts/genman"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/nominalAccounts/?PageNumber=1&PageSize=1"},"first":{"href":"/nominalAccounts/?PageNumber=1&PageSize=1"},"next":{"href":"/nominalAccounts/?PageNumber=2&PageSize=1"},"last":{"href":"/nominalAccounts/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/transactions/nominalAccounts/{id}":{"get":{"tags":["Transactions"],"summary":"Retrieves a specific nominal account","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the nominal account to return","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Model representing a nominal account","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the nominal account","type":"string"},"created":{"format":"date-time","description":"The date and time when the nominal account was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the nominal account was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The nominal account name","type":"string"},"appliesToWorksOrders":{"description":"Flag indicating whether or not the nominal account can be associated with works orders","type":"boolean"}}},"examples":{"application/json":{"id":"genman","created":"2022-12-02T12:30:23Z","modified":"2022-12-04T10:28:34Z","name":"General Maintenance","appliesToWorksOrders":true,"_links":{"self":{"href":"/nominalAccounts/genman"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/transactions/supplierInvoices":{"post":{"tags":["Transactions"],"summary":"Creates a new supplier invoice","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Request parameters","schema":{"description":"Request body used to create a new supplier invoice","required":["description","accountId","invoiceRef","negotiatorId","invoiceDate","netAmount","taxAmount"],"type":"object","properties":{"worksOrderId":{"description":"The unique identifier of the works order the supplier invoice is associated with, where applicable\r\nMust be provided if propertyId/companyId/tenancyId are not present","type":"string"},"propertyId":{"description":"The unique identifier of the property the supplier invoice is associated with, where applicable\r\nWhen providing a propertyId along with a worksOrderId, the id will be validated against the works order to check they match","type":"string"},"companyId":{"description":"The unique identifier of the contractor (company) the supplier invoice is associated with, where applicable\r\nWhen providing a companyId along with a worksOrderId, the id will be validated against the works order to check they match","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the supplier invoice is associated with, where applicable\r\nWhen providing a tenancyId along with a worksOrderId, the id will be validated against the works order to check they match","type":"string"},"description":{"description":"The supplier invoice work description","type":"string"},"accountId":{"description":"The identifier of the nominal account the supplier invoice should be attributed to","type":"string"},"invoiceRef":{"description":"The invoice reference","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator the invoice should be attributed to (normally the person creating it on the system)","type":"string"},"invoiceDate":{"format":"date","description":"The invoice date","type":"string","example":"2019-08-14"},"dueDate":{"format":"date","description":"The date the invoice should be paid by","type":"string","example":"2019-08-14"},"netAmount":{"format":"double","description":"The invoice net amount","type":"number"},"taxAmount":{"format":"double","description":"The invoice tax amount","type":"number"},"category":{"description":"The category type of the supplier invoice","type":"string"},"holdReserveFunds":{"format":"double","description":"The held reserve fund amount","type":"number"}},"example":{"worksOrderId":"WRK22000001","propertyId":null,"companyId":"CMP22000010","tenancyId":null,"description":"Fixed leaky tap in en-suite. Required replacement tap unit","accountId":"genman","invoiceRef":"RPR-INV-15945992","negotiatorId":"JAS","invoiceDate":"2022-12-06","dueDate":"2023-01-06","netAmount":120,"taxAmount":24,"category":"landlord","holdReserveFunds":0}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/vendors/{id}":{"get":{"tags":["Vendors"],"summary":"Gets a single vendor by its' unique identifier","operationId":"GetVendorById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Vendors unique identifier","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the vendor returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["negotiator","offices","property","sellingReason","solicitor","source","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a vendor","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the vendor was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the vendor was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the vendor was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the vendor is next due to be called","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the type of vendor","type":"string"},"sellingReasonId":{"description":"The unique identifier of the reason the vendor is selling","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the vendor","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the vendor","type":"string"},"source":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the vendor. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a vendor","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"attentionId":{"description":"The identifier of the staff member who is the registered attention for the company. It can be used with the company staff members endpoint to retrieve contact details. This value may represent either a contact code or an index number.","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"correspondenceAddressType":{"description":"Value indicating where hard copies of correspondence should be sent for the primary contact (property/contact).\r\nWhen set to contact, any correspondence should be sent to the related contact's address, rather than the property address","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator attached to the vendor. The first item in the collection is considered the primary negotiator","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the vendor. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the vendor was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the vendor is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the vendor","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the vendor. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF200001","created":"2018-12-26T12:30:22Z","modified":"2019-02-15T12:30:23Z","lastCall":"2019-11-12","nextCall":"2019-12-29","typeId":"S","sellingReasonId":"RL","solicitorId":"OXF12300001","propertyId":null,"source":{"id":"OXF","type":"office"},"related":[{"id":"OXF12300101","attentionId":null,"name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"fromArchive":false,"primaryAddress":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"additionalContactDetails":null}],"correspondenceAddressType":null,"negotiatorId":"JAS","officeIds":["OXF","SOL"],"archivedOn":null,"fromArchive":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/vendors/OXF200001"},"solicitor":{"href":"/companies/OXF12300001"},"negotiator":{"href":"/negotiators/JAS"},"type":{"href":"/configuration/vendorTypes/S"},"sellingReason":{"href":"/configuration/sellingReasons/RL"},"relationships":{"href":"/vendors/OXF200001/relationships"},"source":{"href":"/offices/OXF"},"offices":{"href":"/offices/?id=OXF&id=SOL"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["Vendors"],"summary":"Updates a vendor","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the vendor to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update an existing vendor","type":"object","properties":{"lastCall":{"format":"date","description":"The date the vendor was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the vendor is next due to be called","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the type of vendor","type":"string"},"sellingReasonId":{"description":"The unique identifier of the reason the vendor is selling","type":"string"},"solicitorId":{"description":"The unique identifier of the vendor's solicitor","type":"string"},"correspondenceAddressType":{"description":"Value indicating where hard copies of correspondence should be sent for the primary contact (property/contact)","type":"string"},"source":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the vendor","type":"object","additionalProperties":{}}},"example":{"lastCall":"2019-11-12","nextCall":"2019-12-29","typeId":"S","sellingReasonId":"RL","solicitorId":"OXF12300101","correspondenceAddressType":null,"source":{"id":"OXF","type":"office"},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/vendors/":{"get":{"tags":["Vendors"],"summary":"Gets a paged collection of vendors","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of vendors to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/lastCall/nextCall)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the vendors returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["negotiator","offices","property","sellingReason","solicitor","source","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return vendors where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return vendors where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"officeId","description":"Only return vendors where the `officeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"email","description":"Only return vendors where the contacts `email` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"fromArchive","description":"Only return vendors where the `fromArchive` field matches the value given","type":"boolean"},{"in":"query","name":"address","description":"Only return vendors where a contact related to the vendor has a `primaryAddress` that matches the value provided","type":"string"},{"in":"query","name":"name","description":"Only return vendors where a contact related to the vendor has a `name` that matches the value provided","type":"string"},{"in":"query","name":"createdFrom","description":"Only return vendors where the `created` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return vendors where the `created` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return vendors where the `modified` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return vendors where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"lastCallFrom","description":"Only return vendors where the `lastCall` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"lastCallTo","description":"Only return vendors where the `lastCall` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"nextCallFrom","description":"Only return vendors where the `nextCall` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"nextCallTo","description":"Only return vendors where the `nextCall` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return vendors where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a vendor","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the vendor was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the vendor was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the vendor was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the vendor is next due to be called","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the type of vendor","type":"string"},"sellingReasonId":{"description":"The unique identifier of the reason the vendor is selling","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the vendor","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the vendor","type":"string"},"source":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the vendor. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a vendor","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"attentionId":{"description":"The identifier of the staff member who is the registered attention for the company. It can be used with the company staff members endpoint to retrieve contact details. This value may represent either a contact code or an index number.","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"correspondenceAddressType":{"description":"Value indicating where hard copies of correspondence should be sent for the primary contact (property/contact).\r\nWhen set to contact, any correspondence should be sent to the related contact's address, rather than the property address","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator attached to the vendor. The first item in the collection is considered the primary negotiator","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the vendor. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the vendor was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the vendor is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the vendor","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the vendor. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF200001","created":"2018-12-26T12:30:22Z","modified":"2019-02-15T12:30:23Z","lastCall":"2019-11-12","nextCall":"2019-12-29","typeId":"S","sellingReasonId":"RL","solicitorId":"OXF12300001","propertyId":null,"source":{"id":"OXF","type":"office"},"related":[{"id":"OXF12300101","attentionId":null,"name":"Mr John Smith","title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","type":"contact","homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","marketingConsent":null,"fromArchive":false,"primaryAddress":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"additionalContactDetails":null}],"correspondenceAddressType":null,"negotiatorId":"JAS","officeIds":["OXF","SOL"],"archivedOn":null,"fromArchive":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"_eTag":null,"_links":{"self":{"href":"/vendors/OXF200001"},"solicitor":{"href":"/companies/OXF12300001"},"negotiator":{"href":"/negotiators/JAS"},"type":{"href":"/configuration/vendorTypes/S"},"sellingReason":{"href":"/configuration/sellingReasons/RL"},"relationships":{"href":"/vendors/OXF200001/relationships"},"source":{"href":"/offices/OXF"},"offices":{"href":"/offices/?id=OXF&id=SOL"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/vendors/?PageNumber=1&PageSize=1"},"first":{"href":"/vendors/?PageNumber=1&PageSize=1"},"next":{"href":"/vendors/?PageNumber=2&PageSize=1"},"last":{"href":"/vendors/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]}},"/vendors/{id}/relationships":{"get":{"tags":["Vendors"],"summary":"Gets this vendors contact/company relationships","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique vendor identifier","required":true,"type":"string"},{"in":"query","name":"pageSize","description":"A limit on the number of vendor relationships to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a relationship between a vendor and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor relationship","type":"string"},"vendorId":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent vendor entity","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":[{"id":"OXF20002002","vendorId":"OXF190001","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"_links":{"self":{"href":"/vendors/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}]}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["Vendors"],"summary":"Creates a relationship between this vendor and a contact/company","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique vendor identifier","required":true,"type":"string"},{"in":"body","name":"body","description":"Model containing information used to create the relationship","schema":{"description":"Request body used to create or update a relationship between a vendor and a contact or company","required":["associatedId","associatedType","isMain"],"type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"},"isMain":{"description":"Flag denoting whether or not this relationship should be considered to be the main/primary relationship. Setting to true will automatically demote the existing primary relationship","type":"boolean"}},"example":{"associatedId":"OXF18000001","associatedType":"contact","isMain":false}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/vendors/{id}/relationships/{relationshipId}":{"get":{"tags":["Vendors"],"summary":"Gets a single relationship between this vendor and a contact/company","operationId":"GetVendorRelationshipById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique vendor identifier","required":true,"type":"string"},{"in":"path","name":"relationshipId","description":"Unique relationship identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a relationship between a vendor and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor relationship","type":"string"},"vendorId":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent vendor entity","type":"boolean"}}},"examples":{"application/json":{"id":"OXF20002002","vendorId":"OXF190001","created":"2020-01-25T15:44:28Z","modified":"2020-01-26T09:24:02Z","associatedType":"contact","associatedId":"OXF2000002","isMain":true,"_links":{"self":{"href":"/vendors/OXF190001/relationships/OXF20002002"},"contact":{"href":"/contacts/OXF2000002"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"delete":{"tags":["Vendors"],"summary":"Deletes a specific relationship between this vendor and a contact/company","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique vendor identifier","required":true,"type":"string"},{"in":"path","name":"relationshipId","description":"Unique relationship identifier","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}},"/worksOrders/":{"get":{"tags":["WorksOrders"],"summary":"Gets a paged collection of works orders","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of works orders to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return (must be greater than 0)","type":"integer","format":"int32"},{"in":"query","name":"sortBy","description":"Sort results by the value specified. Prefix string with '-' to indicate descending direction (created/modified/completed/required)","type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the works orders returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["company","documents","negotiator","property","tenancy","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"id","description":"Only return works orders where the `id` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"companyId","description":"Only return works orders where the `companyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"negotiatorId","description":"Only return works orders where the `negotiatorId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"propertyId","description":"Only return works orders where the `propertyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"status","description":"Only return works orders where the `status` field matches one or more values provided ","type":"array","items":{"enum":["pendingApproval","pendingQuote","raised","raisedToChase","landlordToComplete","complete","cancelled","quoteAccepted"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"tenancyId","description":"Only return works orders where the `tenancyId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"typeId","description":"Only return works orders where the `typeId` field matches one or more values provided","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"completedFrom","description":"Only return works orders where the `completed` field is on or after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"completedTo","description":"Only return works orders where the `completed` field is on or before this date and time","type":"string","format":"date-time"},{"in":"query","name":"createdFrom","description":"Only return works orders where the `created` field is after this date and time","type":"string","format":"date-time"},{"in":"query","name":"createdTo","description":"Only return works orders where the `created` field is on or before this date and time","type":"string","format":"date-time"},{"in":"query","name":"modifiedFrom","description":"Only return works orders where the `modified` field is after the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"modifiedTo","description":"Only return works orders where the `modified` field is on or before the ISO8601 date and time value provided","type":"string","format":"date-time"},{"in":"query","name":"requiredFrom","description":"Only return works orders where the `required` field is on or after this date and time","type":"string","format":"date-time"},{"in":"query","name":"requiredTo","description":"Only return works orders where the `required` field is on or before this date and time","type":"string","format":"date-time"},{"in":"query","name":"reviewDateFrom","description":"Only return works orders where the `review date` field is on or after this date and time","type":"string","format":"date-time"},{"in":"query","name":"reviewDateTo","description":"Only return works orders where the `review date` field is on or before this date and time","type":"string","format":"date-time"},{"in":"query","name":"metadata","description":"Only return works orders where the metadata matches the filters given","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a works order","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique identifier of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"totalNetAmount":{"format":"double","description":"The total net cost for all of the items of work to be carried out","type":"number"},"totalVatAmount":{"format":"double","description":"The total additional vat cost for all of the items of work to be carried out","type":"number"},"totalGrossAmount":{"format":"double","description":"The total gross cost for all of the items of work to be carried out","type":"number"},"items":{"description":"A collection of jobs/items of work that the works order should fulfill","type":"array","items":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}}},"metadata":{"description":"App specific metadata that has been set against the works order","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the works order. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF19002002","created":"2019-01-25T15:44:28Z","modified":"2019-11-26T09:24:02Z","companyId":"OXF18000001","propertyId":"OXF190001","tenancyId":"OXF190022","negotiatorId":"JAS","typeId":"ES","status":"complete","description":"Light fitting in living room not working.","reporter":"landlord","priority":"low","booked":"2019-05-10","required":"2019-08-12","reviewDate":"2019-07-12","completed":"2019-10-01","totalNetAmount":100,"totalVatAmount":20,"totalGrossAmount":120,"items":[{"id":"OXF19002002","worksOrderId":"OXF19002002","created":"2019-01-25T15:44:28Z","modified":"2019-11-26T09:24:02Z","notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":125,"estimateType":"written","netAmount":100,"vatAmount":20,"grossAmount":120,"reserveAmount":null,"nominalAccountId":null,"_eTag":null,"_links":null,"_embedded":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/worksOrders/OXF19002002"},"documents":{"href":"/documents/?associatedType=worksOrder&associatedId=OXF19002002"},"items":{"href":"/worksOrders/OXF19002002/items"},"company":{"href":"/companies/OXF18000001"},"negotiator":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF190001"},"tenancy":{"href":"/tenancies/OXF190022"},"type":{"href":"/configurations/worksOrderTypes/ES"}},"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/worksOrders/?PageNumber=1&PageSize=1"},"first":{"href":"/worksOrders/?PageNumber=1&PageSize=1"},"next":{"href":"/worksOrders/?PageNumber=2&PageSize=1"},"last":{"href":"/worksOrders/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"}},"security":[{"Authorization":[]}]},"post":{"tags":["WorksOrders"],"summary":"Creates a new works order","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The model to create a works order","schema":{"description":"Request body used to create a new works order","required":["propertyId","negotiatorId","status","description","reporter","items"],"type":"object","properties":{"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique id of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"items":{"description":"Individual work items to attach to the works order","type":"array","items":{"description":"Representation of a works order item","required":["notes","chargeTo"],"type":"object","properties":{"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The cost of the vat associated with the work","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"}},"example":{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":0}}},"metadata":{"description":"App specific metadata to set against the works order","type":"object","additionalProperties":{}}},"example":{"companyId":"OXF18000001","propertyId":"OXF190001","tenancyId":"OXF190022","negotiatorId":"JAS","typeId":"ES","status":"complete","description":"Light fitting in living room not working.","reporter":"landlord","priority":"low","booked":"2019-05-10","required":"2019-08-12","reviewDate":"2019-08-02","completed":"2019-10-01","items":[{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":0}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/worksOrders/{id}":{"get":{"tags":["WorksOrders"],"summary":"Gets a specific works order by unique identifier","operationId":"GetWorksOrderById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the works order","required":true,"type":"string"},{"in":"query","name":"embed","description":"Embed additional resources into the works order returned\r\nThis is a convenience mechanism that still contributes to your API consumption. Please see https://foundations-documentation.reapit.cloud/api/api-documentation#embedding-data for more information. ","type":"array","items":{"enum":["company","documents","negotiator","property","tenancy","type"],"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"in":"query","name":"extrasField","description":"Include extras fields matching one or more field names specified. You must be granted access to this data beforehand","type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a works order","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique identifier of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"totalNetAmount":{"format":"double","description":"The total net cost for all of the items of work to be carried out","type":"number"},"totalVatAmount":{"format":"double","description":"The total additional vat cost for all of the items of work to be carried out","type":"number"},"totalGrossAmount":{"format":"double","description":"The total gross cost for all of the items of work to be carried out","type":"number"},"items":{"description":"A collection of jobs/items of work that the works order should fulfill","type":"array","items":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}}},"metadata":{"description":"App specific metadata that has been set against the works order","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the works order. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF19002002","created":"2019-01-25T15:44:28Z","modified":"2019-11-26T09:24:02Z","companyId":"OXF18000001","propertyId":"OXF190001","tenancyId":"OXF190022","negotiatorId":"JAS","typeId":"ES","status":"complete","description":"Light fitting in living room not working.","reporter":"landlord","priority":"low","booked":"2019-05-10","required":"2019-08-12","reviewDate":"2019-07-12","completed":"2019-10-01","totalNetAmount":100,"totalVatAmount":20,"totalGrossAmount":120,"items":[{"id":"OXF19002002","worksOrderId":"OXF19002002","created":"2019-01-25T15:44:28Z","modified":"2019-11-26T09:24:02Z","notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":125,"estimateType":"written","netAmount":100,"vatAmount":20,"grossAmount":120,"reserveAmount":null,"nominalAccountId":null,"_eTag":null,"_links":null,"_embedded":null}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"extrasField":null,"_eTag":null,"_links":{"self":{"href":"/worksOrders/OXF19002002"},"documents":{"href":"/documents/?associatedType=worksOrder&associatedId=OXF19002002"},"items":{"href":"/worksOrders/OXF19002002/items"},"company":{"href":"/companies/OXF18000001"},"negotiator":{"href":"/negotiators/JAS"},"property":{"href":"/properties/OXF190001"},"tenancy":{"href":"/tenancies/OXF190022"},"type":{"href":"/configurations/worksOrderTypes/ES"}},"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["WorksOrders"],"summary":"Updates a works order","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the works order to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Request body used to update an existing works order","type":"object","properties":{"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique id of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"metadata":{"description":"App specific metadata to set against the works order","type":"object","additionalProperties":{}}},"example":{"companyId":"OXF18000001","propertyId":"OXF190001","tenancyId":"OXF190022","negotiatorId":"JAS","typeId":"ES","status":"complete","description":"Light fitting in living room not working.","reporter":"landlord","priority":"low","booked":"2019-05-10","required":"2019-08-12","reviewDate":"2019-08-02","completed":"2019-10-01","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/worksOrders/{id}/items":{"get":{"tags":["WorksOrders"],"summary":"Gets a collection of work order items by work order id","produces":["application/json"],"parameters":[{"in":"query","name":"pageSize","description":"A limit on the number of works order items to be returned per page. Value can range between 1 and 100, and the default is 25","type":"integer","format":"int32"},{"in":"query","name":"pageNumber","description":"The page number to return","type":"integer","format":"int32"},{"in":"path","name":"id","description":"The unique identifier of the works order","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"examples":{"application/json":{"_embedded":[{"id":"OXF19002002","worksOrderId":"OXF19002001","created":"2019-01-25T15:44:28Z","modified":"2019-11-26T09:24:02Z","notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":150,"vatAmount":0,"grossAmount":0,"reserveAmount":null,"nominalAccountId":null,"_eTag":null,"_links":null,"_embedded":null}],"pageNumber":1,"pageSize":1,"pageCount":1,"totalPageCount":1,"totalCount":25,"_links":{"self":{"href":"/worksOrders/OXF19002001/items/OXF19002002/?PageNumber=1&PageSize=1"},"first":{"href":"/worksOrders/OXF19002001/items/OXF19002002/?PageNumber=1&PageSize=1"},"next":{"href":"/worksOrders/OXF19002001/items/OXF19002002/?PageNumber=2&PageSize=1"},"last":{"href":"/worksOrders/OXF19002001/items/OXF19002002/?PageNumber=25&PageSize=1"}}}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"post":{"tags":["WorksOrders"],"summary":"Creates a new works order item","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"path","name":"id","required":true,"type":"string"},{"in":"body","name":"body","description":"The model to create a works order item","schema":{"description":"Representation of a works order item","required":["notes","chargeTo"],"type":"object","properties":{"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The cost of the vat associated with the work","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"}},"example":{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":0}}}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]}},"/worksOrders/{id}/items/{itemId}":{"get":{"tags":["WorksOrders"],"summary":"Gets a specific works order item by id","operationId":"GetWorksOrderItemById","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The unique identifier of the works order","required":true,"type":"string"},{"in":"path","name":"itemId","description":"The unique identifier of the works order item","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}},"examples":{"application/json":{"id":"OXF19002002","worksOrderId":"OXF19002001","created":"2019-01-25T15:44:28Z","modified":"2019-11-26T09:24:02Z","notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":150,"vatAmount":0,"grossAmount":0,"reserveAmount":null,"nominalAccountId":null,"_eTag":null,"_links":null,"_embedded":null}}},"400":{"description":"Bad Request","schema":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]},"patch":{"tags":["WorksOrders"],"summary":"Updates a works order item","consumes":["application/json-patch+json","application/json","application/*+json"],"produces":["application/json"],"parameters":[{"in":"header","name":"If-Match","description":"The ETag provided in the payload from the current version of this resource","required":true,"type":"string"},{"in":"path","name":"id","description":"Unique identifier of the works order the item is against.","required":true,"type":"string"},{"in":"path","name":"itemId","description":"Unique identifier of the works order item to update.","required":true,"type":"string"},{"in":"body","name":"body","description":"The model.","schema":{"description":"Representation of a works order item","type":"object","properties":{"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The cost of the vat associated with the work","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"}},"example":{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":null}}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"412":{"description":"Client Error"},"422":{"description":"Client Error"}},"security":[{"Authorization":[]}]},"delete":{"tags":["WorksOrders"],"summary":"Deletes a works order item","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Unique identifier of the works order the item is against.","required":true,"type":"string"},{"in":"path","name":"itemId","description":"Unique identifier of the works order item to delete.","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"Authorization":[]}]}}},"securityDefinitions":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header","description":"Please enter an authentication token (prefixed by Bearer) to enable Try It Out functionality</a><br/></p>"}},"definitions":{"HttpStatusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"ApiErrorModel":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}},"LinkModel":{"type":"object","properties":{"href":{"type":"string"}}},"UnmappedRequirementModel":{"description":"Represents an unmapped requirement type","type":"object","properties":{"type":{"description":"The type of unmapped requirement","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}},"ApplicantLeaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}},"ApplicantBuyingModel":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"ApplicantRentingModel":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department. Only applicable to applicants with a marketingMode of renting","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"ApplicantExternalAreaModel":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"ApplicantInternalAreaModel":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"ApplicantSourceModel":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"ApplicantCommercialModel":{"description":"An applicant's commercial details","type":"object","properties":{"useClass":{"description":"The commercial use requirements (eg a1, a2, b1), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"ApplicantGuernseyModel":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"ApplicantRegionalModel":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"ApplicantContactAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"AdditionalContactDetailModel":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}},"ApplicantContactModel":{"description":"A summarised view of the details of a contact or company associated to an applicant","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}},"ApplicantModel":{"description":"Representation of an applicant","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant","type":"string"},"created":{"format":"date-time","description":"The date and time when the applicant was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the applicant was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department the applicant is associated with. The applicant will only match to properties with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg swimmingPool, tennisCourt), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedRequirements":{"description":"The requirements associated to the applicant which are not currently mapped. These are defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped requirement type","type":"object","properties":{"type":{"description":"The type of unmapped requirement","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the applicant was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag denoting whether or not this applicant is archived","type":"boolean"},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department. Only applicable to applicants with a marketingMode of renting","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"commercial":{"description":"An applicant's commercial details","type":"object","properties":{"useClass":{"description":"The commercial use requirements (eg a1, a2, b1), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"related":{"description":"A collection of contacts and/or companies associated to the applicant. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to an applicant","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the applicant","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the applicant. Used for managing update concurrency","type":"string","readOnly":true}}},"PagingLinkModel":{"type":"object","properties":{"href":{"type":"string"}}},"ApplicantModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an applicant","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant","type":"string"},"created":{"format":"date-time","description":"The date and time when the applicant was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the applicant was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department the applicant is associated with. The applicant will only match to properties with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg swimmingPool, tennisCourt), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedRequirements":{"description":"The requirements associated to the applicant which are not currently mapped. These are defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped requirement type","type":"object","properties":{"type":{"description":"The type of unmapped requirement","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the applicant was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag denoting whether or not this applicant is archived","type":"boolean"},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department. Only applicable to applicants with a marketingMode of renting","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"commercial":{"description":"An applicant's commercial details","type":"object","properties":{"useClass":{"description":"The commercial use requirements (eg a1, a2, b1), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"related":{"description":"A collection of contacts and/or companies associated to the applicant. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to an applicant","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the applicant","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the applicant. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateApplicantLeaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}},"CreateApplicantBuyingModel":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget. (Required when 'marketingMode' is 'buying' and 'priceTo' is not provided)","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget. (Required when 'marketingMode' is 'buying' and 'priceFrom' is not provided)","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date-time","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14T12:30:02Z"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"CreateApplicantRentingModel":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget. (Required when 'marketingMode' is 'renting' and 'rentTo' is 0)","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget. (Required when 'marketingMode' is 'renting' and 'rentFrom' is 0)","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually/fourWeekly).","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"CreateApplicantExternalAreaModel":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"CreateApplicantInternalAreaModel":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"CreateApplicantSourceModel":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"CreateApplicantGuernseyModel":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"CreateApplicantRegionalModel":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"CreateApplicantContactRelationshipModel":{"description":"Request body used to create a relationship between an applicant and a contact or company","required":["associatedId"],"type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"}}},"CreateApplicantModel":{"description":"Request body used to create a new applicant","required":["marketingMode","departmentId","officeIds","negotiatorIds","related"],"type":"object","properties":{"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant\r\nWhere not specified this will default to the customer's base currency","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department the applicant is associated with. The applicant will only match to properties with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget. (Required when 'marketingMode' is 'buying' and 'priceTo' is not provided)","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget. (Required when 'marketingMode' is 'buying' and 'priceFrom' is not provided)","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date-time","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14T12:30:02Z"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget. (Required when 'marketingMode' is 'renting' and 'rentTo' is 0)","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget. (Required when 'marketingMode' is 'renting' and 'rentFrom' is 0)","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually/fourWeekly).","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"related":{"description":"A collection of contacts and/or companies associated to the applicant. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"Request body used to create a relationship between an applicant and a contact or company","required":["associatedId"],"type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"}}}},"metadata":{"description":"App specific metadata to set against the applicant","type":"object","additionalProperties":{}}},"example":{"marketingMode":"buying","currency":"GBP","active":true,"notes":"Looking to move his mother back into the area","statusId":null,"sellingStatus":"exchanged","sellingPosition":"renting","lastCall":"2019-11-12","nextCall":"2022-12-29","departmentId":"G","solicitorId":"OXF18000012","potentialClient":false,"type":["house","maisonette","cottage"],"style":["detached","semiDetached"],"situation":["garden","patio"],"parking":["garage"],"age":["period"],"locality":["rural"],"specialFeatures":null,"bedroomsMin":4,"bedroomsMax":5,"receptionsMin":1,"receptionsMax":2,"bathroomsMin":1,"bathroomsMax":0,"parkingSpacesMin":0,"parkingSpacesMax":0,"locationType":"areas","locationOptions":["SOL","BHM","WLV"],"buying":{"reasonId":null,"positionId":null,"priceFrom":250000,"priceTo":275000,"decoration":null,"tenure":["freehold","leasehold"],"mortgageExpiry":null,"leaseRemaining":{"min":10,"max":20}},"renting":{"moveDate":null,"term":null,"rentFrom":null,"rentTo":null,"rentFrequency":null,"furnishing":null,"positionId":null},"externalArea":{"type":"acres","amountFrom":2,"amountTo":3},"internalArea":{"type":"squareFeet","amount":1500},"source":{"id":"RMV","type":"source"},"regional":null,"officeIds":["OXF","SOL"],"negotiatorIds":["JAS"],"related":[{"associatedId":"OXF20000001","associatedType":"contact"}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"ValidationMessageModel":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}},"ValidationErrorModel":{"description":"Represents a one or more messages for fields that have failed a given validation action","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"},"errors":{"description":"Gets or sets the list of validation errors.","type":"array","items":{"description":"Model for validation failure","type":"object","properties":{"field":{"description":"Gets the field that the message applies to","type":"string","readOnly":true},"message":{"description":"Gets the validation failure message to issue to the client","type":"string","readOnly":true}}}}}},"UpdateApplicantLeaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}},"UpdateApplicantBuyingModel":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"UpdateApplicantRentingModel":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"UpdateApplicantExternalAreaModel":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"UpdateApplicantInternalAreaModel":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"UpdateApplicantSourceModel":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"UpdateApplicantGuernseyModel":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"UpdateApplicantRegionalModel":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"UpdateApplicantModel":{"description":"Request body used to update an existing applicant","type":"object","properties":{"marketingMode":{"description":"Indicates whether the applicant is look to buy or rent a property (buying/renting)","type":"string"},"currency":{"description":"The ISO-4217 currency code that relates to monetary amounts specified by the applicant\r\nWhere not specified this will default to the customer's base currency","type":"string"},"active":{"description":"A flag determining whether or not the applicant is actively looking for a property","type":"boolean"},"notes":{"description":"A free text field describing any adhoc buying or renting requirements","type":"string"},"statusId":{"description":"The status id of the applicant","type":"string"},"sellingStatus":{"description":"The applicant's selling status (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"sellingPosition":{"description":"The applicant's selling position (nothingToSell/renting/sellingWithUs/sellingWithOtherAgent/sellingPrivately/notYetOnMarket)","type":"string"},"lastCall":{"format":"date","description":"The date when the applicant was last contacted","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date when the applicant is next due to be contacted","type":"string","example":"2019-08-14"},"departmentId":{"description":"The unique identifier of the department that the applicant requirements are associated with. The applicant will only match to properties with the same value","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the applicant","type":"string"},"potentialClient":{"description":"A flag determining whether or not the applicant is a potential client","type":"boolean"},"type":{"description":"The applicant's property type requirements (eg house, bungalow, land), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The applicant's property style requirements (eg detached, semiDetached), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The applicant's requirements for other aspects of prospective properties - such as outside space - as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The applicant's parking requirements (eg garage), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The applicant's property age requirements (eg new, period), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The applicant's general property location requirements (eg rural, townCity), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The applicant's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the applicant's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"bedroomsMin":{"format":"int32","description":"The minimum number of bedrooms the applicant requires","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms the applicant requires","type":"integer"},"receptionsMin":{"format":"int32","description":"The minimum number of reception rooms the applicant requires","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms the applicant requires","type":"integer"},"bathroomsMin":{"format":"int32","description":"The minimum number of bathrooms the applicant requires","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms the applicant requires","type":"integer"},"parkingSpacesMin":{"format":"int32","description":"The minimum number of parking spaces the applicant requires","type":"integer"},"parkingSpacesMax":{"format":"int32","description":"The maximum number of parking spaces the applicant requires","type":"integer"},"locationType":{"description":"The applicant's location type (areas/addresses/none)","type":"string"},"locationOptions":{"description":"The applicant's location options","type":"array","items":{"type":"string"}},"buying":{"description":"The details specific to applicants with a marketingMode of buying","type":"object","properties":{"reasonId":{"description":"The identifier of the applicant's buying reason","type":"string"},"positionId":{"description":"The identifier of the applicant's selling position","type":"string"},"priceFrom":{"format":"int32","description":"The lower bound of the applicant's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the applicant's budget","type":"integer"},"decoration":{"description":"A list of property decoration requirements taken from the full listing of the associated department (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"tenure":{"description":"A list of tenure requirements taken from the full listing of the associated department (freehold/leasehold/shareOfFreehold)","type":"array","items":{"type":"string"}},"mortgageExpiry":{"format":"date","description":"The date when the applicant's current mortgage expires/is due for renewal","type":"string","example":"2019-08-14"},"leaseRemaining":{"description":"The details specific to the applicant's lease term requirements where they are interested in properties with a leasehold tenure","type":"object","properties":{"min":{"format":"int32","description":"The minimum number of years that must remain on the lease of a leasehold property","type":"integer"},"max":{"format":"int32","description":"The maximum number of years that must remain on the lease of a leasehold property","type":"integer"}}}}},"renting":{"description":"The details specific to applicants with a marketingMode of renting","type":"object","properties":{"moveDate":{"format":"date","description":"The date the applicant is looking to move to a new property","type":"string","example":"2019-08-14"},"term":{"description":"The applicant's preferred letting term (long/short/any)","type":"string"},"rentFrom":{"format":"double","description":"The lower bound of the applicant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the applicant's budget","type":"number"},"rentFrequency":{"description":"The desired rent collection frequency specified by the applicant's budget (weekly/monthly/annually)","type":"string"},"furnishing":{"description":"A list of property furnishing requirements taken from the full listing of the associated department","type":"array","items":{"type":"string"}},"positionId":{"description":"The identifier of the applicant's renting position","type":"string"}}},"externalArea":{"description":"The applicant's outdoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (acres/hectares)","type":"string"},"amountFrom":{"format":"double","description":"The minimum unit value of outside space that the applicant is looking for","type":"number"},"amountTo":{"format":"double","description":"The maximum unit value of outside space that the applicant is looking for","type":"number"}}},"internalArea":{"description":"The applicant's indoor space requirements","type":"object","properties":{"type":{"description":"The unit of area that each amount corresponds to (squareFeet/squareMetres)","type":"string"},"amount":{"format":"double","description":"The unit value of inside space that the applicant is looking for","type":"number"}}},"source":{"description":"An applicant's source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the applicant's source","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Details of regional information specific to Guernsey","type":"object","properties":{"market":{"description":"Requirements describing which markets the applicant is looking for properties in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the applicant. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the applicant. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the applicant","type":"object","additionalProperties":{}}},"example":{"marketingMode":"buying","currency":"GBP","active":true,"notes":"Looking to move his mother back into the area","statusId":null,"sellingStatus":"completed","sellingPosition":"sellingWithUs","lastCall":"2019-11-12","nextCall":"2022-12-29","departmentId":"G","solicitorId":"OXF18000012","potentialClient":null,"type":["house","maisonette","cottage"],"style":["detached","semiDetached"],"situation":["garden","patio"],"parking":["garage"],"age":["period"],"locality":["rural"],"specialFeatures":null,"bedroomsMin":4,"bedroomsMax":5,"receptionsMin":1,"receptionsMax":2,"bathroomsMin":1,"bathroomsMax":null,"parkingSpacesMin":null,"parkingSpacesMax":null,"locationType":"areas","locationOptions":["SOL","BHM","WLV"],"buying":{"reasonId":null,"positionId":null,"priceFrom":250000,"priceTo":275000,"decoration":null,"tenure":["freehold","leasehold"],"mortgageExpiry":"0001-01-01T00:00:00Z","leaseRemaining":{"min":15,"max":25}},"renting":null,"externalArea":{"type":"acres","amountFrom":2,"amountTo":3},"internalArea":{"type":"squareFeet","amount":1500},"source":{"id":"RMV","type":"source"},"regional":null,"officeIds":["OXF","SOL"],"negotiatorIds":["JAS"],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"ApplicantContactRelationshipModel":{"description":"Representation of a relationship between an applicant and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"applicantId":{"description":"The unique identifier of the applicant","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent applicant entity","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"}}},"ApplicantContactRelationshipModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a relationship between an applicant and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the applicant relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"applicantId":{"description":"The unique identifier of the applicant","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent applicant entity","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"InsertApplicantContactRelationshipModel":{"description":"Request body used to create or update a relationship between an applicant and a contact or company","type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"},"isMain":{"description":"Flag denoting whether or not this relationship should be considered to be the main/primary relationship. Setting to true will automatically demote the existing primary relationship","type":"boolean"}},"example":{"associatedId":"OXF18000001","associatedType":"contact","isMain":false}},"AreaModel":{"description":"Representation of an area that properties reside in, or applicants are looking to buy/rent in","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the area","type":"string"},"created":{"format":"date-time","description":"The date and time when the area was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the area was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the area","type":"string"},"active":{"description":"A flag denoting whether the area can currently be selected against properties and applicants","type":"boolean"},"type":{"description":"The type of area (postcodes/polygon/group)","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"parentIds":{"description":"A collection of unique identifiers of parent area groups that this area is part of\r\nThis information can be used to understand the area hierarchy in a customer's system","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the area. Used for managing update concurrency","type":"string","readOnly":true}}},"AreaModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an area that properties reside in, or applicants are looking to buy/rent in","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the area","type":"string"},"created":{"format":"date-time","description":"The date and time when the area was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the area was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the area","type":"string"},"active":{"description":"A flag denoting whether the area can currently be selected against properties and applicants","type":"boolean"},"type":{"description":"The type of area (postcodes/polygon/group)","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"parentIds":{"description":"A collection of unique identifiers of parent area groups that this area is part of\r\nThis information can be used to understand the area hierarchy in a customer's system","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the area. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateAreaModel":{"description":"Request body used to create a new area","required":["name","type","area"],"type":"object","properties":{"name":{"description":"The name of the area","type":"string"},"type":{"description":"The type of area (postcodes/polygon/group)","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"parentId":{"description":"The unique identifier of the parent area, if the area should be registered as a child area/group in an existing area group","type":"string"}},"example":{"name":"Birmingham","type":"polygon","area":["51.60009,-0.21789","51.47025,-0.27282","51.50445,0.00184"],"departmentIds":["G"],"officeIds":["OXF","SOL"],"parentId":null}},"UpdateAreaModel":{"description":"Request body used to update an existing area","type":"object","properties":{"name":{"description":"The name of the area","type":"string"},"area":{"description":"The location details (comma delimited list of postcodes, group ids or lat/long coordinate groups)","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments associated to the area","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the area. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}}},"example":{"name":"Birmingham","area":["51.60009,-0.21789","51.47025,-0.27282","51.50445,0.00184"],"departmentIds":["G"],"officeIds":["OXF","SOL"]}},"RecurrenceModel":{"description":"Representation of an appointments recurrence details","type":"object","properties":{"interval":{"format":"int32","description":"The recurrence interval","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date the appointment recurs until","type":"string","example":"2019-08-14T12:30:02Z"}}},"AppointmentFollowUpModel":{"description":"Follow up information relating to an appointment","type":"object","properties":{"due":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"Free text internal follow up notes to be stored against the appointment","type":"string"}}},"AppointmentContactModel":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}},"AppointmentAttendeeModel":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"AppointmentDocumentModel":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"AppointmentModel":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the appointment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the appointment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"recurring":{"description":"A flag denoting whether or not the appointment recurs","type":"boolean"},"recurrence":{"description":"Representation of an appointments recurrence details","type":"object","properties":{"interval":{"format":"int32","description":"The recurrence interval","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date the appointment recurs until","type":"string","example":"2019-08-14T12:30:02Z"}}},"cancelled":{"description":"A flag denoting whether or not the appointment has been cancelled","type":"boolean"},"followUp":{"description":"Follow up information relating to an appointment","type":"object","properties":{"due":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"Free text internal follow up notes to be stored against the appointment","type":"string"}}},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"fromArchive":{"description":"A flag determining whether or not the appointment is archived","type":"boolean"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the appointment","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the appointment. Used for managing update concurrency","type":"string","readOnly":true}}},"AppointmentModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the appointment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the appointment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"recurring":{"description":"A flag denoting whether or not the appointment recurs","type":"boolean"},"recurrence":{"description":"Representation of an appointments recurrence details","type":"object","properties":{"interval":{"format":"int32","description":"The recurrence interval","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date the appointment recurs until","type":"string","example":"2019-08-14T12:30:02Z"}}},"cancelled":{"description":"A flag denoting whether or not the appointment has been cancelled","type":"boolean"},"followUp":{"description":"Follow up information relating to an appointment","type":"object","properties":{"due":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"Free text internal follow up notes to be stored against the appointment","type":"string"}}},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"fromArchive":{"description":"A flag determining whether or not the appointment is archived","type":"boolean"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the appointment","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the appointment. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateAppointmentAttendeeModel":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"}}},"CreateAppointmentRecurrenceModel":{"description":"Details of an appointment's recurrence pattern","type":"object","properties":{"interval":{"format":"int32","description":"The numeric value denoting how often the appointment will recur","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date and time when the recurrence will stop. (Required if 'type' is provided)","type":"string","example":"2019-08-14T12:30:02Z"}}},"CreateAppointmentDocumentModel":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"CreateAppointmentModel":{"description":"Request body used to create a new calendar appointment","required":["start","end","typeId"],"type":"object","properties":{"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"followUpOn":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"}}},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"recurrence":{"description":"Details of an appointment's recurrence pattern","type":"object","properties":{"interval":{"format":"int32","description":"The numeric value denoting how often the appointment will recur","type":"integer"},"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"until":{"format":"date-time","description":"The date and time when the recurrence will stop. (Required if 'type' is provided)","type":"string","example":"2019-08-14T12:30:02Z"}}},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata to set against the appointment","type":"object","additionalProperties":{}}},"example":{"start":"2018-08-14T12:30:02Z","end":"2018-08-14T13:30:02Z","followUpOn":"2018-10-05","typeId":"VW","description":"Meet landlord at the property to get the key.","organiserId":"JAS","negotiatorIds":["JAS"],"officeIds":["OXF","SOL"],"attendee":{"id":"OXF20001","type":"applicant"},"propertyId":"OXF190022","otherAgentId":null,"accompanied":true,"negotiatorConfirmed":true,"attendeeConfirmed":true,"propertyConfirmed":true,"virtual":false,"isRepeat":false,"attended":"noShow","recurrence":{"interval":0,"type":null,"until":null},"documents":{"draftPropertyInspectionReportId":null,"finalPropertyInspectionReportId":null},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateAppointmentAttendeeModel":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee. To clear an attendee this can be passed as an empty string.","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"},"confirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"}}},"UpdateAppointmentFollowUpModel":{"description":"Represents the follow up information on a single appointment","type":"object","properties":{"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"The internal follow up notes to be stored against the appointment","type":"string"}}},"UpdateAppointmentRecurrenceModel":{"description":"Details of an appointment's recurrence pattern","type":"object","properties":{"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"interval":{"format":"int32","description":"The numeric value denoting how often the appointment will recur","type":"integer"},"until":{"format":"date-time","description":"The date and time when the recurrence will stop","type":"string","example":"2019-08-14T12:30:02Z"}}},"UpdateAppointmentDocumentModel":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"UpdateAppointmentModel":{"description":"Request body used to update an existing calendar appointment","type":"object","properties":{"start":{"format":"date-time","description":"The date and time when the appointment will start","type":"string","example":"2019-08-14T12:30:02Z"},"end":{"format":"date-time","description":"The date and time when the appointment will end","type":"string","example":"2019-08-14T12:30:02Z"},"followUpOn":{"format":"date","description":"The date when the appointment should be followed up","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the appointment type","type":"string"},"description":{"description":"A free text description about the appointment","type":"string"},"propertyId":{"description":"The unique identifier of the property related to the appointment","type":"string"},"otherAgentId":{"description":"The unique identifier of the external company either carrying out or attending the appointment with the agent","type":"string"},"organiserId":{"description":"The unique identifier of the negotiator that organised the appointment","type":"string"},"cancelled":{"description":"A flag denoting whether or not the appointment has been cancelled","type":"boolean"},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the appointment. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the appointment. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"attendee":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee. To clear an attendee this can be passed as an empty string.","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"},"confirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"}}},"accompanied":{"description":"A flag denoting whether or not the appointment will be accompanied by one or more negotiators","type":"boolean"},"virtual":{"description":"A flag denoting whether or not the appointment is virtual","type":"boolean"},"isRepeat":{"description":"A flag denoting whether or not the appointment is a subsequent appointment to a previous one (a repeat appointment for the same attendee)","type":"boolean"},"negotiatorConfirmed":{"description":"A flag denoting whether or not the main negotiator has confirmed their attendance","type":"boolean"},"attendeeConfirmed":{"description":"A flag denoting whether or not the attendee has confirmed their attendance","type":"boolean"},"propertyConfirmed":{"description":"A flag denoting whether or not the property and/or property's vendor has confirmed their attendance","type":"boolean"},"attended":{"description":"The attendance status of the appointment (notSet/noShow/attended)","type":"string"},"followUp":{"description":"Represents the follow up information on a single appointment","type":"object","properties":{"responseId":{"description":"The unique identifier of a pre-defined follow up response type","type":"string"},"notes":{"description":"The internal follow up notes to be stored against the appointment","type":"string"}}},"recurrence":{"description":"Details of an appointment's recurrence pattern","type":"object","properties":{"type":{"description":"The type of unit that the `interval` applies to (daily/weekly/yearly/monthly)","type":"string"},"interval":{"format":"int32","description":"The numeric value denoting how often the appointment will recur","type":"integer"},"until":{"format":"date-time","description":"The date and time when the recurrence will stop","type":"string","example":"2019-08-14T12:30:02Z"}}},"documents":{"description":"A view of the documents associated to the appointment","type":"object","properties":{"draftPropertyInspectionReportId":{"description":"The unique identifier of the draft property inspection report document","type":"string"},"finalPropertyInspectionReportId":{"description":"The unique identifier of the final property inspection report document","type":"string"}}},"metadata":{"description":"App specific metadata to set against the appointment","type":"object","additionalProperties":{}}},"example":{"start":"2018-08-14T12:30:02Z","end":"2018-08-14T13:30:02Z","followUpOn":"2018-10-05","typeId":"VW","description":"Meet landlord at the property to get the key.","propertyId":"OXF190022","otherAgentId":null,"organiserId":"JAS","cancelled":false,"negotiatorIds":["JAS"],"officeIds":["OXF","SOL"],"attendee":{"id":"OXF20001","type":"applicant","confirmed":false},"accompanied":true,"virtual":null,"isRepeat":null,"negotiatorConfirmed":true,"attendeeConfirmed":true,"propertyConfirmed":true,"attended":"notSet","followUp":{"responseId":"OXF190022","notes":"Meet at the property."},"recurrence":null,"documents":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"OpenHouseAttendeeModel":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the open house attendee","type":"string"},"openHouseId":{"description":"The unique identifier of the open house appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the open house attendee was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the open house attendee was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes taken regarding the open house attendee","type":"string"},"interestLevel":{"description":"The open house attendees interest level (veryInterested/notInterested/possibleInterest)","type":"string"},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"_eTag":{"description":"The ETag for the current version of the open house attendee. Used for managing update concurrency","type":"string","readOnly":true}}},"OpenHouseAttendeeModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a calendar appointment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the open house attendee","type":"string"},"openHouseId":{"description":"The unique identifier of the open house appointment","type":"string"},"created":{"format":"date-time","description":"The date and time when the open house attendee was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the open house attendee was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes taken regarding the open house attendee","type":"string"},"interestLevel":{"description":"The open house attendees interest level (veryInterested/notInterested/possibleInterest)","type":"string"},"attendee":{"description":"An appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee","type":"string"},"contacts":{"description":"A collection of contacts relating to the attendee","type":"array","items":{"description":"A summarised view of the details of a contact associated to an appointment attendee","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"title":{"description":"The title of the contact (e.g. Ms, Mr, Mrs, Dr)","type":"string"},"forename":{"description":"The forename of the contact","type":"string"},"surname":{"description":"The surname of the contact","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"fromArchive":{"description":"A flag determining if the related contact is archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"}}}}}},"_eTag":{"description":"The ETag for the current version of the open house attendee. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateOpenHouseAttendeeModel":{"description":"Request body used to create a new open house attendee","type":"object","properties":{"interestLevel":{"description":"The interest level of the open house attendee (veryInterested/mightBeInterested/notInterested/notSet)","type":"string"},"notes":{"description":"Notes on this open house attendee","type":"string"},"attendee":{"description":"Represents an external attendee on an appointment","type":"object","properties":{"id":{"description":"The unique identifier of the attendee","type":"string"},"type":{"description":"The type of attendee (applicant/contact/landlord/tenant)","type":"string"}}}},"example":{"interestLevel":"veryInterested","notes":"Coming back for a second viewing.","attendee":{"id":"OXF200001","type":"applicant"}}},"UpdateOpenHouseAttendeeModel":{"description":"Request body used to upda te a new open house attendee","type":"object","properties":{"interestLevel":{"description":"The interest level of the open house attendee (veryInterested/mightBeInterested/notInterested/notSet)","type":"string"},"notes":{"description":"Notes on this open house attendee","type":"string"}},"example":{"interestLevel":"mightBeInterested","notes":"Coming back for a second viewing."}},"AuctionModel":{"description":"Represents an auction","type":"object","properties":{"id":{"description":"The unique identifier of the auction","type":"string"},"auctionCode":{"description":"The code of the auction","type":"string"},"venueId":{"description":"The unique identifier of the venue","type":"string"}}},"LotModel":{"description":"Represents an auction lot","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the lot","type":"string"},"created":{"format":"date-time","description":"The date and time when the lot was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the lot was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this lot is for","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator handling this lot","type":"string"},"lotNumber":{"description":"The number for this lot","type":"string"},"status":{"description":"The status of the property in the lot","type":"string"},"auction":{"description":"Represents an auction","type":"object","properties":{"id":{"description":"The unique identifier of the auction","type":"string"},"auctionCode":{"description":"The code of the auction","type":"string"},"venueId":{"description":"The unique identifier of the venue","type":"string"}}}}},"LotModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents an auction lot","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the lot","type":"string"},"created":{"format":"date-time","description":"The date and time when the lot was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the lot was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this lot is for","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator handling this lot","type":"string"},"lotNumber":{"description":"The number for this lot","type":"string"},"status":{"description":"The status of the property in the lot","type":"string"},"auction":{"description":"Represents an auction","type":"object","properties":{"id":{"description":"The unique identifier of the auction","type":"string"},"auctionCode":{"description":"The code of the auction","type":"string"},"venueId":{"description":"The unique identifier of the venue","type":"string"}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CertificateModel":{"type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate.","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property associated with this certificate.","type":"string"},"estateId":{"description":"The unique identifier of the estate associated with this certificate.","type":"string"},"blockId":{"description":"The unique identifier of the block associated with this certificate.","type":"string"},"companyId":{"description":"The unique identifier of the company which provides this certificate.","type":"string"},"category":{"description":"The cartificate category.","type":"string"},"type":{"description":"The type of certificate.","type":"string"},"statusId":{"description":"The status ID of the certificate.","type":"string"},"notes":{"description":"General notes relating to the certificate.","type":"string"},"startDate":{"format":"date-time","description":"The start date.","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The end date.","type":"string","example":"2019-08-14T12:30:02Z"}}},"CertificateModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate.","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property associated with this certificate.","type":"string"},"estateId":{"description":"The unique identifier of the estate associated with this certificate.","type":"string"},"blockId":{"description":"The unique identifier of the block associated with this certificate.","type":"string"},"companyId":{"description":"The unique identifier of the company which provides this certificate.","type":"string"},"category":{"description":"The cartificate category.","type":"string"},"type":{"description":"The type of certificate.","type":"string"},"statusId":{"description":"The status ID of the certificate.","type":"string"},"notes":{"description":"General notes relating to the certificate.","type":"string"},"startDate":{"format":"date-time","description":"The start date.","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The end date.","type":"string","example":"2019-08-14T12:30:02Z"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CertificateApiErrorModel":{"description":"Model for exposing error details to API consumers","type":"object","properties":{"statusCode":{"format":"int32","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer"},"dateTime":{"format":"date-time","description":"The date and time that this error event occurred","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"The detailed information regarding this error event","type":"string"}}},"CompanyAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"country":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"CompanyPaymentsModel":{"description":"Representation of the payments and terms configuration for a company","type":"object","properties":{"nominalAccountId":{"description":"The identifier of the nominal code selected in the payments and terms configuration","type":"string"},"agentCommissionPercentage":{"format":"double","description":"The commission paid as a percentage to the agent","type":"number"},"referralFee":{"format":"double","description":"The fixed referral amount the supplier receives","type":"number"}}},"AdditionalCompanyContactDetailsModel":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}},"CompanyRoleModel":{"description":"Representation of the roles that an individual companies possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the related company","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}},"CompanyModel":{"description":"Representation of a company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the company","type":"string"},"created":{"format":"date-time","description":"The date and time when the company was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the company was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company","type":"string"},"email":{"description":"The email address of the company","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the company was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the company is archived","type":"boolean"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"country":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"payments":{"description":"Representation of the payments and terms configuration for a company","type":"object","properties":{"nominalAccountId":{"description":"The identifier of the nominal code selected in the payments and terms configuration","type":"string"},"agentCommissionPercentage":{"format":"double","description":"The commission paid as a percentage to the agent","type":"number"},"referralFee":{"format":"double","description":"The fixed referral amount the supplier receives","type":"number"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the company. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the company. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the company","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the company. Used for managing update concurrency","type":"string","readOnly":true},"relationships":{"description":"A list of relationships belonging to the company. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual companies possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the related company","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}}}},"CompanyModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the company","type":"string"},"created":{"format":"date-time","description":"The date and time when the company was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the company was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company","type":"string"},"email":{"description":"The email address of the company","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the company was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the company is archived","type":"boolean"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"country":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"payments":{"description":"Representation of the payments and terms configuration for a company","type":"object","properties":{"nominalAccountId":{"description":"The identifier of the nominal code selected in the payments and terms configuration","type":"string"},"agentCommissionPercentage":{"format":"double","description":"The commission paid as a percentage to the agent","type":"number"},"referralFee":{"format":"double","description":"The fixed referral amount the supplier receives","type":"number"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the company. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the company. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the company","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the company. Used for managing update concurrency","type":"string","readOnly":true},"relationships":{"description":"A list of relationships belonging to the company. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual companies possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the related company","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateCompanyAddressModel":{"description":"Request body to set the address of a new company","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"CreateCompanyModel":{"description":"Request body used to create a new company","required":["name","typeIds"],"type":"object","properties":{"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company. (Required when no other company or address details are provided)","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company. (Required when no other company or address details are provided)","type":"string"},"email":{"description":"The email address of the company. (Required when no other company or address details are provided)","type":"string"},"address":{"description":"Request body to set the address of a new company","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata to set against the company","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","branch":"Oxford","notes":"Founded in 1997, The Reapit Group is a property software provider of CRM and property management solutions specialising in the residential real estate sector","active":true,"marketingConsent":"deny","vatRegistered":true,"typeIds":["SP"],"supplierTypeId":"MG","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"type":null,"buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"communicationPreferenceLetter":false,"communicationPreferenceEmail":true,"communicationPreferencePhone":false,"communicationPreferenceSms":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateCompanyAddressModel":{"description":"Request body to set the address of an existing company","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"UpdateCompanyModel":{"description":"Request body used to update an existing company","type":"object","properties":{"name":{"description":"The name of the company","type":"string"},"branch":{"description":"The branch name of the company","type":"string"},"notes":{"description":"A free text field containing notes that describe the company's business or service offering","type":"string"},"active":{"description":"A flag determining whether or not the company is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the company (deny/notAsked)","type":"string"},"vatRegistered":{"description":"A flag determining whether or not the company is VAT registered","type":"boolean"},"typeIds":{"description":"A collection of unique identifiers of company types that categorise the type of business the company operates","type":"array","items":{"type":"string"}},"supplierTypeId":{"description":"The unique identifier of a supplier type, if the company is a supplier","type":"string"},"workPhone":{"description":"The work phone number of the company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the company","type":"string"},"email":{"description":"The email address of the company","type":"string"},"address":{"description":"Request body to set the address of an existing company","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the company is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the company is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the company is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSms":{"description":"A flag determining whether or not the company is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata to set against the company","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","branch":"Oxford","notes":"Founded in 1997, The Reapit Group is a property software provider of CRM and property management solutions specialising in the residential real estate sector","active":true,"marketingConsent":"deny","vatRegistered":true,"typeIds":["SP"],"supplierTypeId":"MG","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"type":null,"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"communicationPreferenceLetter":false,"communicationPreferenceEmail":true,"communicationPreferencePhone":false,"communicationPreferenceSms":false,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"CompanyRoleModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of the roles that an individual companies possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the related company","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"StaffModel":{"description":"Representation of a staff member","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact.","type":"string"},"index":{"description":"The index of the staff member when they are not a full contact","type":"string"},"name":{"description":"The staff member's name","type":"string"},"active":{"description":"A flag determining whether or not the staff member is currently active","type":"boolean"},"jobTitle":{"description":"The staff member's job title","type":"string"},"workPhone":{"description":"The staff member's work phone","type":"string"},"mobilePhone":{"description":"The staff member's mobile phone","type":"string"},"email":{"description":"The staff member's email","type":"string"},"salutation":{"description":"The staff member's preferred salutation","type":"string"},"isContact":{"description":"Flag to determine if this staff member is a full contact.","type":"boolean"},"isMainContact":{"description":"Flag to determin if this staff member is a main contact","type":"boolean"}}},"StaffModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a staff member","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact.","type":"string"},"index":{"description":"The index of the staff member when they are not a full contact","type":"string"},"name":{"description":"The staff member's name","type":"string"},"active":{"description":"A flag determining whether or not the staff member is currently active","type":"boolean"},"jobTitle":{"description":"The staff member's job title","type":"string"},"workPhone":{"description":"The staff member's work phone","type":"string"},"mobilePhone":{"description":"The staff member's mobile phone","type":"string"},"email":{"description":"The staff member's email","type":"string"},"salutation":{"description":"The staff member's preferred salutation","type":"string"},"isContact":{"description":"Flag to determine if this staff member is a full contact.","type":"boolean"},"isMainContact":{"description":"Flag to determin if this staff member is a main contact","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"AccreditationModel":{"description":"Represents an accreditation for a company.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the company","type":"string"},"created":{"format":"date-time","description":"The date and time when the company was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the company was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of accreditation.","type":"string"},"expiry":{"format":"date-time","description":"The date of expiry for the accreditation.","type":"string","example":"2019-08-14T12:30:02Z"},"details":{"description":"The details relating to this accreditation.","type":"string"},"_eTag":{"description":"The ETag for the current version of the company. Used for managing update concurrency","type":"string","readOnly":true}}},"AccreditationModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents an accreditation for a company.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the company","type":"string"},"created":{"format":"date-time","description":"The date and time when the company was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the company was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of accreditation.","type":"string"},"expiry":{"format":"date-time","description":"The date of expiry for the accreditation.","type":"string","example":"2019-08-14T12:30:02Z"},"details":{"description":"The details relating to this accreditation.","type":"string"},"_eTag":{"description":"The ETag for the current version of the company. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"UpdateAccreditationModel":{"description":"Request body used to update an existing company accreditation","type":"object","properties":{"expiry":{"format":"date-time","description":"The date of expiry for the accreditation.","type":"string","example":"2019-08-14T12:30:02Z"},"details":{"description":"The details relating to this accreditation.","type":"string"}},"example":{"expiry":"2027-06-18T18:13:39.3438235Z","details":"Updated accreditation details"}},"ListItemModel":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}},"ListItemTypeModel":{"description":"Representation of heirarchical category configuration items with a type.","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"type":{"description":"The category type.","type":"string"}}},"TypeModel":{"description":"Representation of all of the available configurable items","type":"object","properties":{"agencyTypes":{"description":"A list of configurable agency types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"appointmentTypes":{"description":"A list of configurable appointment types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"applicantStatuses":{"description":"A list of configurable applicant statuses","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"boardStatuses":{"description":"A list of configurable board statuses","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"buyingPositions":{"description":"A list of configurable buying positions","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"buyingReasons":{"description":"A list of configurable buying reasons","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"certificateTypes":{"description":"A list of configurable certificate types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"companyTypes":{"description":"A list of configurable company types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"contactCategories":{"description":"A list of configurable contact categories","type":"array","items":{"description":"Representation of heirarchical category configuration items with a type.","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"type":{"description":"The category type.","type":"string"}}}},"documentTypes":{"description":"A list of configurable document types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"identityDocumentTypes":{"description":"A list of configurable identity document types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"journalEntryTypes":{"description":"A list of configurable journal entry types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"keyTypes":{"description":"A list of configurable key types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"followUpResponses":{"description":"A list of configurable follow up responses","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"sellingReasons":{"description":"A list of configurable selling reasons","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"rentInsuranceCancellationReasons":{"description":"A list of configurable rent insurance cancellation reasons","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"rentingPositions":{"description":"A list of configurable renting positions","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"supplierTypes":{"description":"A list of configurable supplier types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"taskTypes":{"description":"A list of configurable task types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"tenancyLegalStatuses":{"description":"A list of configurable tenancy legal status","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"tenancyTypes":{"description":"A list of configurable tenancy types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"vendorTypes":{"description":"A list of configurable vendor types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}},"worksOrderTypes":{"description":"A list of configurable works order types","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}}},"CertificateTypeModel":{"description":"Representation of a certificate type","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"statuses":{"description":"The configurable statuses associated to the certificate type","type":"array","items":{"description":"Representation of a configuration item","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"}}}}}},"ListItemDetailModel":{"description":"Representation of detail properties configuration item\r\nconfiguration","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"active":{"description":"A flag determining the status","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices associated","type":"array","items":{"type":"string"}}}},"PropertyTerminologyModel":{"description":"Terminologies associated with the properties","type":"object","properties":{"useSoldStc":{"description":"A flag denoting whether the agent's CRM is configured to use \"Sold STC/SSTC\" terminology instead of \"Under Offer\"","type":"boolean"},"useMarketAppraisal":{"description":"A flag denoting whether the agent's CRM is configured to use \"Market Appraisal\" terminology instead of \"Valuation\"","type":"boolean"}}},"TerminologyModel":{"description":"Representation of the configuration settings for terminology","type":"object","properties":{"properties":{"description":"Terminologies associated with the properties","type":"object","properties":{"useSoldStc":{"description":"A flag denoting whether the agent's CRM is configured to use \"Sold STC/SSTC\" terminology instead of \"Under Offer\"","type":"boolean"},"useMarketAppraisal":{"description":"A flag denoting whether the agent's CRM is configured to use \"Market Appraisal\" terminology instead of \"Valuation\"","type":"boolean"}}}}},"ListItemCategoryModel":{"description":"Representation of heirarchical category configuration items with a category","type":"object","properties":{"id":{"description":"The unique identifier of the list item","type":"string"},"value":{"description":"The textual value for the list item","type":"string"},"category":{"description":"The category for the list item","type":"string"}}},"DescriptionModel":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"PropertyDescriptionModel":{"type":"object","properties":{"description1":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description2":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description3":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description4":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description5":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}},"description6":{"description":"Representation of a description field model","type":"object","properties":{"caption":{"description":"The caption of the description field","type":"string"},"name":{"description":"The name of the description field","type":"string"},"maxLength":{"format":"int32","description":"The max length of the description field","type":"integer"}}}}},"ContactSourceModel":{"description":"Representation of a contact's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"ContactAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"ContactRoleModel":{"description":"Representation of the roles that an individual contacts possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"contactId":{"description":"The unique identifier of the related contact","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}},"LandlordDetailsModel":{"description":"Representation of landlord details for a contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact landlord details","type":"string"},"makingTaxDigitalOptInStatus":{"description":"The making tax digital opt-in state (notAsked/optedIn/optedOut)","type":"string"},"makingTaxDigitalOptInStatusDate":{"format":"date-time","description":"The date when the making tax digital opt-in state was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state (notSet/invited/accepted/revoked)","type":"string"}}},"ContactModel":{"description":"Representation of an individual contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact","type":"string"},"created":{"format":"date-time","description":"The date and time when the contact was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the contact was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"identityCheck":{"description":"The status of the last identity check performed against the contact (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"source":{"description":"Representation of a contact's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the contact was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the contact is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"secondaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"workAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the contact","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the contact. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"relationships":{"description":"A list of relationships belonging to the contact. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual contacts possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"contactId":{"description":"The unique identifier of the related contact","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"landlordDetails":{"description":"Representation of landlord details for a contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact landlord details","type":"string"},"makingTaxDigitalOptInStatus":{"description":"The making tax digital opt-in state (notAsked/optedIn/optedOut)","type":"string"},"makingTaxDigitalOptInStatusDate":{"format":"date-time","description":"The date when the making tax digital opt-in state was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state (notSet/invited/accepted/revoked)","type":"string"}}}}},"ContactModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact","type":"string"},"created":{"format":"date-time","description":"The date and time when the contact was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the contact was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"identityCheck":{"description":"The status of the last identity check performed against the contact (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"source":{"description":"Representation of a contact's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"archivedOn":{"format":"date-time","description":"The date and time the contact was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the contact is archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"secondaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"workAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the contact","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the contact. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"relationships":{"description":"A list of relationships belonging to the contact. This is later removed from the response","type":"array","items":{"description":"Representation of the roles that an individual contacts possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"contactId":{"description":"The unique identifier of the related contact","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"landlordDetails":{"description":"Representation of landlord details for a contact","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the contact landlord details","type":"string"},"makingTaxDigitalOptInStatus":{"description":"The making tax digital opt-in state (notAsked/optedIn/optedOut)","type":"string"},"makingTaxDigitalOptInStatusDate":{"format":"date-time","description":"The date when the making tax digital opt-in state was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state (notSet/invited/accepted/revoked)","type":"string"}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateContactSourceModel":{"description":"Request body used to set the source of a new contact","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"CreateContactAddressModel":{"description":"Request body used to set an address against a new contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"CreateContactModel":{"description":"Request body used to create a new contact","required":["surname","marketingConsent","officeIds","negotiatorIds"],"type":"object","properties":{"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"source":{"description":"Request body used to set the source of a new contact","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact (Required when no other contact details are provided)","type":"string"},"workPhone":{"description":"The work phone number of the contact (Required when no other contact details are provided)","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact (Required when no other contact details are provided)","type":"string"},"email":{"description":"The email address of the contact (Required when no other contact details are provided)","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"primaryAddress":{"description":"Request body used to set an address against a new contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"secondaryAddress":{"description":"Request body used to set an address against a new contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"workAddress":{"description":"Request body used to set an address against a new contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"metadata":{"description":"App specific metadata to set against the contact","type":"object","additionalProperties":{}}},"example":{"title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","active":true,"marketingConsent":"grant","source":{"id":"SOL","type":"office"},"homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","officeIds":["OXF"],"negotiatorIds":["JAS"],"categoryIds":[],"primaryAddress":{"type":"primary","buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB"},"secondaryAddress":null,"workAddress":{"type":"work","buildingName":"","buildingNumber":"44","line1":"Test street","line2":"Shirley","line3":"West Midlands","line4":"","postcode":"B90 1ZZ","countryId":"GB"},"communicationPreferenceLetter":true,"communicationPreferenceEmail":true,"communicationPreferencePhone":true,"communicationPreferenceSMS":true,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"UpdateContactSourceModel":{"description":"Request body used to update the source of an existing contact","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"UpdateContactAddressModel":{"description":"Request body used to update an address on an existing contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the adderess resides in","type":"string"}}},"UpdateContactModel":{"description":"Request body used to update an existing contact","type":"object","properties":{"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"dateOfBirth":{"format":"date","description":"The contact's date of birth","type":"string","example":"2019-08-14"},"active":{"description":"A flag determining whether or not the contact is currently active","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked)","type":"string"},"source":{"description":"Request body used to update the source of an existing contact","type":"object","properties":{"id":{"description":"The unique identifier of the source of the contact","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the contact. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"negotiatorIds":{"description":"A collection of unique identifiers of negotiators attached to the contact. The first item in the collection is considered the primary negotiator","type":"array","items":{"type":"string"}},"categoryIds":{"description":"A collection of categories associated to the contact.","type":"array","items":{"type":"string"}},"primaryAddress":{"description":"Request body used to update an address on an existing contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the adderess resides in","type":"string"}}},"secondaryAddress":{"description":"Request body used to update an address on an existing contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the adderess resides in","type":"string"}}},"workAddress":{"description":"Request body used to update an address on an existing contact","type":"object","properties":{"type":{"description":"The type of address (primary/secondary/home/work/forwarding/company/previous)","type":"string"},"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the adderess resides in","type":"string"}}},"communicationPreferenceLetter":{"description":"A flag determining whether or not the contact is happy to receive communications by letter","type":"boolean"},"communicationPreferenceEmail":{"description":"A flag determining whether or not the contact is happy to receive communications by email","type":"boolean"},"communicationPreferencePhone":{"description":"A flag determining whether or not the contact is happy to receive communications by phone","type":"boolean"},"communicationPreferenceSMS":{"description":"A flag determining whether or not the contact is happy to receive communications by SMS","type":"boolean"},"fromArchive":{"description":"A flag determining whether the contact is archived","type":"boolean"},"metadata":{"description":"App specific metadata to set against the contact","type":"object","additionalProperties":{}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"object","additionalProperties":{"type":"string"}}},"example":{"title":"Mr","forename":"John","surname":"Smith","dateOfBirth":"1992-08-12","active":true,"marketingConsent":"grant","source":{"id":"SOL","type":"office"},"homePhone":"01234 567890","workPhone":null,"mobilePhone":"07890 123456","email":"example@email.com","officeIds":["OXF"],"negotiatorIds":["JAS"],"categoryIds":null,"primaryAddress":{"type":"primary","buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":null,"postcode":"B91 2XX","countryId":"GB"},"secondaryAddress":null,"workAddress":{"type":"work","buildingName":null,"buildingNumber":"44","line1":"Test street","line2":"Shirley","line3":"West Midlands","line4":null,"postcode":"B90 1ZZ","countryId":"GB"},"communicationPreferenceLetter":true,"communicationPreferenceEmail":false,"communicationPreferencePhone":false,"communicationPreferenceSMS":false,"fromArchive":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"},"additionalContactDetails":{"Wifes Mobile":"07123 456789","Son":"example2@gmail.com"}}},"ContactRoleModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of the roles that an individual contacts possesses","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"contactId":{"description":"The unique identifier of the related contact","type":"string"},"associatedType":{"description":"The type of related entity (applicant/landlord/offer/tenancy/vendor)","type":"string"},"associatedId":{"description":"The unique identifier of the related entity","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"ContactSubscriptionModel":{"description":"Representation of an individual contact subscription","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the subscription","type":"string"},"contactId":{"description":"The unique identifier of the contact the subscription is associated with","type":"string"},"name":{"description":"The name of the subscription","type":"string"},"group":{"description":"The name of the group this subscription belongs to, if applicable","type":"string"},"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"},"type":{"description":"The type of subscription (mailing/event)","type":"string"},"subscribedOn":{"format":"date-time","description":"The date and time when the subscription was started for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"},"unsubscribedOn":{"format":"date-time","description":"The date and time when the subscription was terminated for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"}}},"ContactSubscriptionModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual contact subscription","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the subscription","type":"string"},"contactId":{"description":"The unique identifier of the contact the subscription is associated with","type":"string"},"name":{"description":"The name of the subscription","type":"string"},"group":{"description":"The name of the group this subscription belongs to, if applicable","type":"string"},"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"},"type":{"description":"The type of subscription (mailing/event)","type":"string"},"subscribedOn":{"format":"date-time","description":"The date and time when the subscription was started for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"},"unsubscribedOn":{"format":"date-time","description":"The date and time when the subscription was terminated for the associated contact","type":"string","example":"2019-08-14T12:30:02Z"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"BulkUpdateContactSubscriptionModel":{"description":"Request body used to update an existing contact subscription","type":"object","properties":{"groupName":{"description":"The name of the group the contact is subscribed to","type":"string"},"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"}},"example":{"groupName":"Mailing Header","status":"subscribed"}},"UpdateContactSubscriptionModel":{"description":"Request body used to update an existing contact subscription","type":"object","properties":{"status":{"description":"The status of the subscription (subscribed/unsubscribed)","type":"string"}},"example":{"status":"unsubscribed"}},"UpdateLandlordDetailsModel":{"description":"Request body used to update landlord details for a contact","type":"object","properties":{"makingTaxDigitalConsentStatus":{"description":"The making tax digital consent state description (notSet/invited/accepted/revoked)","type":"string"}},"example":{"makingTaxDigitalConsentStatus":"invited"}},"MilestoneModel":{"description":"Represents a milestone model.","type":"object","properties":{"name":{"description":"Gets or sets the name associated with the object.","type":"string"},"status":{"description":"Gets or sets the status of the milestone.","type":"string"},"modified":{"format":"date-time","description":"The date and time when the milestone was modified.","type":"string","example":"2019-08-14T12:30:02Z"}}},"CheckListItemModel":{"description":"Representation of a check list item","type":"object","properties":{"name":{"description":"The name of the check list item","type":"string"},"completed":{"description":"A flag to determine if the item is completed","type":"boolean"},"completedDate":{"format":"date","description":"The date when the item was completed","type":"string","example":"2019-08-14"}}},"SolicitorContactModel":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"ConveyancingModel":{"description":"Representation of an offers sales progression information","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"milestones":{"description":"A collection of milestones associated to the offer","type":"array","items":{"description":"Represents a milestone model.","type":"object","properties":{"name":{"description":"Gets or sets the name associated with the object.","type":"string"},"status":{"description":"Gets or sets the status of the milestone.","type":"string"},"modified":{"format":"date-time","description":"The date and time when the milestone was modified.","type":"string","example":"2019-08-14T12:30:02Z"}}}},"modified":{"format":"date-time","description":"The date and time when the offer was modified","type":"string","example":"2019-08-14T12:30:02Z"},"isExternal":{"description":"Flag set to true if this offer is external","type":"boolean"},"propertyId":{"description":"The unique identifier of the property that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"propertyAddress":{"description":"The address of the property that this offer is associated to","type":"string"},"vendor":{"description":"The full name of the vendor of the property","type":"string"},"vendorId":{"description":"The unique identifier of the vendor that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"vendorSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed","type":"string"},"buyer":{"description":"The full name of the buyer who has submitted the offer","type":"string"},"buyerId":{"description":"The unique identifier of the contact that represents this buyer. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the buyer has instructed","type":"string"},"externalAgent":{"description":"The name of the agent who is marketing the property, where the offer is external and and relates to a property not instructed to the agent","type":"string"},"externalAgentId":{"description":"The unique identifier of the agent company that holds the property instruction","type":"string"},"upwardChainId":{"description":"The unique identifier of the offer that sits above this one in the chain (where known)","type":"string"},"downwardChainId":{"description":"The unique identifier of the offer that sits below this one in the chain (where known)","type":"string"},"fixturesAndFittingsCompleted":{"format":"date","description":"The date when the fixtures and fittings form has been completed","type":"string","example":"2019-08-14"},"deedsRequested":{"format":"date","description":"The date when the title deeds were requested from land registry","type":"string","example":"2019-08-14"},"deedsReceived":{"format":"date","description":"The date when the title deeds were received from land registry","type":"string","example":"2019-08-14"},"enquiriesSent":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were sent","type":"string","example":"2019-08-14"},"enquiriesAnswered":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were answered","type":"string","example":"2019-08-14"},"searchesPaid":{"format":"date","description":"The date when the buyer paid for conveyancing searches","type":"string","example":"2019-08-14"},"searchesApplied":{"format":"date","description":"The date when conveyancing searches were applied for","type":"string","example":"2019-08-14"},"searchesReceived":{"format":"date","description":"The date when conveyancing searches were received for","type":"string","example":"2019-08-14"},"contractSent":{"format":"date","description":"The date when the draft contract was sent","type":"string","example":"2019-08-14"},"contractReceived":{"format":"date","description":"The date when the draft contract was received","type":"string","example":"2019-08-14"},"contractApproved":{"format":"date","description":"The date when the contract was approved","type":"string","example":"2019-08-14"},"contractVendorSigned":{"format":"date","description":"The date when the vendor signed the approved contract","type":"string","example":"2019-08-14"},"contractBuyerSigned":{"format":"date","description":"The date when the buyer signed the approved contract","type":"string","example":"2019-08-14"},"mortgageRequired":{"description":"Indication of whether the buyer will require a mortgage to fund the purchase (yes/no/unknown)","type":"string"},"mortgageLoanPercentage":{"format":"int32","description":"The loan to value percentage of the mortgage required","type":"integer"},"mortgageSubmitted":{"format":"date","description":"The date when the mortgage application was submitted","type":"string","example":"2019-08-14"},"mortgageOfferReceived":{"format":"date","description":"The date when the mortgage offer was received","type":"string","example":"2019-08-14"},"mortgageLenderId":{"description":"The unique identifier of the company who will provide the mortgage","type":"string"},"mortgageBrokerId":{"description":"The unique identifier of the company who brokered the mortgage","type":"string"},"mortgageSurveyDate":{"format":"date","description":"The date of the mortgage valuation/survey","type":"string","example":"2019-08-14"},"mortgageSurveyorId":{"description":"The unique identifier of the company who will perform the mortgage valuation/survey","type":"string"},"additionalSurveyRequired":{"description":"Indication of whether the buyer requires that an additional survey take place  (yes/no/unknown)","type":"string"},"additionalSurveyDate":{"format":"date","description":"The date of the additional survey","type":"string","example":"2019-08-14"},"additionalSurveyorId":{"description":"The unique identifier of the company who will perform the additional survey","type":"string"},"exchangedVendor":{"format":"date","description":"The date when the vendor conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"exchangedBuyer":{"format":"date","description":"The date when the buyer conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"completion":{"format":"date","description":"The date when the sale completed","type":"string","example":"2019-08-14"},"checkListItems":{"description":"Check list items to be completed as part of the sales progression process","type":"array","items":{"description":"Representation of a check list item","type":"object","properties":{"name":{"description":"The name of the check list item","type":"string"},"completed":{"description":"A flag to determine if the item is completed","type":"boolean"},"completedDate":{"format":"date","description":"The date when the item was completed","type":"string","example":"2019-08-14"}}}},"buyerSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"vendorSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of this conveyancing record. Used for managing update concurrency","type":"string","readOnly":true},"metadata":{"description":"App specific metadata that has been set against this conveyancing record","type":"object","additionalProperties":{}}}},"ConveyancingModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an offers sales progression information","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"milestones":{"description":"A collection of milestones associated to the offer","type":"array","items":{"description":"Represents a milestone model.","type":"object","properties":{"name":{"description":"Gets or sets the name associated with the object.","type":"string"},"status":{"description":"Gets or sets the status of the milestone.","type":"string"},"modified":{"format":"date-time","description":"The date and time when the milestone was modified.","type":"string","example":"2019-08-14T12:30:02Z"}}}},"modified":{"format":"date-time","description":"The date and time when the offer was modified","type":"string","example":"2019-08-14T12:30:02Z"},"isExternal":{"description":"Flag set to true if this offer is external","type":"boolean"},"propertyId":{"description":"The unique identifier of the property that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"propertyAddress":{"description":"The address of the property that this offer is associated to","type":"string"},"vendor":{"description":"The full name of the vendor of the property","type":"string"},"vendorId":{"description":"The unique identifier of the vendor that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"vendorSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed","type":"string"},"buyer":{"description":"The full name of the buyer who has submitted the offer","type":"string"},"buyerId":{"description":"The unique identifier of the contact that represents this buyer. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the buyer has instructed","type":"string"},"externalAgent":{"description":"The name of the agent who is marketing the property, where the offer is external and and relates to a property not instructed to the agent","type":"string"},"externalAgentId":{"description":"The unique identifier of the agent company that holds the property instruction","type":"string"},"upwardChainId":{"description":"The unique identifier of the offer that sits above this one in the chain (where known)","type":"string"},"downwardChainId":{"description":"The unique identifier of the offer that sits below this one in the chain (where known)","type":"string"},"fixturesAndFittingsCompleted":{"format":"date","description":"The date when the fixtures and fittings form has been completed","type":"string","example":"2019-08-14"},"deedsRequested":{"format":"date","description":"The date when the title deeds were requested from land registry","type":"string","example":"2019-08-14"},"deedsReceived":{"format":"date","description":"The date when the title deeds were received from land registry","type":"string","example":"2019-08-14"},"enquiriesSent":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were sent","type":"string","example":"2019-08-14"},"enquiriesAnswered":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were answered","type":"string","example":"2019-08-14"},"searchesPaid":{"format":"date","description":"The date when the buyer paid for conveyancing searches","type":"string","example":"2019-08-14"},"searchesApplied":{"format":"date","description":"The date when conveyancing searches were applied for","type":"string","example":"2019-08-14"},"searchesReceived":{"format":"date","description":"The date when conveyancing searches were received for","type":"string","example":"2019-08-14"},"contractSent":{"format":"date","description":"The date when the draft contract was sent","type":"string","example":"2019-08-14"},"contractReceived":{"format":"date","description":"The date when the draft contract was received","type":"string","example":"2019-08-14"},"contractApproved":{"format":"date","description":"The date when the contract was approved","type":"string","example":"2019-08-14"},"contractVendorSigned":{"format":"date","description":"The date when the vendor signed the approved contract","type":"string","example":"2019-08-14"},"contractBuyerSigned":{"format":"date","description":"The date when the buyer signed the approved contract","type":"string","example":"2019-08-14"},"mortgageRequired":{"description":"Indication of whether the buyer will require a mortgage to fund the purchase (yes/no/unknown)","type":"string"},"mortgageLoanPercentage":{"format":"int32","description":"The loan to value percentage of the mortgage required","type":"integer"},"mortgageSubmitted":{"format":"date","description":"The date when the mortgage application was submitted","type":"string","example":"2019-08-14"},"mortgageOfferReceived":{"format":"date","description":"The date when the mortgage offer was received","type":"string","example":"2019-08-14"},"mortgageLenderId":{"description":"The unique identifier of the company who will provide the mortgage","type":"string"},"mortgageBrokerId":{"description":"The unique identifier of the company who brokered the mortgage","type":"string"},"mortgageSurveyDate":{"format":"date","description":"The date of the mortgage valuation/survey","type":"string","example":"2019-08-14"},"mortgageSurveyorId":{"description":"The unique identifier of the company who will perform the mortgage valuation/survey","type":"string"},"additionalSurveyRequired":{"description":"Indication of whether the buyer requires that an additional survey take place  (yes/no/unknown)","type":"string"},"additionalSurveyDate":{"format":"date","description":"The date of the additional survey","type":"string","example":"2019-08-14"},"additionalSurveyorId":{"description":"The unique identifier of the company who will perform the additional survey","type":"string"},"exchangedVendor":{"format":"date","description":"The date when the vendor conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"exchangedBuyer":{"format":"date","description":"The date when the buyer conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"completion":{"format":"date","description":"The date when the sale completed","type":"string","example":"2019-08-14"},"checkListItems":{"description":"Check list items to be completed as part of the sales progression process","type":"array","items":{"description":"Representation of a check list item","type":"object","properties":{"name":{"description":"The name of the check list item","type":"string"},"completed":{"description":"A flag to determine if the item is completed","type":"boolean"},"completedDate":{"format":"date","description":"The date when the item was completed","type":"string","example":"2019-08-14"}}}},"buyerSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"vendorSolicitorContact":{"description":"Representation of a solicitor contact.","type":"object","properties":{"id":{"description":"The unique identifier of the contact.","type":"string"},"name":{"description":"The name of the contact.","type":"string"},"home":{"description":"The home telephone number of the contact.","type":"string"},"work":{"description":"The work telephone number of the contact.","type":"string"},"mobile":{"description":"The mobile telephone number of the contact.","type":"string"},"email":{"description":"The primary email address of the contact.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of this conveyancing record. Used for managing update concurrency","type":"string","readOnly":true},"metadata":{"description":"App specific metadata that has been set against this conveyancing record","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"UpdateConveyancingModel":{"description":"Request body for updating sales progression information on an existing offer","type":"object","properties":{"vendorSolicitorId":{"description":"The unique identifier of the vendor that this offer is associated to. Empty if the offer is external and relates to a property not instructed to the agent","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed","type":"string"},"fixturesAndFittingsCompleted":{"format":"date","description":"The date when the fixtures and fittings form has been completed","type":"string","example":"2019-08-14"},"deedsRequested":{"format":"date","description":"The date when the title deeds were requested from land registry","type":"string","example":"2019-08-14"},"deedsReceived":{"format":"date","description":"The date when the title deeds were received from land registry","type":"string","example":"2019-08-14"},"enquiriesSent":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were sent","type":"string","example":"2019-08-14"},"enquiriesAnswered":{"format":"date","description":"The date when the legal enquiries raised by the buyers solicitor were answered","type":"string","example":"2019-08-14"},"searchesPaid":{"format":"date","description":"The date when the buyer paid for conveyancing searches","type":"string","example":"2019-08-14"},"searchesApplied":{"format":"date","description":"The date when conveyancing searches were applied for","type":"string","example":"2019-08-14"},"searchesReceived":{"format":"date","description":"The date when conveyancing searches were received","type":"string","example":"2019-08-14"},"contractSent":{"format":"date","description":"The date when the draft contract was sent","type":"string","example":"2019-08-14"},"contractReceived":{"format":"date","description":"The date when the draft contract was received","type":"string","example":"2019-08-14"},"contractApproved":{"format":"date","description":"The date when the contract was approved","type":"string","example":"2019-08-14"},"contractVendorSigned":{"format":"date","description":"The date when the vendor signed the approved contract","type":"string","example":"2019-08-14"},"contractBuyerSigned":{"format":"date","description":"The date when the buyer signed the approved contract","type":"string","example":"2019-08-14"},"mortgageRequired":{"description":"Indication of whether the buyer will require a mortgage to fund the purchase (yes/no/unknown)","type":"string"},"mortgageLoanPercentage":{"format":"int32","description":"The loan to value percentage of the mortgage required","type":"integer"},"mortgageSubmitted":{"format":"date","description":"The date when the mortgage application was submitted","type":"string","example":"2019-08-14"},"mortgageOfferReceived":{"format":"date","description":"The date when the mortgage offer was received","type":"string","example":"2019-08-14"},"mortgageLenderId":{"description":"The unique identifier of the company who will provide the mortgage","type":"string"},"mortgageBrokerId":{"description":"The unique identifier of the company who brokered the mortgage","type":"string"},"mortgageSurveyDate":{"format":"date-time","description":"The date of the mortgage valuation/survey","type":"string","example":"2019-08-14T12:30:02Z"},"mortgageSurveyorId":{"description":"The unique identifier of the company who will perform the mortgage valuation/survey","type":"string"},"additionalSurveyRequired":{"description":"Indication of whether the buyer requires that an additional survey take place (yes/no/unknown)","type":"string"},"additionalSurveyDate":{"format":"date","description":"The date of the additional survey","type":"string","example":"2019-08-14"},"additionalSurveyorId":{"description":"The unique identifier of the company who will perform the additional survey","type":"string"},"exchangedVendor":{"format":"date","description":"The date when the vendor conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"exchangedBuyer":{"format":"date","description":"The date when the buyer conveyancer confirms the exchange","type":"string","example":"2019-08-14"},"completion":{"format":"date","description":"The date when the sale completed","type":"string","example":"2019-08-14"},"metadata":{"description":"App specific metadata to set against this conveyancing record","type":"object","additionalProperties":{}}},"example":{"vendorSolicitorId":"VEN1900001","buyerSolicitorId":"BUY1900001","fixturesAndFittingsCompleted":"2020-01-10","deedsRequested":"2020-01-05","deedsReceived":"2020-03-04","enquiriesSent":"2020-01-10","enquiriesAnswered":"2020-02-10","searchesPaid":"2020-01-16","searchesApplied":"2020-01-11","searchesReceived":"2020-02-27","contractSent":"2020-04-03","contractReceived":"2020-02-10","contractApproved":"2020-01-01","contractVendorSigned":"2020-01-12","contractBuyerSigned":"2020-01-10","mortgageRequired":"yes","mortgageLoanPercentage":55,"mortgageSubmitted":"2020-01-14","mortgageOfferReceived":"2020-04-10","mortgageLenderId":"OXF1500012","mortgageBrokerId":"","mortgageSurveyDate":"2020-01-14","mortgageSurveyorId":"","additionalSurveyRequired":"yes","additionalSurveyDate":"2020-01-22","additionalSurveyorId":"","exchangedVendor":"2020-03-10","exchangedBuyer":"2020-01-23","completion":"2020-04-10","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"CreateDownwardLinkModel":{"description":"Request body for associating this offer to another one below it in the chain","type":"object","properties":{"offerId":{"description":"The unique identifier of the offer below this one in the chain. Should be left empty if the upward property is external (instructed by another agent)","type":"string"},"propertyAddress":{"description":"The address of the property below this one in the chain. (Required when 'offerId' is not provided)","type":"string"},"agent":{"description":"The name of the agent managing the sale of the property. (Required when 'offerId' is not provided)","type":"string"},"buyer":{"description":"The name of the buyer purchasing the property. (Required when 'offerId' is not provided)","type":"string"},"buyerSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the buyer has instructed. (Required when 'offerId' is not provided)","type":"string"}},"example":{"offerId":"","propertyAddress":"10 Church View Lane, Rugeley, WS15 6PP","agent":"External estate agent name","buyer":"Mr John Smith","buyerSolicitorId":"OXF19000001"}},"CreateUpwardLinkModel":{"description":"Request body for associating this offer to another one above it in the chain","type":"object","properties":{"offerId":{"description":"The unique identifier of the offer above this one in the chain. Should be left empty if the upward property is external (instructed by another agent)","type":"string"},"propertyAddress":{"description":"The address of the property above this one in the chain. (Required when 'offerId' is not provided)","type":"string"},"agent":{"description":"The name of the agent managing the sale of the property. (Required when 'offerId' is not provided)","type":"string"},"vendor":{"description":"The name of the vendor selling the property. (Required when 'offerId' is not provided)","type":"string"},"vendorSolicitorId":{"description":"The unique identifier of the solicitor / conveyancer that the vendor has instructed. (Required when 'offerId' is not provided)","type":"string"}},"example":{"offerId":"","propertyAddress":"10 Church View Lane, Rugeley, WS15 6PP","agent":"External estate agent name","vendor":"Mr John Smith","vendorSolicitorId":"OXF19000001"}},"DepartmentModel":{"description":"Representation of a department","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the department","type":"string"},"created":{"format":"date-time","description":"The date and time when the department was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the department was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the department","type":"string"},"typeOptions":{"description":"A collection of property type values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"styleOptions":{"description":"A collection of property style values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situationOptions":{"description":"A collection of property situation values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parkingOptions":{"description":"A collection of property parking values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"ageOptions":{"description":"A collection of property age values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"localityOptions":{"description":"A collection of property locality values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeaturesOptions":{"description":"A collection of special property feature values that will be presented by other services","type":"array","items":{"type":"string"}},"commercialUseClassOptions":{"description":"A collection of commercial use class values that will be accepted by other services","type":"array","items":{"type":"string"}},"commercialFloorLevelOptions":{"description":"A collection of commercial floor level values that will be accepted by other services","type":"array","items":{"type":"string"}},"keywords":{"description":"A collection of keyword values that will be accepted by other services","type":"array","items":{"type":"string"}},"hasBedrooms":{"description":"A flag to determing if the department has bedrooms configured","type":"boolean"},"hasBathrooms":{"description":"A flag to determing if the department has bathrooms configured","type":"boolean"},"hasReceptionRooms":{"description":"A flag to determing if the department has reception rooms configured","type":"boolean"},"hasParkingSpaces":{"description":"A flag to determing if the department has parking spaces configured","type":"boolean"},"hasFloorLevelEnabled":{"description":"A flag to determing if the department allows the floor level property to be set","type":"boolean"},"hasInternalFloorsEnabled":{"description":"A flag to determing if the department allows the internal floors property to be set","type":"boolean"},"hasTotalFloorsEnabled":{"description":"A flag to determing if the department allows the total floors property to be set","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the department. Used for managing update concurrency","type":"string","readOnly":true}}},"DepartmentModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a department","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the department","type":"string"},"created":{"format":"date-time","description":"The date and time when the department was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the department was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the department","type":"string"},"typeOptions":{"description":"A collection of property type values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"styleOptions":{"description":"A collection of property style values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situationOptions":{"description":"A collection of property situation values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parkingOptions":{"description":"A collection of property parking values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"ageOptions":{"description":"A collection of property age values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"localityOptions":{"description":"A collection of property locality values that will be accepted by other services\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeaturesOptions":{"description":"A collection of special property feature values that will be presented by other services","type":"array","items":{"type":"string"}},"commercialUseClassOptions":{"description":"A collection of commercial use class values that will be accepted by other services","type":"array","items":{"type":"string"}},"commercialFloorLevelOptions":{"description":"A collection of commercial floor level values that will be accepted by other services","type":"array","items":{"type":"string"}},"keywords":{"description":"A collection of keyword values that will be accepted by other services","type":"array","items":{"type":"string"}},"hasBedrooms":{"description":"A flag to determing if the department has bedrooms configured","type":"boolean"},"hasBathrooms":{"description":"A flag to determing if the department has bathrooms configured","type":"boolean"},"hasReceptionRooms":{"description":"A flag to determing if the department has reception rooms configured","type":"boolean"},"hasParkingSpaces":{"description":"A flag to determing if the department has parking spaces configured","type":"boolean"},"hasFloorLevelEnabled":{"description":"A flag to determing if the department allows the floor level property to be set","type":"boolean"},"hasInternalFloorsEnabled":{"description":"A flag to determing if the department allows the internal floors property to be set","type":"boolean"},"hasTotalFloorsEnabled":{"description":"A flag to determing if the department allows the total floors property to be set","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the department. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"DocumentModel":{"description":"Representation of a document","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the document","type":"string"},"created":{"format":"date-time","description":"The date and time when the document was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the document was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of entity that the document is associated with","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"associatedId":{"description":"The unique identifier of the entity that the document is associated with","type":"string"},"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"addedBy":{"description":"The identifier of the negotiator who added the document","type":"string"},"metadata":{"description":"App specific metadata that has been set against the document","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the document. Used for managing update concurrency","type":"string","readOnly":true}}},"DocumentModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a document","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the document","type":"string"},"created":{"format":"date-time","description":"The date and time when the document was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the document was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of entity that the document is associated with","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"associatedId":{"description":"The unique identifier of the entity that the document is associated with","type":"string"},"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"addedBy":{"description":"The identifier of the negotiator who added the document","type":"string"},"metadata":{"description":"App specific metadata that has been set against the document","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the document. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateDocumentModel":{"description":"Request body used to create a new document","required":["associatedType","associatedId","typeId","name"],"type":"object","properties":{"associatedType":{"description":"The type of entity that the document is associated with (appliance/applicant/bankStatement/batch/certificate/contact/depositCertificate/estate/estateUnit/idCheck/keySet/landlord/nominalTransaction/property/supplierInvoice/tenancy/tenancyCheck/tenancyRenewal/worksOrder/renewalNegotiation)","type":"string"},"associatedId":{"description":"The unique identifier of the entity that the document is associated with","type":"string"},"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"fileData":{"description":"The base64 encoded document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl)\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"metadata":{"description":"App specific metadata to set against the document","type":"object","additionalProperties":{}}},"example":{"associatedType":"property","associatedId":"OXF190347","typeId":"DET","name":"24 Smithson Road Details.pdf","isPrivate":false,"fileData":"data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==","fileUrl":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"UpdateDocumentModel":{"description":"Request body used to update an existing document","type":"object","properties":{"typeId":{"description":"The unique identifier of the type of document","type":"string"},"name":{"description":"The filename of the document","type":"string"},"isPrivate":{"description":"A flag denoting whether or not the document is private","type":"boolean"},"metadata":{"description":"App specific metadata to set against the document","type":"object","additionalProperties":{}}},"example":{"typeId":"DET","name":"24 Smithson Road Approved Details v2.pdf","isPrivate":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"CreatePreSignedUrlsModel":{"description":"Request body used to create pre signed urls to upload files between 6MB and 30MB","required":["amount"],"type":"object","properties":{"amount":{"format":"int32","description":"The number of pre signed urls to create","type":"integer"}},"example":{"amount":1}},"EnquiryAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"EnquiryBuyingModel":{"description":"Request body used to create a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"EnquiryRentingModel":{"description":"The details specific to enquiries with a type of lettingsApplicant","type":"object","properties":{"rentFrom":{"format":"double","description":"The lower bound of the prospective tenant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the prospective tenant's budget","type":"number"},"rentFrequency":{"description":"How often the tenant would like to pay the rent (weekly/monthly/annually)","type":"string"}}},"EnquiryModel":{"description":"Representation of an enquiry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"format":"int32","description":"The unique identifier of the enquiry","type":"integer"},"created":{"format":"date-time","description":"The date and time when the enquiry was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the enquiry was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The title of the individual making the enquiry","type":"string"},"forename":{"description":"The forename of the individual making the enquiry","type":"string"},"surname":{"description":"The surname of the individual making the enquiry","type":"string"},"enquiryType":{"description":"The type of enquiry. Enquiries can created for applicants interested in buying/renting, as well as prospective vendors and landlords (salesApplicant/lettingsApplicant/salesProperty/lettingsProperty)","type":"string"},"message":{"description":"Textual information about the nature of the enquiry - usually the message text from the individual making the enquiry","type":"string"},"status":{"description":"The status of the enquiry (pending/added/rejected/alreadyExists/duplicateEntry/spam)","type":"string"},"marketingConsent":{"description":"The marketing consent status of the individual making the enquiry (grant/deny/notAsked)","type":"string"},"position":{"description":"The selling position of the individual making the enquiry (renting/instructedThisAgent/instructedOtherAgent/privateSale/notOnMarket)","type":"string"},"officeId":{"description":"The unique identifier of the office related to the enquiry","type":"string"},"applicantId":{"description":"The unique identifier of the applicant related to the enquiry","type":"string"},"createdPropertyId":{"description":"The unique identifier of the created property related to the enquiry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator related to the enquiry","type":"string"},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator who has been assigned to the enquiry","type":"string"},"sourceName":{"description":"The name of the source that the enquiry was generated by","type":"string"},"homePhone":{"description":"The home phone number of the individual making the enquiry","type":"string"},"workPhone":{"description":"The work phone number of the individual making the enquiry","type":"string"},"mobilePhone":{"description":"The mobile phone number of the individual making the enquiry","type":"string"},"email":{"description":"The email of the individual making the enquiry","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"buying":{"description":"Request body used to create a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"renting":{"description":"The details specific to enquiries with a type of lettingsApplicant","type":"object","properties":{"rentFrom":{"format":"double","description":"The lower bound of the prospective tenant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the prospective tenant's budget","type":"number"},"rentFrequency":{"description":"How often the tenant would like to pay the rent (weekly/monthly/annually)","type":"string"}}},"bedrooms":{"format":"int32","description":"The number of bedrooms the prospective buyer or tenant requires","type":"integer"},"propertyIds":{"description":"A list of unique property identifiers that this enquiry relates to. Used to indicate the properties that a sales or lettings applicant has expressed an interest in","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the enquiry. Used for managing update concurrency","type":"string","readOnly":true}}},"EnquiryModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an enquiry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"format":"int32","description":"The unique identifier of the enquiry","type":"integer"},"created":{"format":"date-time","description":"The date and time when the enquiry was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the enquiry was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"title":{"description":"The title of the individual making the enquiry","type":"string"},"forename":{"description":"The forename of the individual making the enquiry","type":"string"},"surname":{"description":"The surname of the individual making the enquiry","type":"string"},"enquiryType":{"description":"The type of enquiry. Enquiries can created for applicants interested in buying/renting, as well as prospective vendors and landlords (salesApplicant/lettingsApplicant/salesProperty/lettingsProperty)","type":"string"},"message":{"description":"Textual information about the nature of the enquiry - usually the message text from the individual making the enquiry","type":"string"},"status":{"description":"The status of the enquiry (pending/added/rejected/alreadyExists/duplicateEntry/spam)","type":"string"},"marketingConsent":{"description":"The marketing consent status of the individual making the enquiry (grant/deny/notAsked)","type":"string"},"position":{"description":"The selling position of the individual making the enquiry (renting/instructedThisAgent/instructedOtherAgent/privateSale/notOnMarket)","type":"string"},"officeId":{"description":"The unique identifier of the office related to the enquiry","type":"string"},"applicantId":{"description":"The unique identifier of the applicant related to the enquiry","type":"string"},"createdPropertyId":{"description":"The unique identifier of the created property related to the enquiry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator related to the enquiry","type":"string"},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator who has been assigned to the enquiry","type":"string"},"sourceName":{"description":"The name of the source that the enquiry was generated by","type":"string"},"homePhone":{"description":"The home phone number of the individual making the enquiry","type":"string"},"workPhone":{"description":"The work phone number of the individual making the enquiry","type":"string"},"mobilePhone":{"description":"The mobile phone number of the individual making the enquiry","type":"string"},"email":{"description":"The email of the individual making the enquiry","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"buying":{"description":"Request body used to create a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"renting":{"description":"The details specific to enquiries with a type of lettingsApplicant","type":"object","properties":{"rentFrom":{"format":"double","description":"The lower bound of the prospective tenant's budget","type":"number"},"rentTo":{"format":"double","description":"The upper bound of the prospective tenant's budget","type":"number"},"rentFrequency":{"description":"How often the tenant would like to pay the rent (weekly/monthly/annually)","type":"string"}}},"bedrooms":{"format":"int32","description":"The number of bedrooms the prospective buyer or tenant requires","type":"integer"},"propertyIds":{"description":"A list of unique property identifiers that this enquiry relates to. Used to indicate the properties that a sales or lettings applicant has expressed an interest in","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the enquiry. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateEnquiryAddressModel":{"description":"Request body used to create a enquiries address","type":"object","properties":{"buildingName":{"description":"Sets the building name","type":"string"},"buildingNumber":{"description":"Sets the building number","type":"string"},"line1":{"description":"Sets the first line of the address","type":"string"},"line2":{"description":"Sets the second line of the address","type":"string"},"line3":{"description":"Sets the third line of the address","type":"string"},"line4":{"description":"Sets the fourth line of the address","type":"string"},"postcode":{"description":"Sets the postcode","type":"string"},"countryId":{"description":"Sets the ISO-3166 country code that the address resides within","type":"string"}}},"CreateEnquiryBuyingModel":{"description":"The details specific to a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"CreateEnquiryRentingModel":{"description":"The details specific to renting enquiry. When type is renting.","type":"object","properties":{"rentFrom":{"format":"int32","description":"The lower bound of the prospective tenant's budget","type":"integer"},"rentTo":{"format":"int32","description":"The upper bound of the prospective tenant's budget","type":"integer"},"rentFrequency":{"description":"The desired rent collection frequency specified by the prospective tenant (weekly/monthly/annually).","type":"string"}}},"CreateEnquiryModel":{"description":"Request body used to create an enquiry","required":["title","forename","surname","enquiryType","message","officeId","marketingConsent","sourceName"],"type":"object","properties":{"title":{"description":"The title of the individual making the enquiry","type":"string"},"forename":{"description":"The forename of the individual making the enquiry","type":"string"},"surname":{"description":"The surname of the individual making the enquiry","type":"string"},"position":{"description":"The selling position of the individual making the enquiry (renting/instructedThisAgent/instructedOtherAgent/privateSale/notOnMarket)","type":"string"},"enquiryType":{"description":"The type of enquiry. Enquiries can created for applicants interested in buying/renting, as well as prospective vendors and landlords (salesApplicant/lettingsApplicant/salesProperty/lettingsProperty)","type":"string"},"message":{"description":"Textual information about the nature of the enquiry - usually the message text from the individual making the enquiry","type":"string"},"officeId":{"description":"The unique identifier of the related office","type":"string"},"marketingConsent":{"description":"The marketing consent status of the individual making the enquiry (grant/deny/notAsked)","type":"string"},"sourceName":{"description":"The name of the source that the enquiry was generated from","type":"string"},"homePhone":{"description":"The home phone number of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"workPhone":{"description":"The work phone number of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"mobilePhone":{"description":"The mobile phone number of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"email":{"description":"The email of the individual making the enquiry (Required when no other contact details are given)","type":"string"},"address":{"description":"Request body used to create a enquiries address","type":"object","properties":{"buildingName":{"description":"Sets the building name","type":"string"},"buildingNumber":{"description":"Sets the building number","type":"string"},"line1":{"description":"Sets the first line of the address","type":"string"},"line2":{"description":"Sets the second line of the address","type":"string"},"line3":{"description":"Sets the third line of the address","type":"string"},"line4":{"description":"Sets the fourth line of the address","type":"string"},"postcode":{"description":"Sets the postcode","type":"string"},"countryId":{"description":"Sets the ISO-3166 country code that the address resides within","type":"string"}}},"buying":{"description":"The details specific to a buying enquiry","type":"object","properties":{"priceFrom":{"format":"int32","description":"The lower bound of the prospective buyer's budget","type":"integer"},"priceTo":{"format":"int32","description":"The upper bound of the prospective buyer's budget","type":"integer"}}},"renting":{"description":"The details specific to renting enquiry. When type is renting.","type":"object","properties":{"rentFrom":{"format":"int32","description":"The lower bound of the prospective tenant's budget","type":"integer"},"rentTo":{"format":"int32","description":"The upper bound of the prospective tenant's budget","type":"integer"},"rentFrequency":{"description":"The desired rent collection frequency specified by the prospective tenant (weekly/monthly/annually).","type":"string"}}},"bedrooms":{"format":"int32","description":"The number of bedrooms the prospective buyer or tenant requires","type":"integer"},"propertyIds":{"description":"A list of unique property identifiers that the enquiry relates to. Used to indicate the properties that a sales or lettings applicant has expressed an interest in","type":"array","items":{"type":"string"}},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator who has been assigned to the enquiry","type":"string"}},"example":{"title":"Mr","forename":"John","surname":"Smith","position":"renting","enquiryType":"salesApplicant","message":"Sales enquiry from Rightmove for 10 High Street, Solihull","officeId":"OXF","marketingConsent":"grant","sourceName":"Rightmove","homePhone":"01234 567890","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":null,"postcode":"B91 2XX","countryId":"GB"},"buying":{"priceFrom":0,"priceTo":0},"renting":null,"bedrooms":null,"propertyIds":["OXF190012"],"leadNegotiatorId":"ALL"}},"UpdateEnquiryModel":{"description":"Request body used to update an existing enquiry.","type":"object","properties":{"applicantId":{"description":"The unique identifier of the applicant associated to the enquiry.","type":"string"},"createdPropertyId":{"description":"The unique identifier of the property associated to the enquiry.","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the enquiry.","type":"string"},"leadNegotiatorId":{"description":"The unique identifier of the lead negotiator assigned to the enquiry.","type":"string"},"status":{"description":"The status of the enquiry (added/alreadyExists/duplicateEntry/pending/rejected/spam).","type":"string"}},"example":{"applicantId":"APP19000001","createdPropertyId":"OXF190012","negotiatorId":"ASD","leadNegotiatorId":"ALL","status":"added"}},"IdentityDocumentModel":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"IdentityCheckModel":{"description":"Representation of a contact identity check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the identity check","type":"string"},"contactId":{"description":"The unique identifier of the contact/company associated to the identity check","type":"string"},"contactType":{"description":"The type of contact associated to the identity check (contact/company)","type":"string"},"created":{"format":"date-time","description":"The date and time when the identity check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the identity check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"identityDocument2":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"rightToRent":{"description":"The result of the right to rent check (NoRightToReside (NR), TimeLimitedRightToReside (TL), PermanentRightToReside (PR), null)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the identity check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the identity check. Used for managing update concurrency","type":"string","readOnly":true}}},"IdentityCheckModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a contact identity check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the identity check","type":"string"},"contactId":{"description":"The unique identifier of the contact/company associated to the identity check","type":"string"},"contactType":{"description":"The type of contact associated to the identity check (contact/company)","type":"string"},"created":{"format":"date-time","description":"The date and time when the identity check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the identity check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"identityDocument2":{"description":"Representation of a single identity document that was provided as part of a contact identity check (eg. passport)","type":"object","properties":{"documentId":{"description":"The unique identifier of the identity document","type":"string"},"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"}}},"rightToRent":{"description":"The result of the right to rent check (NoRightToReside (NR), TimeLimitedRightToReside (TL), PermanentRightToReside (PR), null)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the identity check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the identity check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateIdentityDocumentModel":{"description":"Request body to attach an identity document to a new contact identity check\r\nA second identity document is not required and can be ignored by being set to null","required":["typeId"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number) (Required when 'fileData' is not given)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl) (Required when 'details' are not given)\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"name":{"description":"The filename to store the document as (Required when 'details' are not given)","type":"string"}}},"CreateIdentityCheckModel":{"description":"Request body used to create a new contact identity check","required":["contactId","checkDate","status","negotiatorId"],"type":"object","properties":{"contactId":{"description":"The unique identifier of the contact associated to the identity check","type":"string"},"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Request body to attach an identity document to a new contact identity check\r\nA second identity document is not required and can be ignored by being set to null","required":["typeId"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number) (Required when 'fileData' is not given)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl) (Required when 'details' are not given)\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"name":{"description":"The filename to store the document as (Required when 'details' are not given)","type":"string"}}},"identityDocument2":{"description":"Request body to attach an identity document to a new contact identity check\r\nA second identity document is not required and can be ignored by being set to null","required":["typeId"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number) (Required when 'fileData' is not given)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl) (Required when 'details' are not given)\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"name":{"description":"The filename to store the document as (Required when 'details' are not given)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the identity check","type":"object","additionalProperties":{}}},"example":{"contactId":"OXF19000001","checkDate":"2020-01-22","status":"pending","negotiatorId":"JAS","identityDocument1":{"typeId":"DL","expiry":"2050-03-22","details":"Driving License","fileData":null,"fileUrl":null,"name":null},"identityDocument2":{"typeId":"PP","expiry":"2045-12-01","details":"Passport","fileData":null,"fileUrl":null,"name":null},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateIdentityDocumentModel":{"description":"Request body to update an identity document attached to an existing contact identity check","type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl)\r\nThe total request payload cannot exceed 6Mb, regardless of the number of documents being sent","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to (This supports files up to 30MB)","type":"string"},"name":{"description":"The filename to store the document as","type":"string"}}},"UpdateIdentityCheckModel":{"description":"Request body used to update an exist contact identity check","type":"object","properties":{"checkDate":{"format":"date","description":"The date when the identity check was performed. This may differ to the date when the check was created","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the identity check (pass/fail/pending/cancelled/warnings/unchecked)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that initiated the identity check","type":"string"},"identityDocument1":{"description":"Request body to update an identity document attached to an existing contact identity check","type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl)\r\nThe total request payload cannot exceed 6Mb, regardless of the number of documents being sent","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to (This supports files up to 30MB)","type":"string"},"name":{"description":"The filename to store the document as","type":"string"}}},"identityDocument2":{"description":"Request body to update an identity document attached to an existing contact identity check","type":"object","properties":{"typeId":{"description":"The unique identifier of the type of identity document provided","type":"string"},"expiry":{"format":"date","description":"The date when the document expires and becomes invalid","type":"string","example":"2019-08-14"},"details":{"description":"Details regarding the identity document (eg. passport number)","type":"string"},"fileData":{"description":"The base64 encoded identity document content, prefixed with the content type (eg. data:text/plain;base64,VGVzdCBmaWxl)\r\nThe total request payload cannot exceed 6Mb, regardless of the number of documents being sent","type":"string"},"fileUrl":{"description":"The presigned s3 url which a document has been uploaded to (This supports files up to 30MB)","type":"string"},"name":{"description":"The filename to store the document as","type":"string"}}},"metadata":{"description":"App specific metadata to set against the identity check","type":"object","additionalProperties":{}}},"example":{"checkDate":"2020-01-22","status":"pending","negotiatorId":"JAS","identityDocument1":{"typeId":"DL","expiry":"2050-03-22","details":"Driving License","fileData":null,"fileUrl":null,"name":null},"identityDocument2":{"typeId":"PP","expiry":"2045-12-01","details":"Passport","fileData":null,"fileUrl":null,"name":null},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"InvoiceModel":{"description":"Representation of an individual invoice","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the invoice","type":"string"},"created":{"format":"date-time","description":"The date and time when the invoice was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the invoice was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"reference":{"description":"The invoice reference","type":"string"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the invoice","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the invoice","type":"string"},"description":{"description":"Description of the invoice","type":"string"},"status":{"description":"The status of the invoice","type":"string"},"date":{"format":"date-time","description":"The date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"dueDate":{"format":"date-time","description":"The due date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"isRaised":{"description":"Flag indicating whether the invoice has been raised","type":"boolean"},"netAmount":{"format":"double","description":"The net amount due for the invoice in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the invoice in the system base currency","type":"number"},"outstandingAmount":{"format":"double","description":"The value of the invoice outstanding in the system base currency","type":"number"}}},"InvoiceModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual invoice","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the invoice","type":"string"},"created":{"format":"date-time","description":"The date and time when the invoice was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the invoice was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"reference":{"description":"The invoice reference","type":"string"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the invoice","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the invoice","type":"string"},"description":{"description":"Description of the invoice","type":"string"},"status":{"description":"The status of the invoice","type":"string"},"date":{"format":"date-time","description":"The date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"dueDate":{"format":"date-time","description":"The due date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"isRaised":{"description":"Flag indicating whether the invoice has been raised","type":"boolean"},"netAmount":{"format":"double","description":"The net amount due for the invoice in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the invoice in the system base currency","type":"number"},"outstandingAmount":{"format":"double","description":"The value of the invoice outstanding in the system base currency","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"ChargeModel":{"description":"Representation of an invoice charge","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the charge","type":"string"},"created":{"format":"date-time","description":"The date and time when the charge was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the charge was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of charge (charge/advertising)","type":"string"},"invoiceId":{"description":"The unique identifier of the invoice with which this charge is associated","type":"string"},"propertyId":{"description":"The unique identifier of the property with which this charge is associated","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator with which this charge is associated","type":"string"},"vatCode":{"description":"The code representing the VAT applied to this charge","type":"string"},"description":{"description":"Description of the charge","type":"string"},"netAmount":{"format":"double","description":"The net amount","type":"number"},"vatAmount":{"format":"double","description":"The VAT amount","type":"number"}}},"CreditModel":{"description":"Representation of an individual credit","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the credit","type":"string"},"created":{"format":"date-time","description":"The date and time when the credit was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the credit was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the credit","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the credit","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the credit","type":"string"},"description":{"description":"Description of the credit","type":"string"},"date":{"format":"date-time","description":"The date of the credit","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the credit in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the credit in the system base currency","type":"number"}}},"PaymentModel":{"description":"Representation of an individual payment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the payment","type":"string"},"created":{"format":"date-time","description":"The date and time when the payment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the payment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the payment","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the payment","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the payment","type":"string"},"description":{"description":"Description of the payment","type":"string"},"type":{"description":"The type of payment","type":"string"},"date":{"format":"date-time","description":"The date of the payment","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the payment in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the payment in the system base currency","type":"number"}}},"InvoiceDetailModel":{"description":"Detailed representation of an individual invoice","type":"object","properties":{"id":{"description":"Unique identifier of the invoice","type":"string"},"created":{"format":"date-time","description":"The date and time when the invoice was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the invoice was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"reference":{"description":"The invoice reference","type":"string"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the invoice","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the invoice","type":"string"},"description":{"description":"Description of the invoice","type":"string"},"status":{"description":"The status of the invoice","type":"string"},"date":{"format":"date-time","description":"The date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"dueDate":{"format":"date-time","description":"The due date of the invoice","type":"string","example":"2019-08-14T12:30:02Z"},"isRaised":{"description":"Flag indicating whether the invoice has been raised","type":"boolean"},"netAmount":{"format":"double","description":"The net amount due for the invoice in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the invoice in the system base currency","type":"number"},"outstandingAmount":{"format":"double","description":"The value of the invoice outstanding in the system base currency","type":"number"},"charges":{"description":"Collection of charges associated with the invoice","type":"array","items":{"description":"Representation of an invoice charge","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the charge","type":"string"},"created":{"format":"date-time","description":"The date and time when the charge was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the charge was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of charge (charge/advertising)","type":"string"},"invoiceId":{"description":"The unique identifier of the invoice with which this charge is associated","type":"string"},"propertyId":{"description":"The unique identifier of the property with which this charge is associated","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator with which this charge is associated","type":"string"},"vatCode":{"description":"The code representing the VAT applied to this charge","type":"string"},"description":{"description":"Description of the charge","type":"string"},"netAmount":{"format":"double","description":"The net amount","type":"number"},"vatAmount":{"format":"double","description":"The VAT amount","type":"number"}}}},"credits":{"description":"Collection of credits associated with the invoice","type":"array","items":{"description":"Representation of an individual credit","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the credit","type":"string"},"created":{"format":"date-time","description":"The date and time when the credit was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the credit was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the credit","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the credit","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the credit","type":"string"},"description":{"description":"Description of the credit","type":"string"},"date":{"format":"date-time","description":"The date of the credit","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the credit in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the credit in the system base currency","type":"number"}}}},"payments":{"description":"Collection of payments associated with the invoice","type":"array","items":{"description":"Representation of an individual payment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the payment","type":"string"},"created":{"format":"date-time","description":"The date and time when the payment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the payment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the payment","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the payment","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the payment","type":"string"},"description":{"description":"Description of the payment","type":"string"},"type":{"description":"The type of payment","type":"string"},"date":{"format":"date-time","description":"The date of the payment","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the payment in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the payment in the system base currency","type":"number"}}}},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true}}},"PaymentModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual payment","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the payment","type":"string"},"created":{"format":"date-time","description":"The date and time when the payment was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the payment was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the payment","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the payment","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the payment","type":"string"},"description":{"description":"Description of the payment","type":"string"},"type":{"description":"The type of payment","type":"string"},"date":{"format":"date-time","description":"The date of the payment","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the payment in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the payment in the system base currency","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreditModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an individual credit","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"Unique identifier of the credit","type":"string"},"created":{"format":"date-time","description":"The date and time when the credit was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the credit was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"Unique identifier of the negotiator associated with the credit","type":"string"},"propertyId":{"description":"Unique identifier of the property associated with the credit","type":"string"},"invoiceId":{"description":"Unique identifier of the invoice associated with the credit","type":"string"},"description":{"description":"Description of the credit","type":"string"},"date":{"format":"date-time","description":"The date of the credit","type":"string","example":"2019-08-14T12:30:02Z"},"netAmount":{"format":"double","description":"The net amount due for the credit in the system base currency","type":"number"},"vatAmount":{"format":"double","description":"The amount of VAT due for the credit in the system base currency","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"ChargeModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an invoice charge","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the charge","type":"string"},"created":{"format":"date-time","description":"The date and time when the charge was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the charge was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"type":{"description":"The type of charge (charge/advertising)","type":"string"},"invoiceId":{"description":"The unique identifier of the invoice with which this charge is associated","type":"string"},"propertyId":{"description":"The unique identifier of the property with which this charge is associated","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator with which this charge is associated","type":"string"},"vatCode":{"description":"The code representing the VAT applied to this charge","type":"string"},"description":{"description":"Description of the charge","type":"string"},"netAmount":{"format":"double","description":"The net amount","type":"number"},"vatAmount":{"format":"double","description":"The VAT amount","type":"number"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"JournalEntryModel":{"description":"Representation of a journal entry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"created":{"format":"date-time","description":"The date and time when the journal entry was created","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type","type":"string"},"associatedType":{"description":"The entity type the journal entry has been raised against (applicant/contact/company/enquiry/landlord/tenancy/worksOrder)","type":"string"},"associatedId":{"description":"The unique identifier of the entity the journal entry has been raised against. Can additionally be associated to a property","type":"string"},"typeId":{"description":"The type of journal entry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that created the entry","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"}}},"JournalEntryModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a journal entry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"created":{"format":"date-time","description":"The date and time when the journal entry was created","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type","type":"string"},"associatedType":{"description":"The entity type the journal entry has been raised against (applicant/contact/company/enquiry/landlord/tenancy/worksOrder)","type":"string"},"associatedId":{"description":"The unique identifier of the entity the journal entry has been raised against. Can additionally be associated to a property","type":"string"},"typeId":{"description":"The type of journal entry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that created the entry","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateJournalEntryModel":{"description":"Request body to create a journal entry","required":["description"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type the journal entry is related to.\r\nDefault value set to MI","type":"string"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type (Required when 'associatedId' is not given)","type":"string"},"associatedType":{"description":"The entity type the journal entry has been raised against (applicant/contact/company/enquiry/landlord/tenancy/worksOrder) (Required when 'associatedId' is given)\r\nTypeId must be set to WO when passing worksOrder","type":"string"},"associatedId":{"description":"The unique identifier of the entity the journal entry has been raised against. Can additionally be associated to a property (Required when 'propertyId' is not given)","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"},"negotiatorId":{"description":"The identifier of the negotiator recording the journal entry","type":"string"}},"example":{"typeId":"MI","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","negotiatorId":"JAS"}},"LandlordJournalEntryModel":{"description":"Representation of a landlord related journal entry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"created":{"format":"date-time","description":"The date and time when the journal entry was created","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the journal entry is related to.","type":"string"},"type":{"description":"The type of journal entry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that created the entry","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"}}},"LandlordJournalEntryModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a landlord related journal entry","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"created":{"format":"date-time","description":"The date and time when the journal entry was created","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the journal entry is related to.","type":"string"},"type":{"description":"The type of journal entry","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that created the entry","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateBulkJournalEntryModel":{"description":"Request body to create bulk journal entry","type":"object","properties":{"createJournalEntry":{"description":"Collection of journal entries","type":"array","items":{"description":"Request body to create a journal entry","required":["description"],"type":"object","properties":{"typeId":{"description":"The unique identifier of the type the journal entry is related to.\r\nDefault value set to MI","type":"string"},"propertyId":{"description":"The unique identifier of the property the journal entry is related to. Can additionally be associated to another type (Required when 'associatedId' is not given)","type":"string"},"associatedType":{"description":"The entity type the journal entry has been raised against (applicant/contact/company/enquiry/landlord/tenancy/worksOrder) (Required when 'associatedId' is given)\r\nTypeId must be set to WO when passing worksOrder","type":"string"},"associatedId":{"description":"The unique identifier of the entity the journal entry has been raised against. Can additionally be associated to a property (Required when 'propertyId' is not given)","type":"string"},"description":{"description":"The textual description of the journal entry event","type":"string"},"negotiatorId":{"description":"The identifier of the negotiator recording the journal entry","type":"string"}},"example":{"typeId":"MI","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","negotiatorId":"JAS"}}}},"example":{"createJournalEntry":[{"typeId":"MI","propertyId":"OXF190022","associatedType":"applicant","associatedId":"OXF190001","description":"Mr John Smith contacted us via live chat regarding 62 Test Road","negotiatorId":"JAS"},{"typeId":"WO","propertyId":"OXF190033","associatedType":"worksOrder","associatedId":"OXF190002","description":"Mr Paul Smith contacted us via phone call regarding 1 malden road","negotiatorId":"JAS"}]}},"LandlordSourceModel":{"description":"Representation of a landlord's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"LandlordContactAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"LandlordContactModel":{"description":"A summarised view of the details of a contact associated to a landlord","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}},"LandlordModel":{"description":"Representation of a landlord","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the landlord was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the landlord was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"active":{"description":"A flag determining whether or not the landlord is currently active","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Representation of a landlord's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the landlord. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact associated to a landlord","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the landlord","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the landlord. Used for managing update concurrency","type":"string","readOnly":true}}},"LandlordModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a landlord","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the landlord was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the landlord was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"active":{"description":"A flag determining whether or not the landlord is currently active","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Representation of a landlord's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the landlord. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact associated to a landlord","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the landlord","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the landlord. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateLandlordSourceModel":{"description":"Request body used to set the source of a new landlord","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"CreateLandlordContactRelationshipModel":{"description":"Request body used to create a new relationship between a landlord and a contact or company","type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"}}},"CreateLandlordModel":{"description":"Request body used to create a new landlord","required":["officeId","related"],"type":"object","properties":{"active":{"description":"A flag determining whether or not the landlord is currently active","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Request body used to set the source of a new landlord","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the landlord. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"Request body used to create a new relationship between a landlord and a contact or company","type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"}}}},"metadata":{"description":"App specific metadata that to set against the landlord","type":"object","additionalProperties":{}}},"example":{"active":true,"solicitorId":"OXF12300101","officeId":"OXF","statementPreferences":null,"source":{"id":"GGL","type":"source"},"related":[{"associatedId":"OXF12300101","associatedType":"contact"}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateLandlordSourceModel":{"description":"Request body used to update the source of an existing landlord","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"UpdateLandlordModel":{"description":"Request body used to update an existing landlord.","type":"object","properties":{"active":{"description":"A flag determining whether or not the landlord is currently active.","type":"boolean"},"solicitorId":{"description":"The unique identifier of the company acting as the landlord's solicitor.","type":"string"},"officeId":{"description":"The unique identifier of the office that is associated to the landlord.","type":"string"},"statementPreferences":{"description":"The delivery preferences for statements (email/post/notSent)","type":"array","items":{"type":"string"}},"source":{"description":"Request body used to update the source of an existing landlord","type":"object","properties":{"id":{"description":"The unique identifier of the source of the landlord","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"metadata":{"description":"App specific metadata that to set against the landlord.","type":"object","additionalProperties":{}}},"example":{"active":true,"solicitorId":"OXF12300101","officeId":"OXF","statementPreferences":null,"source":{"id":"GGL","type":"source"},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"LandlordContactRelationshipModel":{"description":"Representation of relationship between a landlord and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord relationship","type":"string"},"landlordId":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not the relationship should be regarded as the main relationship for the parent landlord entity","type":"boolean"}}},"LandlordContactRelationshipModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of relationship between a landlord and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the landlord relationship","type":"string"},"landlordId":{"description":"The unique identifier of the landlord","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not the relationship should be regarded as the main relationship for the parent landlord entity","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"InsertLandlordContactRelationshipModel":{"description":"Request body used to create or update a relationship between a landlord and a contact or company","required":["associatedId","associatedType","isMain"],"type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"},"isMain":{"description":"Flag denoting whether or not this relationship should be considered to be the main/primary relationship. Setting to true will automatically demote the existing primary relationship","type":"boolean"}},"example":{"associatedId":"OXF18000001","associatedType":"contact","isMain":false}},"MetadataModel":{"description":"Model representing the state of a metadata record for a given entity","type":"object","properties":{"id":{"description":"The unique identifier of this metadata record","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this metadata record was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"entityType":{"description":"The name of the entity type that this metadata record is associated to","type":"string"},"entityId":{"description":"The unique identifier of the the entity that this metadata is associated to","type":"string"},"metadata":{"description":"The JSON document content","type":"object","additionalProperties":{}}}},"MetadataModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing the state of a metadata record for a given entity","type":"object","properties":{"id":{"description":"The unique identifier of this metadata record","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this metadata record was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"entityType":{"description":"The name of the entity type that this metadata record is associated to","type":"string"},"entityId":{"description":"The unique identifier of the the entity that this metadata is associated to","type":"string"},"metadata":{"description":"The JSON document content","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateMetadataRequest":{"description":"Payload to create a metadata record","required":["entityType","metadata"],"type":"object","properties":{"entityType":{"description":"The type of the entity that this metadata is related to. This can represent a Foundations inbuilt type (an entity presented in our APIs) or it can be a custom entity type (a dynamic standalone metadata entity that you create).\r\n            \r\nInbuilt types: applicant, appointment, company, contact, conveyancing, identityCheck, landlord, negotiator, offer, office, property, task, vendor, worksOrder","type":"string"},"entityId":{"description":"The unique identifier of the entity that this metadata is related to.\r\nFor custom entities, this can be left blank and an id will be generated for you.","type":"string"},"metadata":{"description":"The JSON document to store","type":"object","additionalProperties":{}}},"example":{"entityType":"customEntityType","entityId":"75c46440-5cb9-4db1-801d-f57eab8999e2","metadata":{"CustomStringField":"my string","CustomBoolField":false,"CustomNumericField":100.5,"CustomDateField":"2019-06-15T13:45:30Z"}}},"UpdateMetadataRequest":{"description":"Payload to update a metadata record","required":["metadata"],"type":"object","properties":{"metadata":{"description":"The updated JSON document to store","type":"object","additionalProperties":{}}},"example":{"metadata":{"CustomStringField":"my string","CustomBoolField":false,"CustomNumericField":100.5,"CustomDateField":"2019-06-15T13:45:30Z"}}},"OperationType":{"format":"int32","enum":[0,1,2,3,4,5,6],"type":"integer"},"Operation":{"type":"object","properties":{"operationType":{"format":"int32","enum":[0,1,2,3,4,5,6],"type":"integer"},"path":{"type":"string"},"op":{"type":"string"},"from":{"type":"string"},"value":{}},"example":{"value":true,"path":"CustomBoolField","op":"replace"}},"SchemaModel":{"description":"Model representing a JSON schema used to validate a specific entity type","type":"object","properties":{"id":{"description":"The unique identifier of this JSON schema","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this JSON schema was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"schema":{"description":"The JSON schema document","type":"string"}}},"UpdateSchemaRequest":{"description":"Payload to update a JSON schema","required":["schema"],"type":"object","properties":{"schema":{"description":"The updated JSON schema to store","type":"string"}},"example":{"schema":"{\"$schema\": \"http://json-schema.org/draft-04/schema#\", \"type\": \"object\",  \"properties\": { \"CustomStringField\": { \"type\": \"string\" }}}"}},"SchemaModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing a JSON schema used to validate a specific entity type","type":"object","properties":{"id":{"description":"The unique identifier of this JSON schema","type":"string"},"modified":{"format":"date-time","description":"The date and time of when this JSON schema was last updated","type":"string","example":"2019-08-14T12:30:02Z"},"schema":{"description":"The JSON schema document","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateSchemaRequest":{"description":"Payload to create a JSON schema for metadata validation","required":["entityType","schema"],"type":"object","properties":{"entityType":{"description":"The name of the entity type that this schema is related to","type":"string"},"schema":{"description":"The JSON schema used to validate entities of this type","type":"string"}},"example":{"entityType":"customEntityType","schema":"{\"$schema\": \"http://json-schema.org/draft-04/schema#\",\"type\": \"object\", \"properties\": { \"CustomNumericField\": { \"type\": \"integer\" }}}"}},"NegotiatorModel":{"description":"Representation of a negotiator","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the negotiator","type":"string"},"created":{"format":"date-time","description":"The date and time when the negotiator was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the negotiator was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"officeId":{"description":"The unique identifier of the office that the negotiator is attached to","type":"string"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"profileImageUrl":{"description":"The URL of the optional negotiator profile image","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the negotiator","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the negotiator. Used for managing update concurrency","type":"string","readOnly":true}}},"NegotiatorModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a negotiator","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the negotiator","type":"string"},"created":{"format":"date-time","description":"The date and time when the negotiator was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the negotiator was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"officeId":{"description":"The unique identifier of the office that the negotiator is attached to","type":"string"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"profileImageUrl":{"description":"The URL of the optional negotiator profile image","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the negotiator","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the negotiator. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateNegotiatorModel":{"description":"Request body used to create a new negotiator","required":["name","officeId"],"type":"object","properties":{"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"officeId":{"description":"The unique identifier of the office that the negotiator is attached to","type":"string"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the negotiator","type":"object","additionalProperties":{}}},"example":{"name":"Mr John Smith","jobTitle":"Senior Sales Negotiator","active":true,"officeId":"OXF","workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","diaryNegotiatorIds":null,"diaryOfficeIds":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateAdditionalContactDetailModel":{"description":"Request body used to update an existing negotiator additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}},"UpdateNegotiatorModel":{"description":"Request body used to update an existing negotiator","type":"object","properties":{"name":{"description":"The name of the negotiator","type":"string"},"jobTitle":{"description":"The job title of the negotiator","type":"string"},"active":{"description":"A flag determining whether or not the negotiator is active","type":"boolean"},"workPhone":{"description":"The work phone number of the negotiator","type":"string"},"mobilePhone":{"description":"The mobile phone number of the negotiator","type":"string"},"email":{"description":"The email address of the negotiator","type":"string"},"diaryNegotiatorIds":{"description":"The identifiers of other negotiators whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"diaryOfficeIds":{"description":"The identifiers of other offices whose diaries should be displayed to this negotiator when rendering diary/calendar view components in applicants","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the negotiator","type":"object","additionalProperties":{}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Request body used to update an existing negotiator additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}},"example":{"name":"Mr John Smith","jobTitle":"Senior Sales Negotiator","active":true,"workPhone":"01234 567890","mobilePhone":"07890 123456","email":"example@email.com","diaryNegotiatorIds":null,"diaryOfficeIds":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true},"additionalContactDetails":[{"type":"DX Number","value":"01234 567890"},{"type":"Online Number","value":"07123 456789"}]}},"CreateNotificationTargetModel":{"description":"Payload for defining notification targets","type":"object","properties":{"negotiatorId":{"description":"The identifier of the negotiators whom should receive the notification","type":"array","items":{"type":"string"}}}},"CreateNotificationModel":{"description":"Payload for creating a notification","type":"object","properties":{"type":{"description":"The notification type (telephony)","type":"string"},"subType":{"description":"The sub category type (answeredCall/endedCall/incomingCall/missedCall)","type":"string"},"products":{"description":"The products the notification is associated to, and will be delivered to","type":"array","items":{"type":"string"}},"targets":{"description":"Payload for defining notification targets","type":"object","properties":{"negotiatorId":{"description":"The identifier of the negotiators whom should receive the notification","type":"array","items":{"type":"string"}}}},"payload":{"description":"The payload to deliver to the specified target(s). Note that the payload must match the expected format\r\nbased on the type/subType combination and will be validated accordingly. Please refer to [the documentation](https://foundations-documentation.reapit.cloud/api/notifications)\r\nfor more information"}},"example":{"type":"telephony","subType":"missedCall","products":["AgencyCloud"],"targets":{"negotiatorId":["ADV"]},"payload":{}}},"OfferContactAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"OfferContactModel":{"description":"A summarised view of the details of a contact associated to an offer","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}},"OfferModel":{"description":"Representation of an offer","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The the date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the offer was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"applicantId":{"description":"The unique identifier of the applicant associated to the offer","type":"string"},"companyId":{"description":"The unique identifier of the company associated to the offer","type":"string"},"contactId":{"description":"The unique identifier of the contact associated to the offer","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the offer","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"related":{"description":"A collection of contacts associated to the offer","type":"array","items":{"description":"A summarised view of the details of a contact associated to an offer","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the offer","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the offer. Used for managing update concurrency","type":"string","readOnly":true}}},"OfferModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an offer","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the offer","type":"string"},"created":{"format":"date-time","description":"The the date and time when the offer was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the offer was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"applicantId":{"description":"The unique identifier of the applicant associated to the offer","type":"string"},"companyId":{"description":"The unique identifier of the company associated to the offer","type":"string"},"contactId":{"description":"The unique identifier of the contact associated to the offer","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the offer","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"related":{"description":"A collection of contacts associated to the offer","type":"array","items":{"description":"A summarised view of the details of a contact associated to an offer","type":"object","properties":{"id":{"description":"The unique identifier of the contact","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (contact/company)","type":"string"},"homePhone":{"description":"The home phone number of the contact","type":"string"},"workPhone":{"description":"The work phone number of the contact","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides in","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"metadata":{"description":"App specific metadata that has been set against the offer","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the offer. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateOfferModel":{"description":"Request body used to create a new offer","required":["applicantId","propertyId","date","amount","status"],"type":"object","properties":{"applicantId":{"description":"The unique identifier of the applicant associated to the offer","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the offer","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"metadata":{"description":"App specific metadata to set against the offer","type":"object","additionalProperties":{}}},"example":{"applicantId":"OXF123001","propertyId":"OXF123022","negotiatorId":"JAS","date":"2018-11-05","amount":245000,"status":"pending","inclusions":"White goods must be left","exclusions":"Curtains must be removed","conditions":"Must move in within 3 months.","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateOfferModel":{"description":"Request body used to update an existing offer","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator associated to the offer","type":"string"},"date":{"format":"date","description":"The date when the offer was made","type":"string","example":"2019-08-14"},"amount":{"format":"double","description":"The monetary amount of the offer","type":"number"},"status":{"description":"The current status of the offer (pending/withdrawn/rejected/accepted/noteOfInterest)","type":"string"},"inclusions":{"description":"A free text field describing items that should be included in the sale","type":"string"},"exclusions":{"description":"A free text field describing items that are explicitly excluded from the sale","type":"string"},"conditions":{"description":"A free text field describing any other conditions set by either party that relate to the sale","type":"string"},"metadata":{"description":"App specific metadata to set against the offer","type":"object","additionalProperties":{}}},"example":{"negotiatorId":"JAS","date":"2018-11-05","amount":245000,"status":"pending","inclusions":"White goods must be left","exclusions":"Curtains must be removed","conditions":"Must move in within 3 months.","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"OfficeAddressGeolocationModel":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}},"OfficeAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"AdditionalOfficeContactDetailsModel":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}},"OfficeOnlineServiceModel":{"description":"Representation of an online service associated with an office","type":"object","properties":{"id":{"description":"Online service identifier","type":"string"},"name":{"description":"Online service name","type":"string"},"code":{"description":"Branch code associated with the online service","type":"string"}}},"OfficeModel":{"description":"Representation of an office","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the office","type":"string"},"created":{"format":"date-time","description":"The date and time when the office was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the office was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the office","type":"string"},"manager":{"description":"The name of the office manager","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"region":{"description":"The region that the office is in","type":"string"},"referTo":{"description":"The referral postcodes.","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"onlineServices":{"description":"Gets or sets the collection of online services associated with the office.","type":"array","items":{"description":"Representation of an online service associated with an office","type":"object","properties":{"id":{"description":"Online service identifier","type":"string"},"name":{"description":"Online service name","type":"string"},"code":{"description":"Branch code associated with the online service","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the office","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the office. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}},"OfficeModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of an office","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the office","type":"string"},"created":{"format":"date-time","description":"The date and time when the office was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the office was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the office","type":"string"},"manager":{"description":"The name of the office manager","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"region":{"description":"The region that the office is in","type":"string"},"referTo":{"description":"The referral postcodes.","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"onlineServices":{"description":"Gets or sets the collection of online services associated with the office.","type":"array","items":{"description":"Representation of an online service associated with an office","type":"object","properties":{"id":{"description":"Online service identifier","type":"string"},"name":{"description":"Online service name","type":"string"},"code":{"description":"Branch code associated with the online service","type":"string"}}}},"metadata":{"description":"App specific metadata that has been set against the office","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the office. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateOfficeAddressGeolocationModel":{"description":"Request body used to set the geolocation coordinates of a new address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}},"CreateOfficeAddressModel":{"description":"Request body used to set the address of a new office","required":["line1"],"type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of a new address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"CreateOfficeModel":{"description":"Request body used to create a new office","required":["name","address"],"type":"object","properties":{"name":{"description":"The name of the office","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"manager":{"description":"The name of the office manager","type":"string"},"address":{"description":"Request body used to set the address of a new office","required":["line1"],"type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of a new address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"metadata":{"description":"App specific metadata to set against the office","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","active":true,"manager":"Mr John Smith","address":{"buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":0,"longitude":0}},"workPhone":"01234 567890","email":"example@email.com","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateOfficeAddressGeolocationModel":{"description":"Request body used to set the geolocation coordinates of an existing address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}},"UpdateOfficeAddressModel":{"description":"Request body used to update the address of an existing office","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of an existing address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"UpdateOfficeModel":{"description":"Request body used to update an existing office","type":"object","properties":{"name":{"description":"The name of the office","type":"string"},"active":{"description":"A flag denoting whether or not this office is active","type":"boolean"},"manager":{"description":"The name of the office manager","type":"string"},"address":{"description":"Request body used to update the address of an existing office","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of an existing address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"workPhone":{"description":"The work phone number of the office","type":"string"},"email":{"description":"The email address of the office","type":"string"},"metadata":{"description":"App specific metadata to set against the office","type":"object","additionalProperties":{}}},"example":{"name":"Reapit","active":null,"manager":"Mr John Smith","address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":0,"longitude":0}},"workPhone":"01234 567890","email":"example@email.com","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"PropertyGeolocationModel":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}},"PropertyAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"localTimeZone":{"description":"The local timezone for the address, based on the Geolocation coordinates","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"PropertyRuralModel":{"description":"Details specific to rural properties","type":"object","properties":{"tenureId":{"description":"Details of the rural tenure associated with the property.","type":"string"},"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"PropertyExternalAreaModel":{"description":"Representation of the plot size of a property","type":"object","properties":{"type":{"description":"The unit of area (acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"PropertyInternalAreaModel":{"description":"Representation of the internal dimensions of a property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"PropertyCommercialEpcModel":{"description":"Representation of a commercial EPC statistics","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}},"PropertyEpcModel":{"description":"Representation of EPC statistics","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerRating":{"description":"The current energy efficiency letter rating (A-G). This is generated from the `eer` value\r\nfor systems that do not have an explicit EPC Rating component","type":"string"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eerPotentialRating":{"description":"The potential energy efficiency letter rating (A-G). This is generated from the `eerPotential` value","type":"string"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirRating":{"description":"The current environment impact letter rating (A-G). This is generated from the `eir` value","type":"string"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"eirPotentialRating":{"description":"The potential environment impact letter rating (A-G). This is generated from the `eirPotential` value","type":"string"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Representation of a commercial EPC statistics","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"PropertyRightsRestrictionsModel":{"description":"Details specific to a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"PropertyFloodErosionModel":{"description":"Details specific to a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"PropertyTenureModel":{"description":"Representation of the tenure of a property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"PropertyCommissionFeeModel":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"PropertySharedOwnershipModel":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"PropertySubAgentTermsModel":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"JointAgentCompanyModel":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}},"JointAgentsModel":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}},"PropertySellingModel":{"description":"Representation of property details specific to sales marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"double","description":"The marketing price of the property","type":"number"},"priceTo":{"format":"double","description":"The maximum price of a property on the development plot","type":"number"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Representation of the tenure of a property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"vendorId":{"description":"The unique identifier of the vendor selling the property","type":"string"},"agency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when Agency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"exchangedCompanyFee":{"format":"double","description":"The actual fee amount to be collected by the agent - often based on the exchange price of the property","type":"number"},"estimatedMonthlyRetailValue":{"format":"double","description":"The estimated monthly retail amount","type":"number"},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"exchangedPrice":{"format":"int32","description":"The price the property exchanged/sold for","type":"integer"},"exchangedOfficeId":{"description":"The unique identifier of the office that sold the property","type":"string"},"grossYieldPercentage":{"format":"double","description":"The gross yield amount","type":"number"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"PropertyCommissionFeeReductionModel":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"PropertyLettingCommissionFeeModel":{"description":"Representation of the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"UtilityModel":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"PropertyLettingsDepositModel":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}},"PropertyLettingRentInsuranceModel":{"description":"Representation of property details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"PropertyLettingLicenceApplicationModel":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date","description":"The date the licence was applied for","type":"string","example":"2019-08-14"},"granted":{"format":"date","description":"The date the licence application was granted","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The date the licence will expire","type":"string","example":"2019-08-14"}}},"PropertyLettingLicencingModel":{"description":"Representation of property details specific to property licencing","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date","description":"The date the licence was applied for","type":"string","example":"2019-08-14"},"granted":{"format":"date","description":"The date the licence application was granted","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The date the licence will expire","type":"string","example":"2019-08-14"}}}}},"PropertyWithdrawalReasonModel":{"description":"Representation of withdrawal details specific to lettings marketing","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}},"PreferredSupplierModel":{"description":"Representation of the preferred supplier details to lettings marketing.","type":"object","properties":{"id":{"description":"Unique identifier of the supplier.","type":"string"},"name":{"description":"Name of the supplier.","type":"string"}}},"PropertyLettingModel":{"description":"Representation of property details specific to lettings marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"The minimum number of months the property can be let out for","type":"integer"},"numberOfCheques":{"format":"int32","description":"The number of cheques payment required to rent the property","type":"integer"},"propertyManagerId":{"description":"The unique identifier of the negotiator that manages the property","type":"string"},"managementCompanyIds":{"description":"The unique identifiers of the management companies associated to the property","type":"array","items":{"type":"string"}},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"managementFee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Representation of the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Representation of property details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property licencing","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date","description":"The date the licence was applied for","type":"string","example":"2019-08-14"},"granted":{"format":"date","description":"The date the licence application was granted","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The date the licence will expire","type":"string","example":"2019-08-14"}}}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"withdrawalReason":{"description":"Representation of withdrawal details specific to lettings marketing","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}},"preferredSuppliers":{"description":"List of preferred suppliers of the property","type":"array","items":{"description":"Representation of the preferred supplier details to lettings marketing.","type":"object","properties":{"id":{"description":"Unique identifier of the supplier.","type":"string"},"name":{"description":"Name of the supplier.","type":"string"}}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"PropertyCommercialModel":{"description":"An properties commercial details","type":"object","properties":{"useClass":{"description":"The commercial use attributes (eg a1, a2, b1), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"GuernseyModel":{"description":"Any specific details relating to the marketing of a property in Guernsey","type":"object","properties":{"market":{"description":"Attributes describing which markets the property is available in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"IrelandPropertyBERModel":{"description":"Any specific details relating to energy performance ratings for properties marketed in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}},"IrelandPropertyModel":{"description":"Any specific details relating to the marketing of a property in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Any specific details relating to energy performance ratings for properties marketed in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}},"PropertyRegionalModel":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Any specific details relating to the marketing of a property in Guernsey","type":"object","properties":{"market":{"description":"Attributes describing which markets the property is available in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"irl":{"description":"Any specific details relating to the marketing of a property in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Any specific details relating to energy performance ratings for properties marketed in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"UnmappedAttributeModel":{"description":"Represents an unmapped attribute type","type":"object","properties":{"type":{"description":"The type of unmapped attribute (style/type/situation/parking/age/locality/special)","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}},"PropertyRoomModel":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}},"PropertyModel":{"description":"Representation of a property. Properties can be grouped into developments in the source data, functionality that is typically used by New Homes departments.\r\nThe _links collection will expose specific links to allow developers to navigate through a particular development, should a property be configured in this manner. Refer to commentary on the _links collection for more details","type":"object","properties":{"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the property","type":"string"},"created":{"format":"date-time","description":"The date and time when the property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"marketingMode":{"description":"The marketing mode of the property (selling/letting/sellingAndLetting)","type":"string"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"localTimeZone":{"description":"The local timezone for the address, based on the Geolocation coordinates","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"listingAdvertisementNumber":{"description":"The listing advertisement number of the property","type":"string"},"localAuthorityCompanyId":{"description":"The property's local authority","type":"string"},"localAuthorityCompanyName":{"description":"The name of the property's local authority","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"departmentId":{"description":"The unique identifier of the department the property is associated with. The property will only match to applicants with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"clientAccountsAssistantId":{"description":"The unique identifier of the client accounts assistant of the property","type":"string"},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property or properties. This is typically used when marketing development sites and would be set on the master record. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"disabledPortalIds":{"description":"A collection of identifiers of portals that the property should not be displayed on","type":"array","items":{"type":"string"}},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"isExternal":{"description":"A flag denoting whether or not the property has been instructed by another estate agent","type":"boolean"},"depositSchemeAccepted":{"description":"A flag denoting whether or not the property accepts deposit schemes","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information about the property.","type":"string"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"featuredImageUrl":{"format":"uri","description":"The properties featured image url","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"what3Words":{"description":"The What3Words identifier for the property.","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14"},"floorLevel":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"archivedOn":{"format":"date-time","description":"The date and time the property was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the property is archived","type":"boolean"},"rural":{"description":"Details specific to rural properties","type":"object","properties":{"tenureId":{"description":"Details of the rural tenure associated with the property.","type":"string"},"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"externalArea":{"description":"Representation of the plot size of a property","type":"object","properties":{"type":{"description":"The unit of area (acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Representation of the internal dimensions of a property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"epc":{"description":"Representation of EPC statistics","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerRating":{"description":"The current energy efficiency letter rating (A-G). This is generated from the `eer` value\r\nfor systems that do not have an explicit EPC Rating component","type":"string"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eerPotentialRating":{"description":"The potential energy efficiency letter rating (A-G). This is generated from the `eerPotential` value","type":"string"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirRating":{"description":"The current environment impact letter rating (A-G). This is generated from the `eir` value","type":"string"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"eirPotentialRating":{"description":"The potential environment impact letter rating (A-G). This is generated from the `eirPotential` value","type":"string"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Representation of a commercial EPC statistics","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"rightsRestrictions":{"description":"Details specific to a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Details specific to a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"selling":{"description":"Representation of property details specific to sales marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"double","description":"The marketing price of the property","type":"number"},"priceTo":{"format":"double","description":"The maximum price of a property on the development plot","type":"number"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Representation of the tenure of a property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"vendorId":{"description":"The unique identifier of the vendor selling the property","type":"string"},"agency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when Agency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"exchangedCompanyFee":{"format":"double","description":"The actual fee amount to be collected by the agent - often based on the exchange price of the property","type":"number"},"estimatedMonthlyRetailValue":{"format":"double","description":"The estimated monthly retail amount","type":"number"},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"exchangedPrice":{"format":"int32","description":"The price the property exchanged/sold for","type":"integer"},"exchangedOfficeId":{"description":"The unique identifier of the office that sold the property","type":"string"},"grossYieldPercentage":{"format":"double","description":"The gross yield amount","type":"number"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"letting":{"description":"Representation of property details specific to lettings marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"The minimum number of months the property can be let out for","type":"integer"},"numberOfCheques":{"format":"int32","description":"The number of cheques payment required to rent the property","type":"integer"},"propertyManagerId":{"description":"The unique identifier of the negotiator that manages the property","type":"string"},"managementCompanyIds":{"description":"The unique identifiers of the management companies associated to the property","type":"array","items":{"type":"string"}},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"managementFee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Representation of the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Representation of property details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property licencing","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date","description":"The date the licence was applied for","type":"string","example":"2019-08-14"},"granted":{"format":"date","description":"The date the licence application was granted","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The date the licence will expire","type":"string","example":"2019-08-14"}}}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"withdrawalReason":{"description":"Representation of withdrawal details specific to lettings marketing","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}},"preferredSuppliers":{"description":"List of preferred suppliers of the property","type":"array","items":{"description":"Representation of the preferred supplier details to lettings marketing.","type":"object","properties":{"id":{"description":"Unique identifier of the supplier.","type":"string"},"name":{"description":"Name of the supplier.","type":"string"}}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"commercial":{"description":"An properties commercial details","type":"object","properties":{"useClass":{"description":"The commercial use attributes (eg a1, a2, b1), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Any specific details relating to the marketing of a property in Guernsey","type":"object","properties":{"market":{"description":"Attributes describing which markets the property is available in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"irl":{"description":"Any specific details relating to the marketing of a property in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Any specific details relating to energy performance ratings for properties marketed in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The attributes describing the property's special features (eg swimmingPool, tennisCourt), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedAttributes":{"description":"The attributes associated to the property which are not currently mapped. These are defined the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped attribute type","type":"object","properties":{"type":{"description":"The type of unmapped attribute (style/type/situation/parking/age/locality/special)","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"availableServicesIds":{"description":"Identifiers of any services connected at the property","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"lostInstructionDate":{"format":"date-time","description":"The date that this property became a lost instruction","type":"string","example":"2019-08-14T12:30:02Z"},"lostInstructionNote":{"description":"The notes regarding the lost instruction","type":"string"},"developmentSiteType":{"description":"The type of development","type":"string"},"metadata":{"description":"App specific metadata that has been set against the property","type":"object","additionalProperties":{}},"keywords":{"description":"The keywords associated with property","type":"array","items":{"type":"string"}},"completionStatus":{"description":"The completion status of the property (notSet/completed/offPlan/completedPrimary/offPlanPrimary)","type":"string"},"paymentMethod":{"description":"The payment method of the property (notSet/cash/installments/cashOrInstallments)","type":"string"},"activeLanguages":{"description":"The languages currently set for the property.","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the property. Used for managing update concurrency","type":"string","readOnly":true},"_links":{"description":"Collection containing relative URLs to data associated with the property.\r\nIn the case of a development - where a property is grouped with, or associated to another property by way of a parent/child relationship,\r\nthe collection will contain a _master_ or _subPlot_ link depending on the property type. Where the property is the master record in a development (the parent),\r\na _subPlots_ link will be included in the collection giving you access to all the plots (the children) within the development. Where the property is a sub plot that forms part of a \r\ndevelopment, a _master_ link will be included in the collection giving you access to the master record.","type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true}}},"PropertyModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property. Properties can be grouped into developments in the source data, functionality that is typically used by New Homes departments.\r\nThe _links collection will expose specific links to allow developers to navigate through a particular development, should a property be configured in this manner. Refer to commentary on the _links collection for more details","type":"object","properties":{"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the property","type":"string"},"created":{"format":"date-time","description":"The date and time when the property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"marketingMode":{"description":"The marketing mode of the property (selling/letting/sellingAndLetting)","type":"string"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"localTimeZone":{"description":"The local timezone for the address, based on the Geolocation coordinates","type":"string"},"geolocation":{"description":"Representation of the geographical location of an address using coordinates","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"listingAdvertisementNumber":{"description":"The listing advertisement number of the property","type":"string"},"localAuthorityCompanyId":{"description":"The property's local authority","type":"string"},"localAuthorityCompanyName":{"description":"The name of the property's local authority","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"departmentId":{"description":"The unique identifier of the department the property is associated with. The property will only match to applicants with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"clientAccountsAssistantId":{"description":"The unique identifier of the client accounts assistant of the property","type":"string"},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property or properties. This is typically used when marketing development sites and would be set on the master record. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"disabledPortalIds":{"description":"A collection of identifiers of portals that the property should not be displayed on","type":"array","items":{"type":"string"}},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"isExternal":{"description":"A flag denoting whether or not the property has been instructed by another estate agent","type":"boolean"},"depositSchemeAccepted":{"description":"A flag denoting whether or not the property accepts deposit schemes","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information about the property.","type":"string"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"featuredImageUrl":{"format":"uri","description":"The properties featured image url","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"what3Words":{"description":"The What3Words identifier for the property.","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14"},"floorLevel":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"archivedOn":{"format":"date-time","description":"The date and time the property was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the property is archived","type":"boolean"},"rural":{"description":"Details specific to rural properties","type":"object","properties":{"tenureId":{"description":"Details of the rural tenure associated with the property.","type":"string"},"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"externalArea":{"description":"Representation of the plot size of a property","type":"object","properties":{"type":{"description":"The unit of area (acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Representation of the internal dimensions of a property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"epc":{"description":"Representation of EPC statistics","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerRating":{"description":"The current energy efficiency letter rating (A-G). This is generated from the `eer` value\r\nfor systems that do not have an explicit EPC Rating component","type":"string"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eerPotentialRating":{"description":"The potential energy efficiency letter rating (A-G). This is generated from the `eerPotential` value","type":"string"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirRating":{"description":"The current environment impact letter rating (A-G). This is generated from the `eir` value","type":"string"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"eirPotentialRating":{"description":"The potential environment impact letter rating (A-G). This is generated from the `eirPotential` value","type":"string"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Representation of a commercial EPC statistics","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"rightsRestrictions":{"description":"Details specific to a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Details specific to a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"selling":{"description":"Representation of property details specific to sales marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"double","description":"The marketing price of the property","type":"number"},"priceTo":{"format":"double","description":"The maximum price of a property on the development plot","type":"number"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Representation of the tenure of a property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"vendorId":{"description":"The unique identifier of the vendor selling the property","type":"string"},"agency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when Agency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"exchangedCompanyFee":{"format":"double","description":"The actual fee amount to be collected by the agent - often based on the exchange price of the property","type":"number"},"estimatedMonthlyRetailValue":{"format":"double","description":"The estimated monthly retail amount","type":"number"},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"exchangedPrice":{"format":"int32","description":"The price the property exchanged/sold for","type":"integer"},"exchangedOfficeId":{"description":"The unique identifier of the office that sold the property","type":"string"},"grossYieldPercentage":{"format":"double","description":"The gross yield amount","type":"number"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"letting":{"description":"Representation of property details specific to lettings marketing","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"The minimum number of months the property can be let out for","type":"integer"},"numberOfCheques":{"format":"int32","description":"The number of cheques payment required to rent the property","type":"integer"},"propertyManagerId":{"description":"The unique identifier of the negotiator that manages the property","type":"string"},"managementCompanyIds":{"description":"The unique identifiers of the management companies associated to the property","type":"array","items":{"type":"string"}},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"publicBrochureUrl":{"format":"uri","description":"The URL at which the brochure can be publicly accessed when the\r\nproperty is being actively marketed","type":"string"},"managementFee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Representation of the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Representation of a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Representation of property details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property licencing","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date","description":"The date the licence was applied for","type":"string","example":"2019-08-14"},"granted":{"format":"date","description":"The date the licence application was granted","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The date the licence will expire","type":"string","example":"2019-08-14"}}}}},"subAgentTerms":{"description":"Representation of the sub agent terms","type":"object","properties":{"feeAvailable":{"description":"A flag denoting whether or not fee is available","type":"boolean"},"type":{"description":"The type of fee (percent/fixed/callForFees)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"}}},"withdrawalReason":{"description":"Representation of withdrawal details specific to lettings marketing","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}},"preferredSuppliers":{"description":"List of preferred suppliers of the property","type":"array","items":{"description":"Representation of the preferred supplier details to lettings marketing.","type":"object","properties":{"id":{"description":"Unique identifier of the supplier.","type":"string"},"name":{"description":"Name of the supplier.","type":"string"}}}},"jointAgents":{"description":"Representation of joint agents information.","type":"object","properties":{"companies":{"description":"The list of companies that are joint agents.","type":"array","items":{"description":"Representation of a company.","type":"object","properties":{"id":{"description":"The unique identifier of the company.","type":"string"},"name":{"description":"The name of the company.","type":"string"}}}},"feeSplitPercentage":{"format":"double","description":"Percentage of the fee split that will go to the joint agents.","type":"number"}}}}},"commercial":{"description":"An properties commercial details","type":"object","properties":{"useClass":{"description":"The commercial use attributes (eg a1, a2, b1), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"floorLevel":{"description":"The commercial floor level attributes (eg basement, subGround, ground, upperFloor), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}}}},"regional":{"description":"Details relating to the real estate market in specific countries. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"ggy":{"description":"Any specific details relating to the marketing of a property in Guernsey","type":"object","properties":{"market":{"description":"Attributes describing which markets the property is available in (local/openA/openB/openC/openD)","type":"array","items":{"type":"string"}}}},"irl":{"description":"Any specific details relating to the marketing of a property in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Any specific details relating to energy performance ratings for properties marketed in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)\r\nFor information about how to interpret this data and how it maps back to AgencyCloud, please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#interpreting-department-data)","type":"array","items":{"type":"string"}},"specialFeatures":{"description":"The attributes describing the property's special features (eg swimmingPool, tennisCourt), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"unmappedAttributes":{"description":"The attributes associated to the property which are not currently mapped. These are defined the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"description":"Represents an unmapped attribute type","type":"object","properties":{"type":{"description":"The type of unmapped attribute (style/type/situation/parking/age/locality/special)","type":"string"},"value":{"description":"The value associated to the unmapped type","type":"string"}}}},"availableServicesIds":{"description":"Identifiers of any services connected at the property","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"lostInstructionDate":{"format":"date-time","description":"The date that this property became a lost instruction","type":"string","example":"2019-08-14T12:30:02Z"},"lostInstructionNote":{"description":"The notes regarding the lost instruction","type":"string"},"developmentSiteType":{"description":"The type of development","type":"string"},"metadata":{"description":"App specific metadata that has been set against the property","type":"object","additionalProperties":{}},"keywords":{"description":"The keywords associated with property","type":"array","items":{"type":"string"}},"completionStatus":{"description":"The completion status of the property (notSet/completed/offPlan/completedPrimary/offPlanPrimary)","type":"string"},"paymentMethod":{"description":"The payment method of the property (notSet/cash/installments/cashOrInstallments)","type":"string"},"activeLanguages":{"description":"The languages currently set for the property.","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the property. Used for managing update concurrency","type":"string","readOnly":true},"_links":{"description":"Collection containing relative URLs to data associated with the property.\r\nIn the case of a development - where a property is grouped with, or associated to another property by way of a parent/child relationship,\r\nthe collection will contain a _master_ or _subPlot_ link depending on the property type. Where the property is the master record in a development (the parent),\r\na _subPlots_ link will be included in the collection giving you access to all the plots (the children) within the development. Where the property is a sub plot that forms part of a \r\ndevelopment, a _master_ link will be included in the collection giving you access to the master record.","type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreatePropertyGeolocationModel":{"description":"Request body used to set the geolocation coordinates of a new property's address","required":["latitude","longitude"],"type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}},"CreatePropertyAddressModel":{"description":"Request body used to set the address of a new property","required":["line1"],"type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of a new property's address","required":["latitude","longitude"],"type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"CreatePropertyCommercialEpcModel":{"description":"Request body used to set the Commercial EPC statistic of a property","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The created EPC date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}},"CreatePropertyEpcModel":{"description":"Request body used to set the EPC statistic of a new property","type":"object","properties":{"created":{"format":"date-time","description":"The created EPC date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Request body used to set the Commercial EPC statistic of a property","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The created EPC date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"CreatePropertyRightsRestrictionsModel":{"description":"Request body to set a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"CreatePropertyFloodErosionModel":{"description":"Request body to set a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"CreatePropertyExternalAreaModel":{"description":"Request body to set the plot size of a new property","type":"object","properties":{"type":{"description":"The unit of area (acres/hectares). (This will be converted and returned as acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"CreatePropertyInternalAreaModel":{"description":"Request body to set the internal dimensions of a new property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"CreatePropertyRuralModel":{"description":"Request body used to set details specific to rural properties","type":"object","properties":{"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"CreatePropertyTenureModel":{"description":"Request body used to set the tenure of a new property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"CreatePropertyCommissionFeeModel":{"description":"Request body used to create the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"CreatePropertySharedOwnershipModel":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"CreatePropertySellingModel":{"description":"Request body used to set details specific to sales marketing on a new property. When creating a new sales property, a vendor record is automatically created. Please refer to the [Platform Glossary](http://foundations.link/glossary#vendor) for full details","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The marketing price of the property","type":"integer"},"priceTo":{"format":"int32","description":"The maximum marketing price of the property","type":"integer"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Request body used to set the tenure of a new property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"sellingAgency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when SellingAgency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Request body used to create the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}}}},"CreatePropertyCommissionFeeReductionModel":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"CreatePropertyLettingCommissionFeeModel":{"description":"Request body used to create the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"CreateUtilityModel":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"CreatePropertyLettingsDepositModel":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}},"CreatePropertyLettingModel":{"description":"Request body used to set details specific to lettings marketing on a new property","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"Sets the minimum number of months the property can be let out for","type":"integer"},"managementFee":{"description":"Request body used to create the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Request body used to create the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}}}},"CreateIrelandPropertyBERModel":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}},"CreateIrelandPropertyModel":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}},"CreatePropertyRegionalModel":{"description":"Request body used to set region specific property details. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"irl":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"PropertyRoomModelBase":{"description":"The base model containing data for reading, creating or updating a room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"}}},"CreatePropertyModel":{"description":"Request body used to create a new property","required":["marketingMode","departmentId","address","negotiatorId","officeIds"],"type":"object","properties":{"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"marketingMode":{"description":"The marketing mode of the property (selling/letting/sellingAndLetting)","type":"string"},"currency":{"description":"The currency that applies to monetary amounts exposed in the model\r\nWhen not supplied this will default to the customers default currency.","type":"string"},"departmentId":{"description":"The unique identifier of the department the property is associated with. The property will only match to applicants with the same values set. See the [Platform Glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information about departments","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"specialFeatures":{"description":"The property's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"address":{"description":"Request body used to set the address of a new property","required":["line1"],"type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to set the geolocation coordinates of a new property's address","required":["latitude","longitude"],"type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please refer to the glossary for support [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information for the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"floorLevel":{"format":"int32","description":"The floor level the property is on. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"epc":{"description":"Request body used to set the EPC statistic of a new property","type":"object","properties":{"created":{"format":"date-time","description":"The created EPC date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"description":"Request body used to set the Commercial EPC statistic of a property","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"created":{"format":"date-time","description":"The created EPC date","type":"string","example":"2019-08-14T12:30:02Z"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"}}}}},"rightsRestrictions":{"description":"Request body to set a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Request body to set a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"externalArea":{"description":"Request body to set the plot size of a new property","type":"object","properties":{"type":{"description":"The unit of area (acres/hectares). (This will be converted and returned as acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Request body to set the internal dimensions of a new property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"rural":{"description":"Request body used to set details specific to rural properties","type":"object","properties":{"buildingsDescription":{"description":"Details of the buildings associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"selling":{"description":"Request body used to set details specific to sales marketing on a new property. When creating a new sales property, a vendor record is automatically created. Please refer to the [Platform Glossary](http://foundations.link/glossary#vendor) for full details","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The marketing price of the property","type":"integer"},"priceTo":{"format":"int32","description":"The maximum marketing price of the property","type":"integer"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Request body used to set the tenure of a new property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"sellingAgency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when SellingAgency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Request body used to create the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}}}},"letting":{"description":"Request body used to set details specific to lettings marketing on a new property","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"Sets the minimum number of months the property can be let out for","type":"integer"},"managementFee":{"description":"Request body used to create the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Request body used to create the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to create a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetary amount based on the `type`","type":"number"}}}}},"regional":{"description":"Request body used to set region specific property details. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"irl":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"The base model containing data for reading, creating or updating a room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"}}}},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date-time","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"keywords":{"description":"The keywords associated with the property.","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the property","type":"object","additionalProperties":{}}},"example":{"lastCall":"2021-04-01","nextCall":"2021-06-01","marketingMode":"sellingAndLetting","currency":null,"departmentId":"G","strapline":null,"description":"We are delighted to offer for sale this EXTENDED THREE BEDROOMED SEMI DETACHED PROPERTY situated in a much sought after residential location of Greasby, having the benefits of two separate entertaining rooms, morning room, extended kitchen. To the first floor there are three bedrooms, spacious family bathroom, gas central heating gardens front and rear and off road parking.","summary":null,"alternateId":"10001","specialFeatures":null,"address":{"buildingName":"","buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":52.4158586,"longitude":1.7773383}},"bedrooms":4,"bedroomsMax":5,"numberOfUnits":0,"receptions":1,"receptionsMax":2,"bathrooms":2,"bathroomsMax":3,"parkingSpaces":0,"councilTax":"A","internetAdvertising":true,"viewingArrangements":"Accompanied viewings after 3PM only","videoUrl":"https://www.example.com/property/123/videoTour","videoCaption":"Virtual property tour","video2Url":"https://www.example.com/property/123/3dVideoTour","video2Caption":"3d virtual property tour","notes":"Property was on the market previously with another agent but struggled to get much interest","additionalInformation":"Additional information of the property","longDescription":"The ground floor accommodation comprises of a spacious reception hall with a wet bar, a grand drawing room, master bedroom suite and a further bedroom suite. The lower floor comprises of an eat in kitchen leading to converted vaults which could be used as staff accommodation or a study. There is also separate dining room and a further bedroom suite.","floorLevel":null,"internalFloors":null,"totalFloors":null,"boardStatus":"FS","boardNotes":"Include 'sold in a week' slip","boardUpdated":"2021-07-02","valuation":"2021-04-05","epc":{"created":"2021-04-05","exempt":false,"eer":45,"eerPotential":71,"eir":53,"eirPotential":81,"fullDocumentUrl":null,"firstPageDocumentUrl":null,"commercial":{"exempt":false,"epcRating":45,"created":"2021-04-05","fullDocumentUrl":"https://www.example.com/property/123/epc"}},"rightsRestrictions":{"listed":true,"restrictions":true,"easementsOrServitudesOrWayleaves":true,"rightOfWay":true},"floodErosion":{"floodedInLastFiveYears":false,"floodDefences":true,"floodSources":["lake","river"],"lastFlood":"2021-04-12"},"accessibility":["levelAccess","liftAccess"],"externalArea":{"type":"acres","min":1,"max":2},"internalArea":{"type":"squareFeet","min":1500,"max":2000},"rural":{"buildingsDescription":"2 barns and a stable","landDescription":"400 acres of mixed arable"},"selling":{"instructed":"2018-11-18","price":250000,"priceTo":null,"matchPriceFrom":0,"matchPriceTo":0,"reservationFee":0,"qualifier":"askingPrice","status":"underOffer","disposal":"privateTreaty","completed":"2019-08-27","exchanged":"2019-08-15","accountPaid":"2019-08-29","tenure":{"type":"leasehold","expiry":"2019-05-01"},"sellingAgency":"ownToSell","agencyId":null,"agreementExpiry":"2019-01-20","fee":{"type":"percentage","amount":2.5},"recommendedPrice":250000,"valuationPrice":null,"decoration":["good","veryGood"],"sharedOwnership":{"sharedPercentage":55.44,"rent":1250.55,"rentFrequency":"weekly"}},"letting":{"instructed":"2018-11-18","availableFrom":"2018-12-26","availableTo":"2019-03-23","agreementSigned":null,"rent":750,"rentFrequency":"monthly","rentIncludes":null,"furnishing":["furnished","partFurnished"],"agentRole":"managed","term":"long","status":"toLet","landlordId":"LLD210001","worksOrderNote":"Please arrange access to property directly with the tenant","minimumTerm":12,"managementFee":{"type":"fixed","amount":150},"lettingFee":{"firstReduction":{"type":"percentage","reducingTo":1.2,"reducingAfterMonths":6},"secondReduction":{"type":"percentage","reducingTo":1.1,"reducingAfterMonths":12},"type":"percentage","amount":1.3},"qualifier":"askingRent","utilities":{"hasGas":true,"gasCompanyId":"OXF21000001","gasMeterPoint":"123","electricityCompanyId":"OXF21000003","electricityMeterPoint":"789","waterCompanyId":"OXF21000002","waterMeterPoint":"456","telephoneCompanyId":"OXF21000006","internetCompanyId":"OXF21000004","cableTvCompanyId":"OXF21000005"},"deposit":{"type":"months","amount":1}},"regional":null,"type":["house"],"style":["detached"],"situation":["garden","land","patio"],"parking":["secure","doubleGarage"],"age":["period"],"locality":["rural","village"],"rooms":[{"name":"Kitchen","dimensions":"4.5m x 5.2m","description":"The breakfast kitchen, with utility, comprises a matching range of wall and base units with ceramic hob and eye level double oven. A side door leads to the front courtyard area."},{"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a Clearview stove, provides an ideal space to relax and unwind, whilst enjoying views over the Golf Course."},{"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room is the perfect space to entertain and provides access to the useful study."}],"roomDetailsApproved":false,"negotiatorId":"JAS","officeIds":["OXF","SOL"],"areaId":"BRM","url":"https://www.example.com/property/15-example-street/OXF200008","urlCaption":"View Property on Website","groundRent":24,"groundRentComment":"Payable in two bi-annual instalments","groundRentReviewDate":"2021-10-05","groundRentIncrease":42.66,"groundRentType":"confirmed","serviceCharge":24,"serviceChargeComment":"Payable in two bi-annual instalments","serviceChargeReviewDate":"2026-09-18T18:13:39.0463907+00:00","keywords":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdatePropertyGeolocationModel":{"description":"Request body used to update the geolocation coordinates of an existing property's address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}},"UpdatePropertyAddressModel":{"description":"Request body used to update the address of an existing property","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to update the geolocation coordinates of an existing property's address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"UpdatePropertyCommercialEpcModel":{"type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"}}},"UpdatePropertyEpcModel":{"description":"Request body used to update the EPC statistics of an existing property","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"UpdatePropertyRightsRestrictionsModel":{"description":"Request body to set a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"UpdatePropertyFloodErosionModel":{"description":"Request body to set a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"UpdatePropertyExternalAreaModel":{"description":"Request body to update the plot size of an existing property","type":"object","properties":{"type":{"description":"The unit of area (acres/hectares). (This will be converted and returned as acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"UpdatePropertyInternalAreaModel":{"description":"Request body to update the internal dimensions of an existing property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"UpdatePropertyTenureModel":{"description":"Request body used to set the tenure of an existing property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"UpdatePropertyCommissionFeeModel":{"description":"Request body used to update the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"UpdatePropertySharedOwnershipModel":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}},"UpdatePropertySellingModel":{"description":"Request body used to update details specific to sales marketing on an existing property","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The marketing price of the property","type":"integer"},"priceTo":{"format":"int32","description":"The maximum marketing price of the property","type":"integer"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Request body used to set the tenure of an existing property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"sellingAgency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when SellingAgency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Request body used to update the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}}}},"UpdatePropertyCommissionFeeReductionModel":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"UpdatePropertyLettingCommissionFeeModel":{"description":"Request body used to update the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"UpdateUtilityModel":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"UpdatePropertyLettingsDepositModel":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetry amount based on the `type`","type":"number"}}},"UpdatePropertyLettingRentInsuranceModel":{"description":"Request body used to update details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"UpdateLicenceApplicationModel":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date-time","description":"The date the licence was applied for","type":"string","example":"2019-08-14T12:30:02Z"},"granted":{"format":"date-time","description":"The date the licence application was granted","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The date the licence will expire","type":"string","example":"2019-08-14T12:30:02Z"}}},"UpdatePropertyLettingLicencingModel":{"description":"Representation of property details specific to property ;icencing","type":"object","properties":{"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date-time","description":"The date the licence was applied for","type":"string","example":"2019-08-14T12:30:02Z"},"granted":{"format":"date-time","description":"The date the licence application was granted","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The date the licence will expire","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"UpdatePropertyWithdrawalReasonModel":{"description":"Model for the property withdrawal reason update details","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}},"UpdatePropertyLettingModel":{"description":"Request body used to update details specific to lettings marketing on an existing property","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"Sets the minimum number of months the property can be let out for","type":"integer"},"managementFee":{"description":"Request body used to update the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Request body used to update the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetry amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Request body used to update details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property ;icencing","type":"object","properties":{"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date-time","description":"The date the licence was applied for","type":"string","example":"2019-08-14T12:30:02Z"},"granted":{"format":"date-time","description":"The date the licence application was granted","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The date the licence will expire","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"withdrawalReason":{"description":"Model for the property withdrawal reason update details","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}}}},"UpdateIrelandPropertyBERModel":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}},"UpdateIrelandPropertyModel":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}},"UpdatePropertyRegionalModel":{"description":"Request body used to set region specific property details. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"irl":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"UpdatePropertyRuralModel":{"description":"Request body used to set details specific to rural properties.","type":"object","properties":{"buildingsDescription":{"description":"Details of the building associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"UpdatePropertyModel":{"description":"Request body used to update an existing property","type":"object","properties":{"lastCall":{"format":"date","description":"The date the owner of the property was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the owner of the property is next due to be called","type":"string","example":"2019-08-14"},"roomDetailsApproved":{"description":"A flag determining whether or not the property's room details have been approved by the vendor or landlord","type":"boolean"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"alternateId":{"description":"An optional alternative identifier specified for this property","type":"string"},"specialFeatures":{"description":"The property's special feature property requirements (eg Swimming Pool, Tennis Court), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"address":{"description":"Request body used to update the address of an existing property","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"},"geolocation":{"description":"Request body used to update the geolocation coordinates of an existing property's address","type":"object","properties":{"latitude":{"format":"double","description":"The latitude coordinate of the coordinate pair","type":"number"},"longitude":{"format":"double","description":"The longitude coordinate of the coordinate pair","type":"number"}}}}},"bedrooms":{"format":"int32","description":"The total number of bedrooms in the property","type":"integer"},"bedroomsMax":{"format":"int32","description":"The maximum number of bedrooms in the property","type":"integer"},"numberOfUnits":{"format":"int32","description":"The number of units offered on the market. This is typically used when marketing development sites.","type":"integer"},"receptions":{"format":"int32","description":"The total number of reception rooms in the property","type":"integer"},"receptionsMax":{"format":"int32","description":"The maximum number of reception rooms in the property","type":"integer"},"bathrooms":{"format":"int32","description":"The total number of bathrooms in the property","type":"integer"},"bathroomsMax":{"format":"int32","description":"The maximum number of bathrooms in the property","type":"integer"},"parkingSpaces":{"format":"int32","description":"The total number of parking spaces the property has. This is only supported by some departments. Please refer to the glossary for support [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"integer"},"councilTax":{"description":"The council tax banding of the property (A/B/C/D/E/F/G/H/I/notYetAvailable)","type":"string"},"internetAdvertising":{"description":"A flag denoting whether or not this property can be advertised on the internet","type":"boolean"},"viewingArrangements":{"description":"The arrangements regarding viewing the property","type":"string"},"videoUrl":{"description":"The url of a video associated with this property, such as a virtual tour","type":"string"},"videoCaption":{"description":"The caption for the video url associated with this property","type":"string"},"video2Url":{"description":"The url of a second video associated with this property, such as a virtual tour","type":"string"},"video2Caption":{"description":"The caption for the second video url associated with this property","type":"string"},"notes":{"description":"Any general notes regarding the property. These are not usually exposed to end users and may contain sensitive information about a sale","type":"string"},"additionalInformation":{"description":"Additional information for the property","type":"string"},"longDescription":{"description":"The long description of the property","type":"string"},"floorLevel":{"format":"int32","description":"The floor level the property is on. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"internalFloors":{"format":"int32","description":"The number of internal floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"totalFloors":{"format":"int32","description":"The total number of floors the property has. Note that this field can only be set when certain configuration settings are enabled on the property's department. Please [refer to the glossary](https://foundations-documentation.reapit.cloud/platform-glossary#department) for more information","type":"integer"},"boardStatus":{"description":"The status of the advertising board sited outside or near to the property","type":"string"},"boardNotes":{"description":"Any notes relevant to the advertising board sited outside or near to the property","type":"string"},"boardUpdated":{"format":"date","description":"The date the advertising board was last updated (or should be updated when the date is in the future)","type":"string","example":"2019-08-14"},"valuation":{"format":"date","description":"The date on which the property was valued. Note that this can differ to physical appointment dates in some cases","type":"string","example":"2019-08-14"},"epc":{"description":"Request body used to update the EPC statistics of an existing property","type":"object","properties":{"created":{"format":"date-time","description":"The EPC creation date","type":"string","example":"2019-08-14T12:30:02Z"},"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"eer":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"eerPotential":{"format":"int32","description":"The potential energy efficiency rating","type":"integer"},"eir":{"format":"int32","description":"The current environmental impact rating","type":"integer"},"eirPotential":{"format":"int32","description":"The potential environmental impact rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"firstPageDocumentUrl":{"description":"The URL to access the first page of the EPC document","type":"string"},"commercial":{"type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring an EPC certificate","type":"boolean"},"epcRating":{"format":"int32","description":"The current energy efficiency rating","type":"integer"},"fullDocumentUrl":{"description":"The URL to access the full EPC document","type":"string"},"created":{"format":"date-time","description":"The commercial EPC created date","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"rightsRestrictions":{"description":"Request body to set a properties rights restrictions","type":"object","properties":{"listed":{"description":"A flag determining if the property is listed.","type":"boolean"},"restrictions":{"description":"A flag determining if the property has restrictions.","type":"boolean"},"easementsOrServitudesOrWayleaves":{"description":"A flag determining if the property has any easements, servitudes or wayleaves.","type":"boolean"},"rightOfWay":{"description":"A flag determining if their are any public rights of way across the property or its boundaries","type":"boolean"}}},"floodErosion":{"description":"Request body to set a properties flood erosion","type":"object","properties":{"floodedInLastFiveYears":{"description":"A flag determining if the property has flooded in the last 5 years.","type":"boolean"},"floodDefences":{"description":"A flag determining if the property has flood defences.","type":"boolean"},"floodSources":{"description":"A list of flood sources which affect the property (river/lake/sea/reservoir/groundwater/other)","type":"array","items":{"type":"string"}},"lastFlood":{"format":"date-time","description":"The date and time the property was last flooded","type":"string","example":"2019-08-14T12:30:02Z"}}},"accessibility":{"description":"A list of accesibility options provided by the property (unsuitableForWheelchairs/levelAccess/liftAccess/rampedAccess/wetRoom/wideDoorways/stepFreeAccess/levelAccessShower/lateralLiving)","type":"array","items":{"type":"string"}},"externalArea":{"description":"Request body to update the plot size of an existing property","type":"object","properties":{"type":{"description":"The unit of area (acres/hectares). (This will be converted and returned as acres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound (please note there is no corresponding field in the Reapit CRM)","type":"number"}}},"internalArea":{"description":"Request body to update the internal dimensions of an existing property","type":"object","properties":{"type":{"description":"The unit of area (squareFeet/squareMetres)","type":"string"},"min":{"format":"double","description":"The minimum area bound","type":"number"},"max":{"format":"double","description":"The maximum area bound","type":"number"}}},"selling":{"description":"Request body used to update details specific to sales marketing on an existing property","type":"object","properties":{"instructed":{"format":"date","description":"The date that the property was marked as for sale","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The marketing price of the property","type":"integer"},"priceTo":{"format":"int32","description":"The maximum marketing price of the property","type":"integer"},"matchPriceFrom":{"format":"int32","description":"The minimum marketing match price of the property","type":"integer"},"matchPriceTo":{"format":"int32","description":"The maximum marketing match price of the property","type":"integer"},"reservationFee":{"format":"int32","description":"The fee charged by the agent to reserve a property (typically a new build)","type":"integer"},"qualifier":{"description":"The price qualifier (askingPrice/priceOnApplication/guidePrice/offersInRegion/offersOver/offersInExcess/fixedPrice/priceReducedTo)","type":"string"},"status":{"description":"The current status of the sale (preAppraisal/valuation/paidValuation/forSale/forSaleUnavailable/underOffer/underOfferUnavailable/reserved/exchanged/completed/soldExternally/withdrawn)","type":"string"},"disposal":{"description":"The method used to sell the property (auction/confidential/tender/offersInvited/privateTreaty/sharedOwnership/modernMethodOfAuction)","type":"string"},"completed":{"format":"date","description":"The date the property sale was completed","type":"string","example":"2019-08-14"},"exchanged":{"format":"date","description":"The date the property was exchanged","type":"string","example":"2019-08-14"},"accountPaid":{"format":"date","description":"The date the property account was paid","type":"string","example":"2019-08-14"},"tenure":{"description":"Request body used to set the tenure of an existing property","type":"object","properties":{"type":{"description":"The type of tenure that applies to the property (freehold/leasehold/shareOfFreehold/commonhold/tba)","type":"string"},"expiry":{"format":"date","description":"The tenure expiration date","type":"string","example":"2019-08-14"}}},"sellingAgency":{"description":"The selling agency type (marketingForAssociate/clientsOnly/comparable/subAgent/jointSole/jointSoleFeeAvailable/multiple/multipleFeeAvailable/ownToSell/soleSellingRights/soleSellingRightsFeeAvailable/soleAgent/soleAgentFeeAvailable)","type":"string"},"agencyId":{"description":"The unique identifier of the custom selling agency type - only applicable when SellingAgency is not set","type":"string"},"agreementExpiry":{"format":"date","description":"The date on which the agreement between the vendor and agent expires","type":"string","example":"2019-08-14"},"fee":{"description":"Request body used to update the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"recommendedPrice":{"format":"int32","description":"The agent's recommended asking price","type":"integer"},"valuationPrice":{"format":"int32","description":"The agent's valuation price","type":"integer"},"brochureId":{"description":"The unique identifier of the document used for the sales brochure","type":"string"},"decoration":{"description":"The property's decorative condition (unmodernised/fair/good/veryGood)","type":"array","items":{"type":"string"}},"sharedOwnership":{"description":"Details relating to the shared ownership of the property","type":"object","properties":{"sharedPercentage":{"format":"double","description":"The percentage of the shared ownership property being sold by the vendor","type":"number"},"rent":{"format":"double","description":"The rent payable on the remainder of the shared ownership property","type":"number"},"rentFrequency":{"description":"The frequency at which the shared ownership rent should be paid","type":"string"}}}}},"letting":{"description":"Request body used to update details specific to lettings marketing on an existing property","type":"object","properties":{"instructed":{"format":"date","description":"The date the property was marked as to let","type":"string","example":"2019-08-14"},"availableFrom":{"format":"date","description":"The date the property is next available from","type":"string","example":"2019-08-14"},"availableTo":{"format":"date","description":"The date the property is available to","type":"string","example":"2019-08-14"},"agreementSigned":{"format":"date","description":"The date the letting agreement between the landlord and agent was signed","type":"string","example":"2019-08-14"},"rent":{"format":"double","description":"The rent being charged for the property","type":"number"},"rentFrequency":{"description":"The frequency at which rent will be collected (weekly/monthly/annually)","type":"string"},"rentIncludes":{"description":"Details of any bills that are included in the rent","type":"string"},"furnishing":{"description":"The furnishing state that the property can be offered in (furnished/unfurnished/partFurnished)","type":"array","items":{"type":"string"}},"term":{"description":"The acceptable letting terms (short/long/any)","type":"string"},"status":{"description":"The current status of the let (valuation/toLet/toLetUnavailable/underOffer/underOfferUnavailable/arrangingTenancyUnavailable/arrangingTenancy/tenancyCurrentUnavailable/tenancyCurrent/tenancyFinished/tenancyCancelled/sold/letByOtherAgent/letPrivately/provisional/withdrawn)","type":"string"},"agentRole":{"description":"The role that the agent will be performing for this lettings property (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"landlordId":{"description":"The unique identifier of the landlord letting the property","type":"string"},"brochureId":{"description":"The unique identifier of the document used for the lettings brochure","type":"string"},"worksOrderNote":{"description":"A note to accompany any works orders created for the property","type":"string"},"minimumTerm":{"format":"int32","description":"Sets the minimum number of months the property can be let out for","type":"integer"},"managementFee":{"description":"Request body used to update the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"lettingFee":{"description":"Request body used to update the commission fee details for a lettings property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"},"firstReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}},"secondReduction":{"description":"Request body used to update a reduction of the commission fee for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"reducingTo":{"format":"double","description":"The amount the fee is being reduced to.","type":"number"},"reducingAfterMonths":{"format":"int32","description":"The number of months after which the reduction applies.","type":"integer"}}}}},"qualifier":{"description":"The rent qualifier (rentOnApplication/askingRent)","type":"string"},"utilities":{"description":"Representation of property details specific to utilities","type":"object","properties":{"hasGas":{"description":"A flag denoting whether or not the property has gas connected","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company supplying the gas to the property","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company supplying the electricity to the property","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"},"waterCompanyId":{"description":"The unique identifier of the company supplying the water to the property","type":"string"},"waterMeterPoint":{"description":"The water meter point number","type":"string"},"telephoneCompanyId":{"description":"The unique identifier of the company supplying the telephone to the property","type":"string"},"internetCompanyId":{"description":"The unique identifier of the company supplying the internet to the property","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of the company supplying the cable tv to the property","type":"string"}}},"deposit":{"description":"Representation of a property details related to deposit","type":"object","properties":{"type":{"description":"The type of deposit (weeks/months/fixed)","type":"string"},"amount":{"format":"double","description":"The deposit amount. This can be the number of weeks or months rent or a monetry amount based on the `type`","type":"number"}}},"rentInsurance":{"description":"Request body used to update details specific to rent insurance associated with a lettings property","type":"object","properties":{"status":{"description":"Status indicating whether or not rent protection insurance has been taken out (notAsked/cancelled/declined/quoted/taken)\r\n(These options can be partially overridden - refer to configuration endpoint)","type":"string"},"referenceNumber":{"description":"The reference number of the insurance policy when rent protection insurance has been taken out","type":"string"},"start":{"format":"date","description":"The insurance policy start date","type":"string","example":"2019-08-14"},"end":{"format":"date","description":"The insurance policy end date","type":"string","example":"2019-08-14"},"cancelledReasonId":{"description":"The identifier of the reason the insurance policy was cancelled, to be used in conjunction with the relevant configuration API endpoint","type":"string"},"cancelledComment":{"description":"A textual comment or note entered by the agent when an insurance policy was cancelled","type":"string"},"autoRenew":{"description":"Flag indicating whether or not the insurance policy should auto renew","type":"boolean"}}},"licencing":{"description":"Representation of property details specific to property ;icencing","type":"object","properties":{"licenceRequired":{"description":"A flag determining whether or not a licence is required to let the property. Typically\r\nrequired for houses of multiple occupancy (HMOs)","type":"boolean"},"licenceTypeRequired":{"description":"The type of licence required (additional/mandatory/none/notSet/selective)","type":"string"},"licenceType":{"description":"The type of licence granted (additional/mandatory/none/notSet/selective)","type":"string"},"referenceNumber":{"description":"The licence reference number","type":"string"},"households":{"format":"int32","description":"The number of households that the licence permits in the property","type":"integer"},"occupants":{"format":"int32","description":"The number of occupants that the licence permits in the property","type":"integer"},"aboveCommercialPremises":{"description":"A flag determining whether or not the property is above commercial premises","type":"boolean"},"licenceComplianceStatus":{"description":"The status of the licence compliance (unknown/compliant/nonCompliant)","type":"string"},"section257Property":{"description":"Whether or not the property is a Section 257 property (yes/no/notSet)","type":"string"},"article4":{"description":"Whether or not the property is an Article 4 property (yes/no/notSet)","type":"string"},"hasRestrictions":{"description":"A flag determining whether or not the property has restrictions","type":"boolean"},"restrictionDetails":{"description":"The details of any property restrictions","type":"string"},"currentTenancyHouseholds":{"format":"int32","description":"The number of current tenancy households in the property","type":"integer"},"application":{"description":"Representation of property details specific to property licence application","type":"object","properties":{"status":{"description":"The status of the licence application (applied/granted/landlordApplying/notApplicable)","type":"string"},"referenceNumber":{"description":"The application reference number","type":"string"},"date":{"format":"date-time","description":"The date the licence was applied for","type":"string","example":"2019-08-14T12:30:02Z"},"granted":{"format":"date-time","description":"The date the licence application was granted","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The date the licence will expire","type":"string","example":"2019-08-14T12:30:02Z"}}}}},"withdrawalReason":{"description":"Model for the property withdrawal reason update details","type":"object","properties":{"typeId":{"description":"Reason type for withdrawal of the property","type":"string"},"reason":{"description":"Reason for withdrawal of the property","type":"string"},"withdrawalDate":{"format":"date-time","description":"Date of instruction was withdrawn","type":"string","example":"2019-08-14T12:30:02Z"},"instructedAgentId":{"description":"The unique identifier of the instructed agent.","type":"string"}}}}},"regional":{"description":"Request body used to set region specific property details. Child models are named based on the ISO3166 country code that the data inside the model relates to","type":"object","properties":{"irl":{"description":"Request body used to set the data specific to properties in Ireland","type":"object","properties":{"buildingEnergyRating":{"description":"Request body used to set the energy performance rating information for properties in Ireland","type":"object","properties":{"exempt":{"description":"A flag denoting whether or not this property is exempt from requiring a Building Energy Rating (BER) certificate","type":"boolean"},"rating":{"description":"The BER rating of the property","type":"string"},"refNumber":{"description":"The BER certificate reference number","type":"string"},"epi":{"description":"The energy performance indicator for the property","type":"string"}}}}}}},"rural":{"description":"Request body used to set details specific to rural properties.","type":"object","properties":{"buildingsDescription":{"description":"Details of the building associated with the property.","type":"string"},"landDescription":{"description":"Details of the land associated with the property.","type":"string"}}},"type":{"description":"The attributes describing the overall type of the property (eg house, bungalow, land), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"style":{"description":"The attributes describing the style of property (eg detached, semiDetached), defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"situation":{"description":"The attributes describing other aspects of the property - such as outside space - as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"parking":{"description":"The attributes describing the parking available at the property (eg garage), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"age":{"description":"The attributes describing the age of the property (eg new, period), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"locality":{"description":"The attributes describing the general location of the property (eg rural, townCity), as defined by the property's [department](https://foundations-documentation.reapit.cloud/platform-glossary#department)","type":"array","items":{"type":"string"}},"rooms":{"description":"Details of each room in the property","type":"array","items":{"description":"The base model containing data for reading, creating or updating a room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"}}}},"negotiatorId":{"description":"The unique identifier of the negotiator managing the property","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the property. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"areaId":{"description":"The unique identifier of the area that the property resides in","type":"string"},"url":{"description":"The url to the property on an external website","type":"string"},"urlCaption":{"description":"The caption to accompany the url to the property on an external website","type":"string"},"groundRent":{"format":"double","description":"Any ground rent payment that applies to the property","type":"number"},"groundRentComment":{"description":"Comments regarding the ground rent of the property","type":"string"},"groundRentReviewDate":{"format":"date-time","description":"The date when the ground rent payable on the property should be reviewed","type":"string","example":"2019-08-14T12:30:02Z"},"groundRentIncrease":{"format":"double","description":"The annual percentage increase of the ground rent after being reviewed","type":"number"},"groundRentType":{"description":"The ground rent type (notApplicable/peppercorn/toBeConfirmed/confirmed)","type":"string"},"serviceCharge":{"format":"double","description":"Any service charge payment that applies to the property","type":"number"},"serviceChargeComment":{"description":"Comments regarding the service charge of the property","type":"string"},"serviceChargeReviewDate":{"format":"date","description":"The date when the service charge payable on the property should be reviewed","type":"string","example":"2019-08-14"},"availableServicesIds":{"description":"Identifiers of any services connected at the property","type":"array","items":{"type":"string"}},"keywords":{"description":"The keywords associated with the property.","type":"array","items":{"type":"string"}},"metadata":{"description":"App specific metadata to set against the property","type":"object","additionalProperties":{}}},"example":{"lastCall":"2021-04-01","nextCall":"2021-06-01","roomDetailsApproved":null,"strapline":null,"description":"We are delighted to offer for sale this EXTENDED THREE BEDROOMED SEMI DETACHED PROPERTY situated in a much sought after residential location of Greasby, having the benefits of two separate entertaining rooms, morning room, extended kitchen. To the first floor there are three bedrooms, spacious family bathroom, gas central heating gardens front and rear and off road parking.","summary":null,"alternateId":"10002","specialFeatures":null,"address":{"buildingName":null,"buildingNumber":"15","line1":"Example street","line2":"Solihull","line3":"West Midlands","line4":"","postcode":"B91 2XX","countryId":"GB","geolocation":{"latitude":52.4158586,"longitude":1.7773383}},"bedrooms":4,"bedroomsMax":5,"numberOfUnits":0,"receptions":1,"receptionsMax":2,"bathrooms":2,"bathroomsMax":3,"parkingSpaces":0,"councilTax":"A","internetAdvertising":true,"viewingArrangements":"Accompanied viewings after 3PM only","videoUrl":"https://www.example.com/property/123/videoTour","videoCaption":"Virtual property tour","video2Url":"https://www.example.com/property/123/3dVideoTour","video2Caption":"3d virtual property tour","notes":"Property was on the market previously with another agent but struggled to get much interest","additionalInformation":"Additional information of the property","longDescription":"The ground floor accommodation comprises of a spacious reception hall with a wet bar, a grand drawing room, master bedroom suite and a further bedroom suite. The lower floor comprises of an eat in kitchen leading to converted vaults which could be used as staff accommodation or a study. There is also separate dining room and a further bedroom suite.","floorLevel":null,"internalFloors":null,"totalFloors":null,"boardStatus":"FS","boardNotes":"Include 'sold in a week' slip","boardUpdated":"2021-07-02","valuation":"2021-04-05","epc":{"created":"2021-04-05","exempt":false,"eer":45,"eerPotential":71,"eir":53,"eirPotential":81,"fullDocumentUrl":null,"firstPageDocumentUrl":null,"commercial":{"created":"2021-04-05","exempt":false,"epcRating":45,"fullDocumentUrl":"https://www.example.com/property/123/epc"}},"rightsRestrictions":{"listed":true,"restrictions":true,"easementsOrServitudesOrWayleaves":true,"rightOfWay":true},"floodErosion":{"floodedInLastFiveYears":false,"floodDefences":true,"floodSources":["lake","river"],"lastFlood":"2021-04-12"},"accessibility":["levelAccess","liftAccess"],"externalArea":{"type":"acres","min":1,"max":2},"internalArea":{"type":"squareFeet","min":1500,"max":2000},"selling":{"instructed":"2018-11-18","price":250000,"priceTo":null,"matchPriceFrom":240000,"matchPriceTo":260000,"reservationFee":0,"qualifier":"askingPrice","status":"underOffer","disposal":"privateTreaty","completed":"2019-08-27","exchanged":"2019-08-15","accountPaid":"2019-08-29","tenure":{"type":"leasehold","expiry":"2019-05-01"},"sellingAgency":"ownToSell","agencyId":null,"agreementExpiry":"2019-01-20","fee":{"type":"fixed","amount":1900},"recommendedPrice":450000,"valuationPrice":null,"brochureId":null,"decoration":["good","veryGood"],"sharedOwnership":{"sharedPercentage":45.55,"rent":1350.25,"rentFrequency":"fourWeekly"}},"letting":{"instructed":"2018-11-18","availableFrom":"2018-12-26","availableTo":"2019-03-23","agreementSigned":"2019-03-24","rent":750,"rentFrequency":"monthly","rentIncludes":null,"furnishing":["furnished","partFurnished"],"term":"long","status":"toLet","agentRole":"managed","landlordId":"LLD210001","brochureId":null,"worksOrderNote":"Please arrange access to property directly with the tenant","minimumTerm":12,"managementFee":{"type":"percentage","amount":11.8},"lettingFee":{"firstReduction":{"type":"fixed","reducingTo":175,"reducingAfterMonths":6},"secondReduction":{"type":"fixed","reducingTo":160,"reducingAfterMonths":12},"type":"fixed","amount":190},"qualifier":"askingRent","utilities":{"hasGas":true,"gasCompanyId":"OXF21000007","gasMeterPoint":"312123","electricityCompanyId":"OXF21000009","electricityMeterPoint":"123876","waterCompanyId":"OXF21000008","waterMeterPoint":"34666","telephoneCompanyId":"OXF21000012","internetCompanyId":"OXF21000010","cableTvCompanyId":"OXF21000011"},"deposit":{"type":"weeks","amount":4},"rentInsurance":null,"licencing":{"licenceRequired":true,"licenceTypeRequired":"additional","licenceType":"additional","referenceNumber":"A001","households":1,"occupants":2,"aboveCommercialPremises":false,"licenceComplianceStatus":"compliant","section257Property":"yes","article4":"no","hasRestrictions":true,"restrictionDetails":"Example restriction details","currentTenancyHouseholds":1,"application":{"status":"landlordApplying","referenceNumber":"0001","date":"2022-12-26","granted":"2023-01-15","expiry":"2023-07-15"}},"withdrawalReason":{"typeId":"Reason Type Id","reason":"Test Reason","withdrawalDate":"2021-04-12","instructedAgentId":null}},"regional":null,"rural":{"buildingsDescription":"2 barns and a stable","landDescription":"400 acres of mixed arable"},"type":["house"],"style":["detached"],"situation":["garden","land","patio"],"parking":["secure","doubleGarage"],"age":["period"],"locality":["rural","village"],"rooms":null,"negotiatorId":"JAS","officeIds":["OXF","SOL"],"areaId":"BRM","url":"https://www.example.com/property/15-example-street/OXF200008","urlCaption":"View Property on Website","groundRent":24,"groundRentComment":"Payable in two bi-annual instalments","groundRentReviewDate":"2021-11-12","groundRentIncrease":35.25,"groundRentType":"confirmed","serviceCharge":24,"serviceChargeComment":"Payable in two bi-annual instalments","serviceChargeReviewDate":"2026-12-18T18:13:39.2059492+00:00","availableServicesIds":["MW","GA","FB"],"keywords":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"PropertyCertificateModel":{"description":"Representation of a cerificate","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The certificate's category (safetyCertificate/insurancePolicy/warranty)","type":"string"},"typeId":{"description":"The certificate's type","type":"string"},"start":{"format":"date-time","description":"The certificate's start date","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The certificate's expiry date","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"companyId":{"description":"The unique identifier of the company","type":"string"},"statusId":{"description":"The unique identifier of the certificates status","type":"string"},"notes":{"description":"Any general notes regarding the certificate","type":"string"},"referenceNumber":{"description":"The certificate's reference number","type":"string"},"responsibleParty":{"description":"The party responsible for the certificate, as defined in property configuration (agent/landlord/notRequired/notSet)","type":"string"},"_eTag":{"description":"The ETag for the current version of the certificate. Used for managing update concurrency","type":"string","readOnly":true}}},"PropertyCertificateModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a cerificate","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the certificate","type":"string"},"created":{"format":"date-time","description":"The date and time when the certificate was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the certificate was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The certificate's category (safetyCertificate/insurancePolicy/warranty)","type":"string"},"typeId":{"description":"The certificate's type","type":"string"},"start":{"format":"date-time","description":"The certificate's start date","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The certificate's expiry date","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"companyId":{"description":"The unique identifier of the company","type":"string"},"statusId":{"description":"The unique identifier of the certificates status","type":"string"},"notes":{"description":"Any general notes regarding the certificate","type":"string"},"referenceNumber":{"description":"The certificate's reference number","type":"string"},"responsibleParty":{"description":"The party responsible for the certificate, as defined in property configuration (agent/landlord/notRequired/notSet)","type":"string"},"_eTag":{"description":"The ETag for the current version of the certificate. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateCertificateModel":{"description":"Request body used to create a new certificate.","type":"object","properties":{"category":{"description":"The certificate's category (safetyCertificate/insurancePolicy/warranty).","type":"string"},"typeId":{"description":"The unique identifier of the certificate's type.","type":"string"},"start":{"format":"date","description":"The certificate's start date.","type":"string","example":"2019-08-14"},"expiry":{"format":"date","description":"The certificate's expiry date.","type":"string","example":"2019-08-14"},"companyId":{"description":"The unique identifier of the company that supplied, or is supplying, the certificate.","type":"string"},"notes":{"description":"Any general notes regarding the certificate.","type":"string"},"referenceNumber":{"description":"The certificate's reference number.","type":"string"},"statusId":{"description":"The unique identifier of the certificate's status.","type":"string"}},"example":{"category":"safetyCertificate","typeId":"GS","start":"2021-01-01","expiry":"2022-01-01","companyId":"CMP21000001","notes":"Some notes about the certificate","referenceNumber":"123456789","statusId":null}},"UpdateCertificateModel":{"description":"Request body used to update an existing certificate.","type":"object","properties":{"start":{"format":"date-time","description":"The certificate's start date.","type":"string","example":"2019-08-14T12:30:02Z"},"expiry":{"format":"date-time","description":"The certificate's expiry date.","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the company.","type":"string"},"notes":{"description":"Any general notes regarding the certificate.","type":"string"},"referenceNumber":{"description":"The certificate's reference number.","type":"string"},"statusId":{"description":"The unique identifier of the certificate's status.","type":"string"}},"example":{"start":"2021-01-01","expiry":"2022-01-01","companyId":"CMP21000001","notes":"Some notes about the certificate","referenceNumber":"123456789","statusId":null}},"CertificateResponsiblePartyModel":{"description":"Record describing the responsible party for a given type of certificate within a property entry","type":"object","properties":{"typeId":{"description":"Identifier for the type of certificate for which the party is responsible","type":"string"},"responsibleParty":{"description":"The party responsible for the specified certificate type (landlord/agent/notRequired/notSet)","type":"string"}}},"PropertyCertificateResponsibilitiesModel":{"description":"Representation of certificate responsibilities configured for a property","type":"object","properties":{"id":{"description":"The id of the property to which the configured certificate responsibilities apply","type":"string"},"created":{"format":"date-time","description":"The date and time on which the property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time on which the property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"responsibleParties":{"description":"The configured certificate responsibilities","type":"array","items":{"description":"Record describing the responsible party for a given type of certificate within a property entry","type":"object","properties":{"typeId":{"description":"Identifier for the type of certificate for which the party is responsible","type":"string"},"responsibleParty":{"description":"The party responsible for the specified certificate type (landlord/agent/notRequired/notSet)","type":"string"}}}},"_eTag":{"description":"The ETag for the current version of the property. Used for managing update concurrency","type":"string","readOnly":true}}},"UpdateCertificateResponsiblePartyModel":{"description":"Record describing the responsible party for a given type of certificate within a property entry","type":"object","properties":{"typeId":{"description":"Identifier for the type of certificate for which the party is responsible","type":"string"},"responsibleParty":{"description":"The party responsible for the specified certificate type (landlord/agent/notRequired/notSet)","type":"string"}}},"UpdateCertificateResponsibilitiesModel":{"description":"Object containing a collection of certificate type to responsible party mappings","type":"object","properties":{"responsibleParties":{"description":"A collection of certificate type to responsible party mappings","type":"array","items":{"description":"Record describing the responsible party for a given type of certificate within a property entry","type":"object","properties":{"typeId":{"description":"Identifier for the type of certificate for which the party is responsible","type":"string"},"responsibleParty":{"description":"The party responsible for the specified certificate type (landlord/agent/notRequired/notSet)","type":"string"}}}}},"example":{"responsibleParties":[{"typeId":"BI","responsibleParty":"landlord"},{"typeId":"FS","responsibleParty":"agent"},{"typeId":"SI","responsibleParty":"notRequired"},{"typeId":"MW","responsibleParty":"notSet"}]}},"IndividualKeyModel":{"description":"Representation of an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}},"KeysModel":{"description":"Representation of a set of keys","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key","type":"string"},"created":{"format":"date-time","description":"The date and time when the key was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"number":{"description":"The number assigned to the key - key numbers can only be occupied by a single property within an office concurrently","type":"string"},"typeId":{"description":"The unique identifier of the key type","type":"string"},"officeId":{"description":"The unique identifier of the office responsible for the key","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key belongs to","type":"string"},"status":{"description":"The status of the key (checkedIn/checkedOut/noLongerHeld)","type":"string"},"keysInSet":{"description":"A listing of the individual keys included in the set","type":"array","items":{"description":"Representation of an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}},"KeysModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a set of keys","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key","type":"string"},"created":{"format":"date-time","description":"The date and time when the key was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"number":{"description":"The number assigned to the key - key numbers can only be occupied by a single property within an office concurrently","type":"string"},"typeId":{"description":"The unique identifier of the key type","type":"string"},"officeId":{"description":"The unique identifier of the office responsible for the key","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key belongs to","type":"string"},"status":{"description":"The status of the key (checkedIn/checkedOut/noLongerHeld)","type":"string"},"keysInSet":{"description":"A listing of the individual keys included in the set","type":"array","items":{"description":"Representation of an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateIndividualKeyModel":{"description":"Request body used to create an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}},"CreateKeyModel":{"description":"Request body used to create a new set of keys","type":"object","properties":{"number":{"description":"The number assigned to the key - key numbers can only be occupied by a single property within an office concurrently","type":"string"},"typeId":{"description":"The unique identifier of the key type","type":"string"},"officeId":{"description":"The unique identifier of the office responsible for the key","type":"string"},"keysInSet":{"description":"A listing of the individual keys included in the set","type":"array","items":{"description":"Request body used to create an individual key included in a key set","type":"object","properties":{"name":{"description":"The name of the individual key in the set","type":"string"}}}}},"example":{"number":"#11231","typeId":"LE","officeId":"OXF","keysInSet":[{"name":"Front door key"},{"name":"Porch key"}]}},"KeyMovementModel":{"description":"Representation of a key movement","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key movement","type":"string"},"created":{"format":"date-time","description":"The date and time when the key movement was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key movement was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"keyId":{"description":"The unique identifier of the key set this movement belongs to","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key set belongs to","type":"string"},"checkOutToId":{"description":"The unique identifier of the contact/negotiator that the key is checked out with","type":"string"},"checkOutToType":{"description":"The type of entity that checked out the key (contact/negotiator)","type":"string"},"checkOutAt":{"format":"date-time","description":"The date and time of when the key set was checked out","type":"string","example":"2019-08-14T12:30:02Z"},"checkOutNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check out","type":"string"},"checkInAt":{"format":"date-time","description":"The date and time of when the key set was checked in","type":"string","example":"2019-08-14T12:30:02Z"},"checkInNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check in","type":"string"},"_eTag":{"description":"The ETag for the current version of the key movement. Used for managing update concurrency","type":"string","readOnly":true}}},"KeyMovementModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a key movement","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the key movement","type":"string"},"created":{"format":"date-time","description":"The date and time when the key movement was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the key movement was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"keyId":{"description":"The unique identifier of the key set this movement belongs to","type":"string"},"propertyId":{"description":"The unique identifier of the property that the key set belongs to","type":"string"},"checkOutToId":{"description":"The unique identifier of the contact/negotiator that the key is checked out with","type":"string"},"checkOutToType":{"description":"The type of entity that checked out the key (contact/negotiator)","type":"string"},"checkOutAt":{"format":"date-time","description":"The date and time of when the key set was checked out","type":"string","example":"2019-08-14T12:30:02Z"},"checkOutNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check out","type":"string"},"checkInAt":{"format":"date-time","description":"The date and time of when the key set was checked in","type":"string","example":"2019-08-14T12:30:02Z"},"checkInNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check in","type":"string"},"_eTag":{"description":"The ETag for the current version of the key movement. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateKeyMovementModel":{"description":"Request body used to create a new key movement","type":"object","properties":{"checkInRequired":{"description":"Indicates whether the key is expected to be checked back in. Set to true when the key is no longer held (eg. returned to the landlord)","type":"boolean"},"checkOutToId":{"description":"The unique identifier of the contact or negotiator to check out the key with - this person will be recorded as holding the key","type":"string"},"checkOutToType":{"description":"The type of entity that checked out the key (contact/negotiator)","type":"string"},"checkOutNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check out","type":"string"}},"example":{"checkInRequired":true,"checkOutToId":"CMB","checkOutToType":"negotiator","checkOutNegotiatorId":"PLL"}},"CheckInKeyModel":{"description":"Request body used for checking in a key","type":"object","properties":{"checkInNegotiatorId":{"description":"The unique identifier of the negotiator who performed the key check in","type":"string"}},"example":{"checkInNegotiatorId":"JAS"}},"PropertyCheckModel":{"description":"Representation of a check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the check","type":"string"},"created":{"format":"date-time","description":"The date and time when the check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the check relates to","type":"string"},"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the check (preInstruction/certificate/offer/breakClause/allowance/responsibility)","type":"string"},"propertyId":{"description":"The unique identifier of the property that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the check. Used for managing update concurrency","type":"string","readOnly":true}}},"PropertyCheckModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the check","type":"string"},"created":{"format":"date-time","description":"The date and time when the check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the check relates to","type":"string"},"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the check (preInstruction/certificate/offer/breakClause/allowance/responsibility)","type":"string"},"propertyId":{"description":"The unique identifier of the property that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreatePropertyCheckModel":{"description":"Request body used to create a new check","required":["description","type","status"],"type":"object","properties":{"description":{"description":"Short, descriptive text describing the purpose of the check","type":"string"},"type":{"description":"The type of the check (preInstruction)","type":"string"},"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"}},"example":{"description":"Ad-Hoc Check","type":"preInstruction","status":"needed"}},"UpdatePropertyCheckModel":{"description":"Model for the update of an existing check","type":"object","properties":{"status":{"description":"The status of the check (needed/notNeeded/arranging/completed)","type":"string"}},"example":{"status":"needed"}},"PropertyAppraisalModel":{"description":"Representation of a property appraisal","type":"object","properties":{"id":{"description":"Unique identifier of the appraisal","type":"string"},"created":{"format":"date-time","description":"The date and time on which the property appraisal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time on which the property appraisal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"isExternal":{"description":"Flag indicating whether the appraisal is internal or external","type":"boolean"},"date":{"format":"date","description":"The date of the appraisal","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"},"_eTag":{"type":"string","readOnly":true}}},"PropertyAppraisalModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property appraisal","type":"object","properties":{"id":{"description":"Unique identifier of the appraisal","type":"string"},"created":{"format":"date-time","description":"The date and time on which the property appraisal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time on which the property appraisal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"isExternal":{"description":"Flag indicating whether the appraisal is internal or external","type":"boolean"},"date":{"format":"date","description":"The date of the appraisal","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"},"_eTag":{"type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreatePropertyAppraisalModel":{"description":"Model for the creation of a new property appraisal","type":"object","properties":{"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"date":{"format":"date","description":"The date of the appraisal","type":"string","example":"2019-08-14"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"}},"example":{"companyId":"RPT22000001","date":"2024-02-14","price":199995,"fee":{"type":"fixed","amount":4999.95},"notes":"Appraisal based on a virtual showing"}},"UpdatePropertyAppraisalModel":{"description":"Model for the creation of a new property appraisal","type":"object","properties":{"companyId":{"description":"Unique identifier of the appraising company","type":"string"},"date":{"format":"date-time","description":"The date of the appraisal","type":"string","example":"2019-08-14T12:30:02Z"},"price":{"format":"int32","description":"The appraisal value","type":"integer"},"fee":{"description":"Representation of the commission fee details for a property.","type":"object","properties":{"type":{"description":"The type of fee (percentage/fixed).","type":"string"},"amount":{"format":"double","description":"The commission fee amount.","type":"number"}}},"notes":{"description":"Free-text notes associated with the appraisal","type":"string"}},"example":{"companyId":"RPT22000001","date":"2024-02-14","price":199995,"fee":{"type":"fixed","amount":4999.95},"notes":"Appraisal based on a virtual showing"}},"PropertyUtilitiesElectricityModel":{"description":"Representation of a properties electricity details","type":"object","properties":{"type":{"description":"The type of electricity supplied (windTurbine/mainsSupply/privateSupply/solar/other)","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company providing the electricity","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"}}},"PropertyUtilitiesGasModel":{"description":"Representation of a properties gas details","type":"object","properties":{"hasGas":{"description":"A flag to determine if the property has gas","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company providing the gas","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"}}},"PropertyUtilitiesWaterModel":{"description":"Representation of a properties water details","type":"object","properties":{"type":{"description":"The type of water supplied (mainsSupply/privateSupply/other)","type":"string"},"waterCompanyId":{"description":"The unique identifier of company providing the water","type":"string"},"waterMeterPoint":{"description":"The water meter point","type":"string"},"sewerage":{"description":"The type of sewerage supplied (mainsSupply/privateSupply/other)","type":"string"}}},"PropertyUtilitiesInternetModel":{"description":"Representation of a properties internet details","type":"object","properties":{"type":{"description":"The types of internet supplied (none/adsl/fttc/fttp/cable/other)","type":"array","items":{"type":"string"}},"internetCompanyId":{"description":"The unique identifier of the company providing the internet","type":"string"}}},"PropertyUtilitiesModel":{"description":"Representation of a properties utilities","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the utilities","type":"string"},"propertyId":{"description":"The unique identifier of property associated to the utilities","type":"string"},"created":{"format":"date-time","description":"The date and time when the utilities were created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the utilities were last modified","type":"string","example":"2019-08-14T12:30:02Z"},"electricity":{"description":"Representation of a properties electricity details","type":"object","properties":{"type":{"description":"The type of electricity supplied (windTurbine/mainsSupply/privateSupply/solar/other)","type":"string"},"electricityCompanyId":{"description":"The unique identifier of the company providing the electricity","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point number","type":"string"}}},"gas":{"description":"Representation of a properties gas details","type":"object","properties":{"hasGas":{"description":"A flag to determine if the property has gas","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of the company providing the gas","type":"string"},"gasMeterPoint":{"description":"The gas meter point number","type":"string"}}},"water":{"description":"Representation of a properties water details","type":"object","properties":{"type":{"description":"The type of water supplied (mainsSupply/privateSupply/other)","type":"string"},"waterCompanyId":{"description":"The unique identifier of company providing the water","type":"string"},"waterMeterPoint":{"description":"The water meter point","type":"string"},"sewerage":{"description":"The type of sewerage supplied (mainsSupply/privateSupply/other)","type":"string"}}},"internet":{"description":"Representation of a properties internet details","type":"object","properties":{"type":{"description":"The types of internet supplied (none/adsl/fttc/fttp/cable/other)","type":"array","items":{"type":"string"}},"internetCompanyId":{"description":"The unique identifier of the company providing the internet","type":"string"}}},"telephoneCompanyId":{"description":"The unique identifier of company providing the telephone lines","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of company providing cable tv","type":"string"},"heating":{"description":"The type of heating supplied to the property (airConditioning/centralHeating/doubleGlazing/ecoFriendly/electric/gas/gasCentral/nightStorage/oil/solar/solarWater/underFloor/woodBurner/openFire/biomassBoiler/groundSourceHeatPump/airSourceHeatPump/solarPvThermal/underFloorHeating/solarThermal/other)","type":"array","items":{"type":"string"}},"mainHeating":{"description":"The main type of heating supplied (independent/communal/independentChilled/communalChilled)","type":"array","items":{"type":"string"}},"mobileSignal":{"description":"Information relating the mobile signal","type":"string"},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true},"parking":{"description":"The type of parking available at the property","type":"array","items":{"type":"string"}}}},"UpdatePropertyUtilitiesElectricityModel":{"description":"Representation of a properties electricity details","type":"object","properties":{"type":{"description":"The type of electricity supplied (windTurbine/mainsSupply/privateSupply/solar/other)","type":"string"},"electricityCompanyId":{"description":"The unique identifier of company providing the electricity","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point","type":"string"}}},"UpdatePropertyUtilitiesGasModel":{"description":"Representation of a properties gas details","type":"object","properties":{"hasGas":{"description":"A flag to determine if the property has gas","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of company providing the gas","type":"string"},"gasMeterPoint":{"description":"The gas meter point","type":"string"}}},"UpdatePropertyUtilitiesWaterModel":{"description":"Representation of a properties water details","type":"object","properties":{"type":{"description":"The type of water supplied (mainsSupply/privateSupply/other)","type":"string"},"waterCompanyId":{"description":"The unique identifier of company providing the water","type":"string"},"waterMeterPoint":{"description":"The water meter point","type":"string"},"sewerage":{"description":"The type of sewerage supplied (mainsSupply/privateSupply/other)","type":"string"}}},"UpdatePropertyUtilitiesInternetModel":{"description":"Representation of a properties internet details","type":"object","properties":{"type":{"description":"The type of internet supplied (none/adsl/fttc/fttp/cable/other)","type":"array","items":{"type":"string"}},"internetCompanyId":{"description":"The unique identifier of company providing the internet","type":"string"}}},"UpdatePropertyUtilitiesModel":{"description":"Representation of a properties utilities","type":"object","properties":{"electricity":{"description":"Representation of a properties electricity details","type":"object","properties":{"type":{"description":"The type of electricity supplied (windTurbine/mainsSupply/privateSupply/solar/other)","type":"string"},"electricityCompanyId":{"description":"The unique identifier of company providing the electricity","type":"string"},"electricityMeterPoint":{"description":"The electricity meter point","type":"string"}}},"gas":{"description":"Representation of a properties gas details","type":"object","properties":{"hasGas":{"description":"A flag to determine if the property has gas","type":"boolean"},"gasCompanyId":{"description":"The unique identifier of company providing the gas","type":"string"},"gasMeterPoint":{"description":"The gas meter point","type":"string"}}},"water":{"description":"Representation of a properties water details","type":"object","properties":{"type":{"description":"The type of water supplied (mainsSupply/privateSupply/other)","type":"string"},"waterCompanyId":{"description":"The unique identifier of company providing the water","type":"string"},"waterMeterPoint":{"description":"The water meter point","type":"string"},"sewerage":{"description":"The type of sewerage supplied (mainsSupply/privateSupply/other)","type":"string"}}},"internet":{"description":"Representation of a properties internet details","type":"object","properties":{"type":{"description":"The type of internet supplied (none/adsl/fttc/fttp/cable/other)","type":"array","items":{"type":"string"}},"internetCompanyId":{"description":"The unique identifier of company providing the internet","type":"string"}}},"telephoneCompanyId":{"description":"The unique identifier of company providing the telephone lines","type":"string"},"cableTvCompanyId":{"description":"The unique identifier of company providing cable tv","type":"string"},"heating":{"description":"The type of heating supplied to the property (airConditioning/centralHeating/doubleGlazing/ecoFriendly/electric/gas/gasCentral/nightStorage/oil/solar/solarWater/underFloor/woodBurner/openFire/biomassBoiler/groundSourceHeatPump/airSourceHeatPump/solarPvThermal/underFloorHeating/solarThermal/other)","type":"array","items":{"type":"string"}},"mainHeating":{"description":"The main type of heating supplied (independent/communal/independentChilled/communalChilled)","type":"array","items":{"type":"string"}},"mobileSignal":{"description":"Information relating the mobile signal","type":"string"}},"example":{"electricity":{"type":"solar","electricityCompanyId":"CMP2200003","electricityMeterPoint":"123"},"gas":{"hasGas":true,"gasCompanyId":"CMP23000004","gasMeterPoint":"456"},"water":{"type":"privateSupply","waterCompanyId":"CMP23000006","waterMeterPoint":"987","sewerage":"mainsSupply"},"internet":{"type":["fttc","fttp"],"internetCompanyId":"CMP23000005"},"telephoneCompanyId":"CMP2100002","cableTvCompanyId":"CMP21000015","heating":["gas","gasCentral"],"mainHeating":["communal","independent"],"mobileSignal":"Great signal throughout the property."}},"DevelopmentPhaseModel":{"description":"Representation of a property's development phase.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the development phase.","type":"string"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"},"created":{"format":"date-time","description":"The date and time when the development phase was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the development phase was last modified.","type":"string","example":"2019-08-14T12:30:02Z"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}},"DevelopmentPhaseModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property's development phase.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the development phase.","type":"string"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"},"created":{"format":"date-time","description":"The date and time when the development phase was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the development phase was last modified.","type":"string","example":"2019-08-14T12:30:02Z"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateDevelopmentPhaseModel":{"description":"Request body used to create a new development phase.","type":"object","properties":{"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"}},"example":{"phase":"Phase Test","notes":"Test Notes","releaseDate":"2021-01-01","completionDate":"2021-01-01","completed":true}},"UpdateDevelopmentPhaseModel":{"description":"Request body used to update an existing development phase.","type":"object","properties":{"phase":{"description":"The development phase summary.","type":"string"},"notes":{"description":"The development phase notes.","type":"string"},"releaseDate":{"format":"date-time","description":"The release date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completionDate":{"format":"date-time","description":"The completion date of the development phase.","type":"string","example":"2019-08-14T12:30:02Z"},"completed":{"description":"A flag to determine if the development phase is complete.","type":"boolean"}},"example":{"phase":"Phase Test","notes":"Test Notes","releaseDate":"2021-01-01","completionDate":"2021-01-01","completed":true}},"PropertyNegotiatorModel":{"description":"Representation of a property-negotiator relationship.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the property negotiator.","type":"string"},"created":{"format":"date-time","description":"The date and time when the property negotiator was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property negotiator was last modified.","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the negotiator.","type":"string"},"type":{"description":"The type of relationship between the property and the negotiator. List of available types:\r\n- propertyManager\r\n- propertyAdministrator\r\n- clientAccountAssistant\r\n- salesProgressor\r\n- salesPropertyAdministrator","type":"string"},"propertyId":{"description":"The unique identifier of the property.","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator.","type":"string"},"_eTag":{"description":"The ETag for the current version of the property negotiator. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}},"PropertyNegotiatorModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property-negotiator relationship.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the property negotiator.","type":"string"},"created":{"format":"date-time","description":"The date and time when the property negotiator was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property negotiator was last modified.","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the negotiator.","type":"string"},"type":{"description":"The type of relationship between the property and the negotiator. List of available types:\r\n- propertyManager\r\n- propertyAdministrator\r\n- clientAccountAssistant\r\n- salesProgressor\r\n- salesPropertyAdministrator","type":"string"},"propertyId":{"description":"The unique identifier of the property.","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator.","type":"string"},"_eTag":{"description":"The ETag for the current version of the property negotiator. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"PropertyMultiDescriptionModel":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"PropertyDescriptionsModel":{"description":"The read model for property description.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of property associated to the property description.","type":"string"},"created":{"format":"date-time","description":"The date and time when the property description was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property description was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of property associated to the utilities","type":"string"},"summary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"description":{"description":"The brief description of the property","type":"string"},"strapLine":{"description":"The strapline description containing a short summary about the property","type":"string"},"description1":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description2":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description3":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description4":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description5":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description6":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}},"UpdatePropertyDescriptionModel":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"UpdatePropertyMarketingDescriptionModel":{"description":"Request body to update the property description of an existing property","type":"object","properties":{"description1":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description2":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description3":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description4":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description5":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description6":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}}},"example":{"description1":{"text":"This is the first description."},"description2":{"text":"This is the second description."},"description3":{"text":"This is the third description."},"description4":{"text":"This is the fourth description."},"description5":{"text":"This is the fifth description."},"description6":{"text":"This is the sixth description."}}},"PropertyChecklistItemModel":{"description":"Represents a check in a property checklist.","type":"object","properties":{"id":{"description":"The unique identifier of the check, should it exist.","type":"string","readOnly":true},"label":{"description":"The label of the check.","type":"string","readOnly":true},"type":{"description":"The type of the check (string/integer/double/decimal/datetime/boolean)","type":"string","readOnly":true},"value":{"description":"The value of the check, should it exist.","readOnly":true},"notApplicable":{"description":"Flag to determine if this check is applicable for the associated property.","type":"boolean","readOnly":true}}},"PropertyChecklistModel":{"description":"Represents a property checklist.","type":"object","properties":{"name":{"description":"The name of the checklist.","type":"string","readOnly":true},"checks":{"description":"The collection of checks on the list.","type":"array","items":{"description":"Represents a check in a property checklist.","type":"object","properties":{"id":{"description":"The unique identifier of the check, should it exist.","type":"string","readOnly":true},"label":{"description":"The label of the check.","type":"string","readOnly":true},"type":{"description":"The type of the check (string/integer/double/decimal/datetime/boolean)","type":"string","readOnly":true},"value":{"description":"The value of the check, should it exist.","readOnly":true},"notApplicable":{"description":"Flag to determine if this check is applicable for the associated property.","type":"boolean","readOnly":true}}},"readOnly":true}}},"PropertyChecklistsModel":{"description":"Represents a collection of property checklists.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"propertyId":{"description":"The unique identifier of the property this checklist is associated with.","type":"string","readOnly":true},"checklists":{"description":"The collection of property checklists.","type":"array","items":{"description":"Represents a property checklist.","type":"object","properties":{"name":{"description":"The name of the checklist.","type":"string","readOnly":true},"checks":{"description":"The collection of checks on the list.","type":"array","items":{"description":"Represents a check in a property checklist.","type":"object","properties":{"id":{"description":"The unique identifier of the check, should it exist.","type":"string","readOnly":true},"label":{"description":"The label of the check.","type":"string","readOnly":true},"type":{"description":"The type of the check (string/integer/double/decimal/datetime/boolean)","type":"string","readOnly":true},"value":{"description":"The value of the check, should it exist.","readOnly":true},"notApplicable":{"description":"Flag to determine if this check is applicable for the associated property.","type":"boolean","readOnly":true}}},"readOnly":true}}},"readOnly":true}}},"AlarmCheckedByModel":{"description":"The model for the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"AlarmModel":{"description":"The read model for an alarm.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the alarm.","type":"string"},"created":{"format":"date-time","description":"The date the alarm record was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The last modified date.","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this alarm is for.","type":"string"},"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The model for the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}},"AlarmModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"The read model for an alarm.","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the alarm.","type":"string"},"created":{"format":"date-time","description":"The date the alarm record was created.","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The last modified date.","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property this alarm is for.","type":"string"},"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The model for the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the development phase. Used for managing update\r\nconcurrency.","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"AlarmCheckedByModelBase":{"description":"The base model for reading, creating or updating the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"CreateAlarmModel":{"description":"The model containing data for creating an alarm.","type":"object","properties":{"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The base model for reading, creating or updating the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"}},"example":{"categoryId":"SM","typeId":"BT","location":"Upstairs bedroom","checkedDate":"2024-11-18","checkedBy":{"type":"negotiator","value":"RPT"},"serviceDate":"2025-06-13","expiryDate":"2026-08-29","removed":false}},"UpdateAlarmModel":{"description":"The model containing data for updating an alarm.","type":"object","properties":{"categoryId":{"description":"The unique identifier of the category of the alarm.","type":"string"},"typeId":{"description":"The unique identifier of the type of the alarm.","type":"string"},"location":{"description":"The location of the alarm.","type":"string"},"checkedDate":{"format":"date-time","description":"The date that the alarm was checked.","type":"string","example":"2019-08-14T12:30:02Z"},"checkedBy":{"description":"The base model for reading, creating or updating the entity that checked an alarm.","type":"object","properties":{"type":{"description":"The type of the entity that checked the alarm (negotiator/contact/external).","type":"string"},"value":{"description":"The entity that checked the alarm. When Reapit.Services.Properties.Application.Models.Base.AlarmCheckedByModelBase.Type is\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Negotiator or\r\nReapit.Services.Properties.Domain.Enumerations.AlarmCheckingEntityType.Contact, this will be the unique identifier of the\r\ncorresponding entity.","type":"string"}}},"serviceDate":{"format":"date-time","description":"The date that the alarm is due to be serviced/reviewed.","type":"string","example":"2019-08-14T12:30:02Z"},"expiryDate":{"format":"date-time","description":"The expiry date of the alarm.","type":"string","example":"2019-08-14T12:30:02Z"},"removed":{"description":"Flag to determine whether this alarm has been removed.","type":"boolean"}},"example":{"categoryId":"SM","typeId":"BT","location":"Upstairs bedroom","checkedDate":"2024-11-18","checkedBy":{"type":"negotiator","value":"RPT"},"serviceDate":"2025-06-13","expiryDate":"2026-08-29","removed":false}},"MultilingualPropertyAddressModel":{"description":"Representation of the physical address of a building or premise in a second language","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"PropertyMultilingualFieldsModel":{"description":"Representation of a property for a specific language","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the associated property","type":"string"},"created":{"format":"date-time","description":"The date and time when the associated property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the associated property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"langId":{"description":"The unique identifier of the language","type":"string"},"langName":{"description":"The name of the language","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"accommodationSummary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"brief":{"description":"The brief description of the property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise in a second language","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"rooms":{"description":"The rooms within the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"description1":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description2":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description3":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description4":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description5":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description6":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}},"PropertyMultilingualFieldsModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property for a specific language","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the associated property","type":"string"},"created":{"format":"date-time","description":"The date and time when the associated property was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the associated property was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"langId":{"description":"The unique identifier of the language","type":"string"},"langName":{"description":"The name of the language","type":"string"},"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"accommodationSummary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"brief":{"description":"The brief description of the property","type":"string"},"address":{"description":"Representation of the physical address of a building or premise in a second language","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"rooms":{"description":"The rooms within the property","type":"array","items":{"description":"Representation of a single room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"},"dimensionsAlt":{"description":"Details about the alternate dimensions of the room","type":"string"}}}},"description1":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description2":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description3":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description4":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description5":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"description6":{"description":"Representation of the extra description set to the property","type":"object","properties":{"text":{"description":"The associated description","type":"string"},"name":{"description":"The name of the description field","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the keys. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"UpdateMultilingualPropertyAddressModel":{"description":"Request body used to update the address of an existing property","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"UpdatePropertyMultiDescriptionModel":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"UpdatePropertyMultilingualFieldsModel":{"description":"Request body used to update an existing properties multilingual descriptions","type":"object","properties":{"strapline":{"description":"The strapline description containing a short summary about the property","type":"string"},"accommodationSummary":{"description":"The summary of accommodation, typically short phrases or bullet points describing the key features of the property","type":"string"},"brief":{"description":"The brief description of the property","type":"string"},"address":{"description":"Request body used to update the address of an existing property","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"}}},"rooms":{"description":"The rooms within the property","type":"array","items":{"description":"The base model containing data for reading, creating or updating a room in a property","type":"object","properties":{"name":{"description":"The name of the room","type":"string"},"dimensions":{"description":"Details about the dimensions of the room","type":"string"},"description":{"description":"Short description of the room","type":"string"}}}},"description1":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description2":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description3":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description4":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description5":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}},"description6":{"description":"Description model for updating property descriptions","type":"object","properties":{"text":{"description":"The associated description","type":"string"}}}},"example":{"strapline":"Spanish Strapline","accommodationSummary":"Spanish Accomodation Summary","brief":"Spanish Brief","address":{"buildingName":"Spanish Building Name","buildingNumber":"123","line1":"Spanish line 1","line2":"Spanish line 2","line3":"Spanish Line 3","line4":"Spanish Line 4","postcode":"ES12 345"},"rooms":[{"name":"Lounge","dimensions":"6.5m x 7.8m","description":"The lounge, with a brick feature fireplace housing a  Clearview stove."},{"name":"Dining Room","dimensions":"5.1m x 6.2m","description":"The formal dining room."}],"description1":{"text":"Spanish Location"},"description2":{"text":"Spanish Area Guide"},"description3":{"text":null},"description4":{"text":null},"description5":{"text":null},"description6":{"text":null}}},"PropertyImageModel":{"description":"Representation of a property image","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the image, which is also the filename","type":"string"},"created":{"format":"date-time","description":"The date and time when the image was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property image was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property attached to the image","type":"string"},"url":{"description":"The url where the image can be downloaded from. Please note that physical assets for archived images may no longer be available","type":"string"},"thumbnailUrl":{"description":"The url where the image thumbnail can be downloaded from.  Please not that physical assets for archived images may no longer be available","type":"string"},"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"},"order":{"format":"int32","description":"The display order index of the image which can be used to correctly order the whole collection","type":"integer"},"fromArchive":{"description":"A flag determining whether or not the image is archived. Please note that physical assets for archived images may no longer be available","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the image. Used for managing update concurrency","type":"string","readOnly":true}}},"PropertyImageModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a property image","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the image, which is also the filename","type":"string"},"created":{"format":"date-time","description":"The date and time when the image was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the property image was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"propertyId":{"description":"The unique identifier of the property attached to the image","type":"string"},"url":{"description":"The url where the image can be downloaded from. Please note that physical assets for archived images may no longer be available","type":"string"},"thumbnailUrl":{"description":"The url where the image thumbnail can be downloaded from.  Please not that physical assets for archived images may no longer be available","type":"string"},"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"},"order":{"format":"int32","description":"The display order index of the image which can be used to correctly order the whole collection","type":"integer"},"fromArchive":{"description":"A flag determining whether or not the image is archived. Please note that physical assets for archived images may no longer be available","type":"boolean"},"_eTag":{"description":"The ETag for the current version of the image. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreatePropertyImageModel":{"description":"Request body used to create a new property image","required":["propertyId","caption","type"],"type":"object","properties":{"data":{"description":"The base64 encoded file content, prefixed with the content type (eg. data:image/jpeg;base64,VGVzdCBmaWxl)","type":"string"},"fileUrl":{"description":"The presigned s3 url which a property image has been uploaded to\r\nSee [documentation](https://foundations-documentation.reapit.cloud/api/api-documentation#uploading-files) about file size limits","type":"string"},"propertyId":{"description":"The unique identifier of the property attached to the image","type":"string"},"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"}},"example":{"data":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==","fileUrl":null,"propertyId":"OXF100008","caption":"Living room","type":"photograph"}},"UpdatePropertyImageModel":{"description":"Request body used to update an existing property image","type":"object","properties":{"caption":{"description":"The image caption","type":"string"},"type":{"description":"The type of image (photograph/floorPlan/epc/map)","type":"string"}},"example":{"caption":"Living room","type":"photograph"}},"ReindexPropertyImagesModel":{"description":"Request body used to reindex property images","type":"object","properties":{"propertyId":{"description":"The unique identifier of the property to update","type":"string"},"imageOrder":{"description":"Ordered collection of image identifiers for the property.\r\nThe first image in the collection will be set as the properties primary image.","type":"array","items":{"type":"string"}}},"example":{"propertyId":"RPT230020","imageOrder":["RPT230020_02.JPG","RPT230020_01.JPG","RPT230020_03.JPG"]}},"ReferralContactModel":{"description":"Representation of a contact","type":"object","properties":{"id":{"type":"string"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"}}},"ReferralModel":{"description":"Representation of a referral","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the referral","type":"string"},"created":{"format":"date-time","description":"The date and time when the referral was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the referral was amended","type":"string","example":"2019-08-14T12:30:02Z"},"referralTypeId":{"description":"The unique identifier of the referralTypeId the referral is associated with, where applicable","type":"string"},"type":{"description":"The type of referral (referral/lead). Please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#referral) for further information","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator the referral is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the referral is associated with, where applicable","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"contactId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"status":{"description":"The status of the referral (sent/succeeded/cancelled/failed/paid/declined/inProgress)","type":"string"},"information":{"description":"The information of the referral","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"paid":{"format":"date-time","description":"The date and time when the referral was paid","type":"string","example":"2019-08-14T12:30:02Z"},"accepted":{"format":"date-time","description":"The date and time when the referral was accepted","type":"string","example":"2019-08-14T12:30:02Z"},"related":{"description":"Representation of a contact","type":"object","properties":{"id":{"type":"string"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the referral","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the referral. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}},"ReferralModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a referral","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the referral","type":"string"},"created":{"format":"date-time","description":"The date and time when the referral was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the referral was amended","type":"string","example":"2019-08-14T12:30:02Z"},"referralTypeId":{"description":"The unique identifier of the referralTypeId the referral is associated with, where applicable","type":"string"},"type":{"description":"The type of referral (referral/lead). Please [see the documentation](https://foundations-documentation.reapit.cloud/platform-glossary#referral) for further information","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator the referral is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the referral is associated with, where applicable","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"contactId":{"description":"The unique identifier of the applicant the referral is associated with, where applicable","type":"string"},"status":{"description":"The status of the referral (sent/succeeded/cancelled/failed/paid/declined/inProgress)","type":"string"},"information":{"description":"The information of the referral","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"paid":{"format":"date-time","description":"The date and time when the referral was paid","type":"string","example":"2019-08-14T12:30:02Z"},"accepted":{"format":"date-time","description":"The date and time when the referral was accepted","type":"string","example":"2019-08-14T12:30:02Z"},"related":{"description":"Representation of a contact","type":"object","properties":{"id":{"type":"string"},"title":{"description":"The contact's title  (eg. Mr, Mrs, Miss, Dr)","type":"string"},"forename":{"description":"The contact's forename","type":"string"},"surname":{"description":"The contact's surname","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the referral","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the referral. Used for managing update concurrency","type":"string","readOnly":true},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateReferralModel":{"description":"Create Referral Model","required":["referralTypeId","contactId"],"type":"object","properties":{"referralTypeId":{"description":"The unique identifier of the referral type","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator creating the referral","type":"string"},"propertyId":{"description":"The unique identifier of the property","type":"string"},"applicantId":{"description":"The unique identifier of the applicant","type":"string"},"contactId":{"description":"The unique identifier of the contact that has been referred","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"information":{"description":"The information of the referral","type":"string"}},"example":{"referralTypeId":"REF01","negotiatorId":"","propertyId":"PRP1300001","applicantId":null,"contactId":"RPT23000001","amount":10,"information":"Information notes"}},"UpdateReferralModel":{"description":"Update Referral Model","type":"object","properties":{"status":{"description":"The status of the referral (sent/succeeded/cancelled/failed/paid/declined/inProgress)","type":"string"},"information":{"description":"The information of the referral","type":"string"},"amount":{"format":"double","description":"The amount paid to the agent for the referral","type":"number"},"metadata":{"description":"App specific metadata to set against the referral","type":"object","additionalProperties":{}}},"example":{"status":"sent","information":null,"amount":0,"metadata":{}}},"ReferralTypeModel":{"description":"Representation of a referral type","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"type":"string"},"name":{"description":"The name of the referral type","type":"string"}}},"ReferralTypeModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a referral type","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"type":"string"},"name":{"description":"The name of the referral type","type":"string"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"WebhookModel":{"description":"Representation of a webhook subscription","type":"object","properties":{"id":{"format":"uuid","description":"The unique identifier of the webhook","type":"string"},"created":{"format":"date-time","description":"The date and time when the webhook was created","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"modified":{"format":"date-time","description":"The date and time when the webhook was last modified","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the webhook is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted","type":"boolean"}}},"WebhookModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a webhook subscription","type":"object","properties":{"id":{"format":"uuid","description":"The unique identifier of the webhook","type":"string"},"created":{"format":"date-time","description":"The date and time when the webhook was created","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"modified":{"format":"date-time","description":"The date and time when the webhook was last modified","type":"string","example":"2019-08-14T12:30:02.0000000Z"},"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the webhook is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateWebhookModel":{"description":"Request body used to create a new webhook subscription","required":["url"],"type":"object","properties":{"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the subscription is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted\r\nPass true to disable emitting of these events","type":"boolean"}},"example":{"url":"https://www.example-url/webhook-reciever","description":"Webhook for SBOX contact updates","topicIds":["contacts.modified"],"active":true,"ignoreEtagOnlyChanges":true}},"UpdateWebhookModel":{"description":"Request body used to update a webhook subscription","required":["url"],"type":"object","properties":{"url":{"description":"The url where the payload associated with the webhook should be sent to","type":"string"},"description":{"description":"A short description associated with the webhook (ie a friendly name or label)","type":"string"},"topicIds":{"description":"The identifiers of the topics the subscription is associated with","type":"array","items":{"type":"string"}},"active":{"description":"Flag denoting whether or not the webhook is active and ready to receive data","type":"boolean"},"ignoreEtagOnlyChanges":{"description":"Flag denoting whether or events that only contain changes to etags and/or modified dates are emitted\r\nPass true to disable emitting of these events","type":"boolean"}},"example":{"url":"https://www.example-url/webhook-reciever","description":"Webhook for SBOX appointment updates","topicIds":["appointments.modified"],"active":true,"ignoreEtagOnlyChanges":true}},"SourceModel":{"description":"Representation of a source of business","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the source","type":"string"},"created":{"format":"date-time","description":"The date and time when the source was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the source was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the source. Used for managing update concurrency","type":"string","readOnly":true}}},"SourceModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a source of business","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the source","type":"string"},"created":{"format":"date-time","description":"The date and time when the source was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the source was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}},"_eTag":{"description":"The ETag for the current version of the source. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateSourceModel":{"description":"Request body used to create a new source of business","required":["name","type"],"type":"object","properties":{"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}}},"example":{"name":"Property Portal","type":"source","officeIds":["OXF"],"departmentIds":["G"]}},"UpdateSourceModel":{"description":"Request body used to update an existing source of business","type":"object","properties":{"name":{"description":"The name of the source or advertising publication","type":"string"},"type":{"description":"The type of the source (source/advertisement)","type":"string"},"officeIds":{"description":"A collection of the unique identifiers of offices that regularly get business from the source","type":"array","items":{"type":"string"}},"departmentIds":{"description":"A collection of unique identifiers of departments that regularly get business from the source","type":"array","items":{"type":"string"}}},"example":{"name":"Property Portal","type":"source","officeIds":["OXF"],"departmentIds":["G"]}},"TaskModel":{"description":"Representation of a task, which can also be an internal message","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the task","type":"string"},"created":{"format":"date-time","description":"The date and time when the task was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the task was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"activates":{"format":"date","description":"The date the task becomes active","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the task. Used for managing update concurrency","type":"string","readOnly":true}}},"TaskModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a task, which can also be an internal message","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the task","type":"string"},"created":{"format":"date-time","description":"The date and time when the task was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the task was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"activates":{"format":"date","description":"The date the task becomes active","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the task. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTaskModel":{"description":"Request body used to create a new task, which can also be an internal message","required":["senderId","text","recipientId","recipientType"],"type":"object","properties":{"activates":{"format":"date","description":"The date the task becomes active (Required when 'TypeId' is given)","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}}},"example":{"activates":"2019-05-12","completed":"2019-07-05","typeId":"MI","senderId":"JAS","text":"Arrange for bathroom photos to be retaken","landlordId":null,"propertyId":"OXF123022","applicantId":null,"tenancyId":null,"contactId":null,"recipientId":"OXF","recipientType":"office","metadata":{"CustomField1":"CustomValue1","CustomField2":false}}},"UpdateTaskModel":{"description":"Request body used to update an existing task, which can also be an internal message","type":"object","properties":{"activates":{"format":"date","description":"The date the task becomes active (Required when 'TypeId' is given)","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date the task was completed","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the task type","type":"string"},"senderId":{"description":"The unique identifer of the negotiator that created the task","type":"string"},"text":{"description":"The textual contents of the task or message","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the task is associated to","type":"string"},"propertyId":{"description":"The unique identifier of the property the task is associated to","type":"string"},"applicantId":{"description":"The unique identifier of the applicant the task is associated to","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the task is associated to","type":"string"},"contactId":{"description":"The unique identifier of the contact the task is associated to","type":"string"},"recipientId":{"description":"The unique identifier of the negotiator or office the task is being sent to","type":"string"},"recipientType":{"description":"The type of the recipient (office/negotiator)","type":"string"},"metadata":{"description":"App specific metadata that has been set against the task","type":"object","additionalProperties":{}}},"example":{"activates":"2019-05-12","completed":"2019-07-05","typeId":"MI","senderId":"JAS","text":"Arrange for bathroom photos to be retaken","landlordId":null,"propertyId":"OXF123022","applicantId":null,"tenancyId":null,"contactId":null,"recipientId":"OXF","recipientType":"office","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"TenancyLettingFeeModel":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"TenancyManagementFeeModel":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"TenancySourceModel":{"description":"A tenancy source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the source for this tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"TenancyDepositModel":{"description":"A tenancy deposit model","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"TenancyDepositProtectionModel":{"description":"A tenancy deposit protection model","type":"object","properties":{"scheme":{"description":"The unique identifier of the deposit protection","type":"string"},"registeredDate":{"format":"date-time","description":"The date when deposit protection is registered","type":"string","example":"2019-08-14T12:30:02Z"},"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection","type":"string"},"notifiedDate":{"format":"date-time","description":"The notified date of the deposit protection","type":"string","example":"2019-08-14T12:30:02Z"}}},"TenancyContactAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"TenancyContactModel":{"description":"A summarised view of the details of a contact or company associated to a tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"paymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with this tenant","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this roie on the system is now archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"occupyOn":{"format":"date","description":"The date the tenant moved in (or will move in) to the property","type":"string","example":"2019-08-14"},"vacateOn":{"format":"date","description":"The date the tenant vacated (or is due to vacate) the property","type":"string","example":"2019-08-14"},"isCurrent":{"description":"Flag to indicate if this is the current tenant","type":"boolean","readOnly":true},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}},"RenewalOptionsModel":{"description":"Representation of renewal options in a tenancy","type":"object","properties":{"optionId":{"description":"The unique identifier of the renewal option","type":"string"},"optionText":{"description":"The associated renewal option text","type":"string"},"expiry":{"format":"date","description":"The renewal option expiry date","type":"string","example":"2019-08-14"},"conditionIds":{"description":"The renewal options associated condition Ids","type":"array","items":{"type":"string"}}}},"TenancyArrearsModel":{"description":"Representation of tenancy arrears data (populated only when Client Accounts functionality is enabled)","type":"object","properties":{"chaseArrears":{"description":"A flag determining whether or not tenancy arrears should be chased","type":"boolean"},"paymentPlan":{"description":"Indicates whether or not a payment plan is set up for a tenancy in arrears (no/yes/negotiating)","type":"string"},"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"TenancyModel":{"description":"Representation of a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging/current/finished/cancelled)","type":"string"},"agentRole":{"description":"The role that the agent is performing for this tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency\r\nNote that this is the original rent set on the tenancy. For tenancies that have been extended with a rent change you MUST use the extensions endpoint","type":"number"},"currency":{"description":"The currency set against the tenancy","type":"string"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"endDateConfirmed":{"description":"A flag determining whether or not the tenancy is confirmed to finish at the end date","type":"boolean"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"periodicReviewDate":{"format":"date-time","description":"The date that the tenancy is due for a review, only applicable for periodic tenancies","type":"string","example":"2019-08-14T12:30:02Z"},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"initialInspectionFrequencyInDays":{"format":"int64","description":"One time inspection scheduled a specific number of days after the tenancy start date","type":"integer"},"regularInspectionFrequencyInDays":{"format":"int64","description":"Recurring inspections set to occur at specified intervals","type":"integer"},"finishedReason":{"description":"The reason for the tenancy finishing","type":"string"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"isRentersRights":{"description":"If the tenancy has renters' rights","type":"boolean"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"propertyId":{"description":"The unique identifier of the property that relates to the tenancy","type":"string"},"applicantId":{"description":"The unique identifier of the applicant who has applied to be a tenant. Whilst the tenancy is an in arranging state, information about the individual such as name and contact details can be obtained from GET /applicants/{id}. Use the link in the _links collection for a relative URI","type":"string"},"managerId":{"description":"The unique identifier of the negotiator assigned as the manager of the tenancy","type":"string"},"groupPaymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with all tenants in the property","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"daysInArrears":{"format":"int32","description":"The number of days rent invoices can be paid in arrears","type":"integer"},"source":{"description":"A tenancy source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the source for this tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"deposit":{"description":"A tenancy deposit model","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"depositProtection":{"description":"A tenancy deposit protection model","type":"object","properties":{"scheme":{"description":"The unique identifier of the deposit protection","type":"string"},"registeredDate":{"format":"date-time","description":"The date when deposit protection is registered","type":"string","example":"2019-08-14T12:30:02Z"},"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection","type":"string"},"notifiedDate":{"format":"date-time","description":"The notified date of the deposit protection","type":"string","example":"2019-08-14T12:30:02Z"}}},"initiateDepositRelease":{"description":"A flag denoting whether or not the the deposit release has been initiated","type":"boolean"},"occupierCount":{"format":"int32","description":"The number of occupiers the tenancy has","type":"integer"},"related":{"description":"A collection of contact / company tenants associated to the tenancy. The first item in the collection is considered the primary relationship. This collection is only populated once a tenant moves into a property and the tenancy status becomes current","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"paymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with this tenant","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this roie on the system is now archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"occupyOn":{"format":"date","description":"The date the tenant moved in (or will move in) to the property","type":"string","example":"2019-08-14"},"vacateOn":{"format":"date","description":"The date the tenant vacated (or is due to vacate) the property","type":"string","example":"2019-08-14"},"isCurrent":{"description":"Flag to indicate if this is the current tenant","type":"boolean","readOnly":true},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"fromArchive":{"description":"A flag denoting whether or not this tenancy is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the tenancy","type":"object","additionalProperties":{}},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"legalStatusId":{"description":"The identifier of the legal status to set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"renewalOptions":{"description":"Representation of renewal options in a tenancy","type":"object","properties":{"optionId":{"description":"The unique identifier of the renewal option","type":"string"},"optionText":{"description":"The associated renewal option text","type":"string"},"expiry":{"format":"date","description":"The renewal option expiry date","type":"string","example":"2019-08-14"},"conditionIds":{"description":"The renewal options associated condition Ids","type":"array","items":{"type":"string"}}}},"arrears":{"description":"Representation of tenancy arrears data (populated only when Client Accounts functionality is enabled)","type":"object","properties":{"chaseArrears":{"description":"A flag determining whether or not tenancy arrears should be chased","type":"boolean"},"paymentPlan":{"description":"Indicates whether or not a payment plan is set up for a tenancy in arrears (no/yes/negotiating)","type":"string"},"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging/current/finished/cancelled)","type":"string"},"agentRole":{"description":"The role that the agent is performing for this tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency\r\nNote that this is the original rent set on the tenancy. For tenancies that have been extended with a rent change you MUST use the extensions endpoint","type":"number"},"currency":{"description":"The currency set against the tenancy","type":"string"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"endDateConfirmed":{"description":"A flag determining whether or not the tenancy is confirmed to finish at the end date","type":"boolean"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"periodicReviewDate":{"format":"date-time","description":"The date that the tenancy is due for a review, only applicable for periodic tenancies","type":"string","example":"2019-08-14T12:30:02Z"},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"initialInspectionFrequencyInDays":{"format":"int64","description":"One time inspection scheduled a specific number of days after the tenancy start date","type":"integer"},"regularInspectionFrequencyInDays":{"format":"int64","description":"Recurring inspections set to occur at specified intervals","type":"integer"},"finishedReason":{"description":"The reason for the tenancy finishing","type":"string"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"isRentersRights":{"description":"If the tenancy has renters' rights","type":"boolean"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"propertyId":{"description":"The unique identifier of the property that relates to the tenancy","type":"string"},"applicantId":{"description":"The unique identifier of the applicant who has applied to be a tenant. Whilst the tenancy is an in arranging state, information about the individual such as name and contact details can be obtained from GET /applicants/{id}. Use the link in the _links collection for a relative URI","type":"string"},"managerId":{"description":"The unique identifier of the negotiator assigned as the manager of the tenancy","type":"string"},"groupPaymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with all tenants in the property","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"daysInArrears":{"format":"int32","description":"The number of days rent invoices can be paid in arrears","type":"integer"},"source":{"description":"A tenancy source of enquiry","type":"object","properties":{"id":{"description":"The unique identifier of the source for this tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"deposit":{"description":"A tenancy deposit model","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"depositProtection":{"description":"A tenancy deposit protection model","type":"object","properties":{"scheme":{"description":"The unique identifier of the deposit protection","type":"string"},"registeredDate":{"format":"date-time","description":"The date when deposit protection is registered","type":"string","example":"2019-08-14T12:30:02Z"},"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection","type":"string"},"notifiedDate":{"format":"date-time","description":"The notified date of the deposit protection","type":"string","example":"2019-08-14T12:30:02Z"}}},"initiateDepositRelease":{"description":"A flag denoting whether or not the the deposit release has been initiated","type":"boolean"},"occupierCount":{"format":"int32","description":"The number of occupiers the tenancy has","type":"integer"},"related":{"description":"A collection of contact / company tenants associated to the tenancy. The first item in the collection is considered the primary relationship. This collection is only populated once a tenant moves into a property and the tenancy status becomes current","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"paymentReference":{"description":"An optional payment reference to be used for transactions related to this tenancy associated with this tenant","type":"string"},"fromArchive":{"description":"A flag denoting whether or not this roie on the system is now archived","type":"boolean"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"occupyOn":{"format":"date","description":"The date the tenant moved in (or will move in) to the property","type":"string","example":"2019-08-14"},"vacateOn":{"format":"date","description":"The date the tenant vacated (or is due to vacate) the property","type":"string","example":"2019-08-14"},"isCurrent":{"description":"Flag to indicate if this is the current tenant","type":"boolean","readOnly":true},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"fromArchive":{"description":"A flag denoting whether or not this tenancy is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the tenancy","type":"object","additionalProperties":{}},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"legalStatusId":{"description":"The identifier of the legal status to set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"renewalOptions":{"description":"Representation of renewal options in a tenancy","type":"object","properties":{"optionId":{"description":"The unique identifier of the renewal option","type":"string"},"optionText":{"description":"The associated renewal option text","type":"string"},"expiry":{"format":"date","description":"The renewal option expiry date","type":"string","example":"2019-08-14"},"conditionIds":{"description":"The renewal options associated condition Ids","type":"array","items":{"type":"string"}}}},"arrears":{"description":"Representation of tenancy arrears data (populated only when Client Accounts functionality is enabled)","type":"object","properties":{"chaseArrears":{"description":"A flag determining whether or not tenancy arrears should be chased","type":"boolean"},"paymentPlan":{"description":"Indicates whether or not a payment plan is set up for a tenancy in arrears (no/yes/negotiating)","type":"string"},"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTenancyLettingFeeModel":{"description":"Request body used to set letting fees on a new tenancy","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"CreateTenancyManagementFeeModel":{"description":"Request body used to set management fees on a new tenancy","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"CreateTenancyDepositModel":{"description":"Request body used to set the deposit of a new tenancy","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"CreateTenancyArrearsModel":{"description":"Request body used to set the arrears of a new tenancy.","type":"object","properties":{"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"CreateTenancySourceModel":{"description":"Request body used to set the source of a new tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the source for the tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"CreateTenancyModel":{"description":"Request body used to create a new tenancy","required":["agentRole","rent","rentFrequency","typeId","negotiatorId","propertyId","applicantId"],"type":"object","properties":{"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging)","type":"string"},"agentRole":{"description":"The role that the agent is performing for the tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"propertyId":{"description":"The unique identifier of the property that relates to the tenancy","type":"string"},"applicantId":{"description":"The unique identifier of the applicant who has applied to be a tenant","type":"string"},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"lettingFee":{"description":"Request body used to set letting fees on a new tenancy","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to set management fees on a new tenancy","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"deposit":{"description":"Request body used to set the deposit of a new tenancy","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"arrears":{"description":"Request body used to set the arrears of a new tenancy.","type":"object","properties":{"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"source":{"description":"Request body used to set the source of a new tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the source for the tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancy","type":"object","additionalProperties":{}}},"example":{"startDate":"2020-01-01","endDate":"2021-01-01","status":"arranging","agentRole":"managed","rent":600,"rentFrequency":"monthly","rentInstalmentsFrequency":"quarterly","rentInstalmentsAmount":1800,"rentInstalmentsStart":"2019-08-01","meterReadingGas":"012111","meterReadingGasLastRead":"2022-02-18","meterReadingElectricity":"1000123","meterReadingElectricityLastRead":"2022-02-26","meterReadingWater":"111022","meterReadingWaterLastRead":"2022-02-21","isPeriodic":true,"typeId":"SL","negotiatorId":"JAS","propertyId":"OXF200497","applicantId":"OXF200012","feeNotes":null,"preTenancyCheckStatusId":null,"lettingFee":{"type":"percentage","amount":5,"frequency":"monthly"},"managementFee":{"type":"fixed","amount":400,"frequency":"quarterly"},"deposit":{"heldBy":"landlordsAgent","period":null,"type":null,"sum":675.75},"arrears":null,"source":{"id":"OXF","type":"office"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"UpdateTenancySourceModel":{"description":"Request body used to set the source of a new tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the source for the tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"UpdateTenancyDepositModel":{"description":"Request body used to set the deposit of a tenancy","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"UpdateTenancyDepositProtectionModel":{"description":"Request body used to update the deposit protection of a tenancy","type":"object","properties":{"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection scheme","type":"string"}}},"UpdateTenancyArrearsModel":{"description":"Request body used to set the arrears of an existing tenancy.","type":"object","properties":{"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"UpdateTenancyLettingFeeModel":{"description":"Request body used to update letting fees on an existing tenancy","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"UpdateTenancyManagementFeeModel":{"description":"Request body used to update management fees on an existing tenancy","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"UpdateTenancyModel":{"description":"Request body used to update an existing Tenancy","type":"object","properties":{"startDate":{"format":"date","description":"The start date of the tenancy","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the tenancy","type":"string","example":"2019-08-14"},"status":{"description":"The current status of the tenancy (offerPending/offerWithdrawn/offerRejected/arranging/current/finished/cancelled)","type":"string"},"agentRole":{"description":"The role that the agent is performing for the tenancy (managed/rentCollection/collectFirstPayment/collectRentToDate/lettingOnly/introducingTenant)","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"endDateConfirmed":{"description":"Flag for end date confirmation","type":"boolean"},"isPeriodic":{"description":"A flag determining whether or not the tenancy has been extended indefinitely","type":"boolean"},"typeId":{"description":"The unique identifier of the type of tenancy","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing the tenancy","type":"string"},"source":{"description":"Request body used to set the source of a new tenancy","type":"object","properties":{"id":{"description":"The unique identifier of the source for the tenancy","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"rentInstalmentsFrequency":{"description":"The frequency of rental instalment payments (weekly/fortnightly/monthly/quarterly/halfYearly/yearly/every28Days/other)","type":"string"},"rentInstalmentsAmount":{"format":"double","description":"The amount due for each rent instalment (where specified)","type":"number"},"rentInstalmentsStart":{"format":"date","description":"The date that the first instalment is due","type":"string","example":"2019-08-14"},"meterReadingGas":{"description":"The recorded utility reading for the gas meter","type":"string"},"meterReadingGasLastRead":{"format":"date","description":"Date of when the reading of gas utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingElectricity":{"description":"The recorded utility reading for the electricity meter","type":"string"},"meterReadingElectricityLastRead":{"format":"date","description":"Date of when the reading of electricity utility was last recorded","type":"string","example":"2019-08-14"},"meterReadingWater":{"description":"The recorded utility reading for the water meter","type":"string"},"meterReadingWaterLastRead":{"format":"date","description":"Date of when the reading of water utility was last recorded","type":"string","example":"2019-08-14"},"feeNotes":{"description":"Financial notes set against the tenancy","type":"string"},"legalStatusId":{"description":"The identifier of the legal status to set against the tenancy","type":"string"},"preTenancyCheckStatusId":{"description":"The identifier of the pre-tenancy checklist status for the tenancy","type":"string"},"deposit":{"description":"Request body used to set the deposit of a tenancy","type":"object","properties":{"heldBy":{"description":"The deposit holder (depositProtectionScheme/stakeholder/landlordsAgent/landlord/notApplicable)","type":"string"},"period":{"format":"int32","description":"The number of weeks or months rent collected as the deposit on the tenancy","type":"integer"},"type":{"description":"The type of deposit (weeksRent/monthsRent/fixedSum/guarantee)","type":"string"},"sum":{"format":"double","description":"The amount of deposit held","type":"number"}}},"depositProtection":{"description":"Request body used to update the deposit protection of a tenancy","type":"object","properties":{"deregisteredDate":{"format":"date-time","description":"The date when the deposit protection is deregistered","type":"string","example":"2019-08-14T12:30:02Z"},"registrationNumber":{"description":"The registration number of the deposit protection scheme","type":"string"}}},"arrears":{"description":"Request body used to set the arrears of an existing tenancy.","type":"object","properties":{"followUpOn":{"format":"date-time","description":"The date to follow up on.","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The current status.","type":"string"}}},"lettingFee":{"description":"Request body used to update letting fees on an existing tenancy","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to update management fees on an existing tenancy","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancy","type":"object","additionalProperties":{}}},"example":{"startDate":"2019-08-01","endDate":"2021-08-01","status":"arranging","agentRole":"managed","rent":650,"rentFrequency":"monthly","endDateConfirmed":true,"isPeriodic":false,"typeId":"AZ","negotiatorId":"JAS","source":{"id":"RMV","type":"source"},"rentInstalmentsFrequency":"quarterly","rentInstalmentsAmount":1200,"rentInstalmentsStart":"2021-03-09","meterReadingGas":"012114","meterReadingGasLastRead":"2021-01-02","meterReadingElectricity":"1000126","meterReadingElectricityLastRead":"2021-01-02","meterReadingWater":"111025","meterReadingWaterLastRead":"2021-01-02","feeNotes":null,"legalStatusId":null,"preTenancyCheckStatusId":null,"deposit":{"heldBy":"stakeholder","period":null,"type":null,"sum":455.5},"depositProtection":{"deregisteredDate":"2025-01-01","registrationNumber":"REGNO12345678"},"arrears":{"followUpOn":"0001-01-01T00:00:00Z","status":null},"lettingFee":{"type":"percentage","amount":5,"frequency":"monthly"},"managementFee":{"type":"fixed","amount":400,"frequency":"quarterly"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"GuarantorModel":{"description":"Read model representing a Guarantor","type":"object","properties":{"id":{"description":"The identifier for the guarantor record","type":"string"},"guarantorAssociatedId":{"description":"The identifier for the contact record associated with the guarantor","type":"string"},"type":{"description":"Value indicating whether a the referenced guarantor is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference requested from the guarantor (notSet/requested/received)","type":"string"}}},"ReferenceModel":{"description":"Read model representing a tenant/applicant reference","type":"object","properties":{"id":{"description":"The identifier for the reference record","type":"string"},"referenceAssociatedId":{"description":"The identifier for the contact/company record associated with the reference","type":"string"},"type":{"description":"Value indicating whether a referenced contact is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference (notSet/requested/received)","type":"string"},"referenceType":{"description":"The type of reference (notSet/accountant/characterReference/employer/previousLandlord)","type":"string"}}},"TenancyContactRelationshipModel":{"description":"Representation of a relationship between a tenancy and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"tenancyId":{"description":"The unique identifier of the tenancy","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this contact or company should be regarded as the main tenant","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"guarantors":{"description":"Collection of guarantors recorded for this relationship","type":"array","items":{"description":"Read model representing a Guarantor","type":"object","properties":{"id":{"description":"The identifier for the guarantor record","type":"string"},"guarantorAssociatedId":{"description":"The identifier for the contact record associated with the guarantor","type":"string"},"type":{"description":"Value indicating whether a the referenced guarantor is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference requested from the guarantor (notSet/requested/received)","type":"string"}}}},"references":{"description":"Collection of references recorded for this relationship","type":"array","items":{"description":"Read model representing a tenant/applicant reference","type":"object","properties":{"id":{"description":"The identifier for the reference record","type":"string"},"referenceAssociatedId":{"description":"The identifier for the contact/company record associated with the reference","type":"string"},"type":{"description":"Value indicating whether a referenced contact is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference (notSet/requested/received)","type":"string"},"referenceType":{"description":"The type of reference (notSet/accountant/characterReference/employer/previousLandlord)","type":"string"}}}}}},"TenancyContactRelationshipModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a relationship between a tenancy and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy relationship","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"tenancyId":{"description":"The unique identifier of the tenancy","type":"string"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this contact or company should be regarded as the main tenant","type":"boolean"},"fromArchive":{"description":"A flag denoting whether or not this relationship is archived","type":"boolean"},"guarantors":{"description":"Collection of guarantors recorded for this relationship","type":"array","items":{"description":"Read model representing a Guarantor","type":"object","properties":{"id":{"description":"The identifier for the guarantor record","type":"string"},"guarantorAssociatedId":{"description":"The identifier for the contact record associated with the guarantor","type":"string"},"type":{"description":"Value indicating whether a the referenced guarantor is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference requested from the guarantor (notSet/requested/received)","type":"string"}}}},"references":{"description":"Collection of references recorded for this relationship","type":"array","items":{"description":"Read model representing a tenant/applicant reference","type":"object","properties":{"id":{"description":"The identifier for the reference record","type":"string"},"referenceAssociatedId":{"description":"The identifier for the contact/company record associated with the reference","type":"string"},"type":{"description":"Value indicating whether a referenced contact is a person or a company","type":"string"},"referenceStatus":{"description":"The status of the reference (notSet/requested/received)","type":"string"},"referenceType":{"description":"The type of reference (notSet/accountant/characterReference/employer/previousLandlord)","type":"string"}}}}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"TenancyCheckModel":{"description":"Representation of a tenancy check - a process that needs to happen before a tenancy can commence or ends","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the tenancy check relates to","type":"string"},"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the tenancy check (preTenancy/postTenancy)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyCheckModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy check - a process that needs to happen before a tenancy can commence or ends","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the tenancy check relates to","type":"string"},"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"type":{"description":"The type of the tenancy check (preTenancy/postTenancy)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTenancyCheckModel":{"description":"Request body used to create a new tenancy check","required":["type","status"],"type":"object","properties":{"description":{"description":"Short, descriptive text describing the purpose of the check. This should be populated\r\nwhen creating a custom tenancy check that does not match any of the existing pre-configured\r\ntenancy check options.\r\nDescription and CheckTypeId must not be supplied in the same payload, but at least one must be provided","type":"string"},"type":{"description":"The type of the tenancy check (preTenancy/postTenancy)","type":"string"},"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This should be populated\r\nwhen an existing tenancy check configuration is desired, rather than a custom one\r\nCheckTypeId and Description must not be supplied in the same payload, but at least one must be provided","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy check","type":"object","additionalProperties":{}}},"example":{"description":"Tenant welcome pack","type":"preTenancy","status":"needed","checkTypeId":null,"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"UpdateTenancyCheckModel":{"description":"Model for updat of an existing tenancy check","type":"object","properties":{"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy check","type":"object","additionalProperties":{}}},"example":{"status":"needed","metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"TenancyBreakClauseBreakFromModel":{"description":"Representation of a tenancy break clauses break from details","type":"object","properties":{"date":{"format":"date-time","description":"The earliest date at which the tenant/landlord can end the tenancy agreement","type":"string","example":"2019-08-14T12:30:02Z"},"minTermMonths":{"format":"int32","description":"The minimum number of months from the break clause agreement becoming active at which the tenant/landlord can end the tenancy agreement","type":"integer"}}},"TenancyBreakClauseNoticeRequiredModel":{"description":"Representation of a tenancy break clauses notice requirements","type":"object","properties":{"date":{"format":"date-time","description":"The latest date at which the tenant/landlord must give notice of their decision to end the agreement","type":"string","example":"2019-08-14T12:30:02Z"},"beforeBreakMonths":{"format":"int32","description":"The minimum number of months before the break clause can be invoked at which the tenant/landlord must give notice of their decision to end the tenancy agreement","type":"integer"}}},"TenancyAgreementModel":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"TenancyBreakClauseModel":{"description":"Representation of a tenancy break clause","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the break clause","type":"string"},"created":{"format":"date-time","description":"The date and time when the break clause was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the break clause last modified","type":"string","example":"2019-08-14T12:30:02Z"},"clauseTypeId":{"description":"The identifier of the associated break clause","type":"string"},"description":{"description":"The break clauses description","type":"string"},"active":{"format":"date","description":"The date the break clause became (or becomes) active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The parties that the break clause applies to (landlord/tenant/mutual)","type":"string"},"letterText":{"description":"Tenancy agreement text relating to the break clause","type":"string"},"breakFrom":{"description":"Representation of a tenancy break clauses break from details","type":"object","properties":{"date":{"format":"date-time","description":"The earliest date at which the tenant/landlord can end the tenancy agreement","type":"string","example":"2019-08-14T12:30:02Z"},"minTermMonths":{"format":"int32","description":"The minimum number of months from the break clause agreement becoming active at which the tenant/landlord can end the tenancy agreement","type":"integer"}}},"noticeRequired":{"description":"Representation of a tenancy break clauses notice requirements","type":"object","properties":{"date":{"format":"date-time","description":"The latest date at which the tenant/landlord must give notice of their decision to end the agreement","type":"string","example":"2019-08-14T12:30:02Z"},"beforeBreakMonths":{"format":"int32","description":"The minimum number of months before the break clause can be invoked at which the tenant/landlord must give notice of their decision to end the tenancy agreement","type":"integer"}}},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the break clause. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyBreakClauseModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy break clause","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the break clause","type":"string"},"created":{"format":"date-time","description":"The date and time when the break clause was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the break clause last modified","type":"string","example":"2019-08-14T12:30:02Z"},"clauseTypeId":{"description":"The identifier of the associated break clause","type":"string"},"description":{"description":"The break clauses description","type":"string"},"active":{"format":"date","description":"The date the break clause became (or becomes) active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The parties that the break clause applies to (landlord/tenant/mutual)","type":"string"},"letterText":{"description":"Tenancy agreement text relating to the break clause","type":"string"},"breakFrom":{"description":"Representation of a tenancy break clauses break from details","type":"object","properties":{"date":{"format":"date-time","description":"The earliest date at which the tenant/landlord can end the tenancy agreement","type":"string","example":"2019-08-14T12:30:02Z"},"minTermMonths":{"format":"int32","description":"The minimum number of months from the break clause agreement becoming active at which the tenant/landlord can end the tenancy agreement","type":"integer"}}},"noticeRequired":{"description":"Representation of a tenancy break clauses notice requirements","type":"object","properties":{"date":{"format":"date-time","description":"The latest date at which the tenant/landlord must give notice of their decision to end the agreement","type":"string","example":"2019-08-14T12:30:02Z"},"beforeBreakMonths":{"format":"int32","description":"The minimum number of months before the break clause can be invoked at which the tenant/landlord must give notice of their decision to end the tenancy agreement","type":"integer"}}},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the break clause. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTenancyAgreementModel":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"CreateTenancyBreakFromModel":{"description":"Request body used to set a break clauses break from details","type":"object","properties":{"date":{"format":"date","description":"The date the break from clause can be used","type":"string","example":"2019-08-14"},"minTermMonths":{"format":"int32","description":"The minimum number of months until the break clause can be used","type":"integer"}}},"CreateTenancyNoticeRequiredModel":{"description":"Request body used to set a break clauses notice required details","type":"object","properties":{"date":{"format":"date","description":"The date a break clauses notice is required by","type":"string","example":"2019-08-14"},"beforeBreakMonths":{"format":"int32","description":"The number of months the notice is required before the break clause","type":"integer"}}},"CreateTenancyBreakClauseModel":{"description":"Request body used to update tenancy break clause","type":"object","properties":{"typeId":{"description":"The identifier of the associated to the break clause","type":"string"},"active":{"format":"date","description":"The date the break clause becomes/became active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The responsible party (landlord/tenant/mutual)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"breakFrom":{"description":"Request body used to set a break clauses break from details","type":"object","properties":{"date":{"format":"date","description":"The date the break from clause can be used","type":"string","example":"2019-08-14"},"minTermMonths":{"format":"int32","description":"The minimum number of months until the break clause can be used","type":"integer"}}},"noticeRequired":{"description":"Request body used to set a break clauses notice required details","type":"object","properties":{"date":{"format":"date","description":"The date a break clauses notice is required by","type":"string","example":"2019-08-14"},"beforeBreakMonths":{"format":"int32","description":"The number of months the notice is required before the break clause","type":"integer"}}}},"example":{"typeId":"BK001","active":"2022-01-31","appliesTo":"landlord","agreements":{"landlord":true,"tenant":false},"breakFrom":null,"noticeRequired":null}},"UpdateTenancyAgreementModel":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"UpdateTenancyBreakFromModel":{"description":"Request body used to set a break clauses break from details","type":"object","properties":{"date":{"format":"date","description":"The date the break from clause can be used","type":"string","example":"2019-08-14"},"minTermMonths":{"format":"int32","description":"The minimum number of months until the break clause can be used","type":"integer"}}},"UpdateTenancyNoticeRequiredModel":{"description":"Request body used to set a break clauses notice required details","type":"object","properties":{"date":{"format":"date","description":"The date a break clauses notice is required by","type":"string","example":"2019-08-14"},"beforeBreakMonths":{"format":"int32","description":"The number of months the notice is required before the break clause","type":"integer"}}},"UpdateTenancyBreakClauseModel":{"description":"Request body used to update tenancy break clause","type":"object","properties":{"active":{"format":"date","description":"The date the break clause becomes/became active","type":"string","example":"2019-08-14"},"appliesTo":{"description":"The responsible party (landlord/tenant/mutual)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"breakFrom":{"description":"Request body used to set a break clauses break from details","type":"object","properties":{"date":{"format":"date","description":"The date the break from clause can be used","type":"string","example":"2019-08-14"},"minTermMonths":{"format":"int32","description":"The minimum number of months until the break clause can be used","type":"integer"}}},"noticeRequired":{"description":"Request body used to set a break clauses notice required details","type":"object","properties":{"date":{"format":"date","description":"The date a break clauses notice is required by","type":"string","example":"2019-08-14"},"beforeBreakMonths":{"format":"int32","description":"The number of months the notice is required before the break clause","type":"integer"}}}},"example":{"active":"2022-04-10","appliesTo":"tenant","agreements":{"landlord":false,"tenant":true},"breakFrom":null,"noticeRequired":null}},"TenancyAllowanceModel":{"description":"Representation of a tenancy allowance","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the allowance","type":"string"},"created":{"format":"date-time","description":"The date and time when the allowance was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the allowance last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated allowance","type":"string"},"description":{"description":"The break clauses description","type":"string"},"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the allowance","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the allowance. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyAllowanceModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy allowance","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the allowance","type":"string"},"created":{"format":"date-time","description":"The date and time when the allowance was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the allowance last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated allowance","type":"string"},"description":{"description":"The break clauses description","type":"string"},"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the allowance","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the allowance. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTenancyAllowanceModel":{"description":"Request body used to set a tenancy allowance","type":"object","properties":{"typeId":{"description":"The identifier of the associated to the allowance","type":"string"},"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"typeId":"ALL001","state":"allowed","agreements":{"landlord":true,"tenant":false}}},"UpdateTenancyAllowanceModel":{"description":"Request body used to update tenancy allowance","type":"object","properties":{"state":{"description":"The state of the allowance (allowed/notAllowed)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"state":"notAllowed","agreements":{"landlord":false,"tenant":true}}},"TenancyResponsibilityModel":{"description":"Representation of a tenancies responsibility","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the responsibility","type":"string"},"created":{"format":"date-time","description":"The date and time when the responsibility was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the responsibility last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated to the responsibility","type":"string"},"description":{"description":"The responsibilities description","type":"string"},"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the responsibility","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the responsibility. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyResponsibilityModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancies responsibility","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the responsibility","type":"string"},"created":{"format":"date-time","description":"The date and time when the responsibility was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the responsibility last modified","type":"string","example":"2019-08-14T12:30:02Z"},"typeId":{"description":"The identifier of the associated to the responsibility","type":"string"},"description":{"description":"The responsibilities description","type":"string"},"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Representation of party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}},"letterText":{"description":"Tenancy agreement text that relates to the responsibility","type":"string"},"tenancyId":{"description":"The unique identifier of the associated tenancy","type":"string"},"_eTag":{"description":"The ETag for the current version of the responsibility. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTenancyResponsibilityModel":{"description":"Request body used to set a tenancy responsibility","type":"object","properties":{"typeId":{"description":"The identifier of the associated to the responsibility","type":"string"},"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"typeId":"RES1","appliesTo":"landlord","agreements":{"landlord":true,"tenant":false}}},"UpdateTenancyResponsibilityModel":{"description":"Request body used to update tenancy responsibility","type":"object","properties":{"appliesTo":{"description":"The responsible party (landlord/tenant)","type":"string"},"agreements":{"description":"Request body used to set party agreements to a specific clause in a tenancy agreement","type":"object","properties":{"landlord":{"description":"A flag to determine if the landlord has agreed","type":"boolean"},"tenant":{"description":"A flag to determine if the tenant has agreed","type":"boolean"}}}},"example":{"appliesTo":"tenant","agreements":{"landlord":false,"tenant":true}}},"TenancyRentChangeModel":{"description":"Represents rent changes in a tenancies renewal","type":"object","properties":{"amount":{"format":"double","description":"The amount the rent has changed in the renewal","type":"number"},"percentage":{"format":"double","description":"The percentage the rent has changed in the renewal","type":"number"}}},"TenancyRenewalModel":{"description":"Represents a tenancies renewal negotiation","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the renewal negotiation","type":"string"},"created":{"format":"date-time","description":"The date and time when the renewal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the renewal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","type":"string","example":"2019-08-14"},"endDate":{"format":"date","type":"string","example":"2019-08-14"},"status":{"description":"The status of the renewal (notStarted/started/negotiating/renewed/tenantTerminated/landlordTerminated/periodic)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the renewal","type":"string"},"rent":{"format":"double","description":"The tenancies rent amount","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/4weeks/annually)","type":"string"},"rentChange":{"description":"Represents rent changes in a tenancies renewal","type":"object","properties":{"amount":{"format":"double","description":"The amount the rent has changed in the renewal","type":"number"},"percentage":{"format":"double","description":"The percentage the rent has changed in the renewal","type":"number"}}},"tenancyId":{"description":"The unique identifier of the tenancy associated to the renewal","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy renewal. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyRenewalModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a tenancies renewal negotiation","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the renewal negotiation","type":"string"},"created":{"format":"date-time","description":"The date and time when the renewal was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the renewal was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","type":"string","example":"2019-08-14"},"endDate":{"format":"date","type":"string","example":"2019-08-14"},"status":{"description":"The status of the renewal (notStarted/started/negotiating/renewed/tenantTerminated/landlordTerminated/periodic)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the renewal","type":"string"},"rent":{"format":"double","description":"The tenancies rent amount","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/4weeks/annually)","type":"string"},"rentChange":{"description":"Represents rent changes in a tenancies renewal","type":"object","properties":{"amount":{"format":"double","description":"The amount the rent has changed in the renewal","type":"number"},"percentage":{"format":"double","description":"The percentage the rent has changed in the renewal","type":"number"}}},"tenancyId":{"description":"The unique identifier of the tenancy associated to the renewal","type":"string"},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy renewal. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateLettingFeeRenewalModel":{"description":"Request body used to create a tenancy renewals letting fee","type":"object","properties":{"type":{"description":"The letting fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The letting fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the letting fee is required (monthly/quarterly/halfYearly/yearly/28days/upfront/upfrontOver2Months/other/notApplicable)","type":"string"}}},"CreateManagementFeeRenewalModel":{"description":"Request body used to create a tenancy renewals management fee","type":"object","properties":{"type":{"description":"The mangement fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The mangement fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the mangement fee is required (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"CreateTenancyRenewalModel":{"description":"Request body used to create a tenancy renewal negotiation","type":"object","properties":{"startDate":{"format":"date-time","description":"The proposed start date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The proposed end date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing this tenancy renewal","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"lettingFee":{"description":"Request body used to create a tenancy renewals letting fee","type":"object","properties":{"type":{"description":"The letting fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The letting fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the letting fee is required (monthly/quarterly/halfYearly/yearly/28days/upfront/upfrontOver2Months/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to create a tenancy renewals management fee","type":"object","properties":{"type":{"description":"The mangement fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The mangement fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the mangement fee is required (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}}},"example":{"startDate":"2021-02-25","endDate":"2021-03-25","negotiatorId":"ADV","rent":250,"rentFrequency":"weekly","lettingFee":{"type":"fixed","amount":200,"frequency":"monthly"},"managementFee":{"type":"percentage","amount":15,"frequency":"monthly"}}},"UpdateLettingFeeRenewalModel":{"description":"Request body used to update a tenancy renewals letting fee","type":"object","properties":{"type":{"description":"The letting fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The letting fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the letting fee is required (monthly/quarterly/halfYearly/yearly/28days/upfront/upfrontOver2Months/other/notApplicable)","type":"string"}}},"UpdateManagementFeeRenewalModel":{"description":"Request body used to update a tenancy renewals management fee","type":"object","properties":{"type":{"description":"The mangement fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The mangement fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the mangement fee is required (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"UpdateTenancyRenewalModel":{"description":"Request body used to update a tenancy renewal negotiation","type":"object","properties":{"startDate":{"format":"date-time","description":"The proposed start date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"endDate":{"format":"date-time","description":"The proposed end date of the tenancy renewal","type":"string","example":"2019-08-14T12:30:02Z"},"negotiatorId":{"description":"The unique identifier of the negotiator who is managing this tenancy renewal","type":"string"},"rent":{"format":"double","description":"The amount of rent required, returned in relation to the collection frequency","type":"number"},"rentFrequency":{"description":"The rent collection frequency (weekly/monthly/annually)","type":"string"},"lettingFee":{"description":"Request body used to update a tenancy renewals letting fee","type":"object","properties":{"type":{"description":"The letting fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The letting fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the letting fee is required (monthly/quarterly/halfYearly/yearly/28days/upfront/upfrontOver2Months/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Request body used to update a tenancy renewals management fee","type":"object","properties":{"type":{"description":"The mangement fee type (fixed/perentage)","type":"string"},"amount":{"format":"double","description":"The mangement fee amount as a fixed price or percentage based on the `type`","type":"number"},"frequency":{"description":"The frequency at which the mangement fee is required (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}}},"example":{"startDate":"2021-02-25","endDate":"2021-03-25","negotiatorId":"ADV","rent":250,"rentFrequency":"weekly","lettingFee":{"type":"fixed","amount":200,"frequency":"monthly"},"managementFee":{"type":"percentage","amount":15,"frequency":"monthly"}}},"TenancyExtensionAlterationFeeModel":{"description":"Represents a one off fee associated with tenancy extension or alteration","type":"object","properties":{"amount":{"format":"double","description":"The one fee amount","type":"number"},"summary":{"description":"The one of fee summary text","type":"string"},"type":{"description":"The fee type","type":"string"}}},"TenancyExtensionAlterationModel":{"description":"Represents a tenancy extension or alteration","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the extension or alteration","type":"string"},"created":{"format":"date-time","description":"The date and time when the extension or alteration was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the extension or alteration was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the extension or alteration","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the extension (alterations do not have an end date)","type":"string","example":"2019-08-14"},"type":{"description":"The type of entry (extension|alteration)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the extension or alteration","type":"string"},"rent":{"format":"double","description":"The extension or alteration rent amount","type":"number"},"rentFrequency":{"description":"The rent frequency (weekly/monthly/4weeks/annually)","type":"string"},"payable":{"description":"The frequency of instalments payable on or after the alteration date","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy associated to the extension or alteration","type":"string"},"fee":{"description":"Represents a one off fee associated with tenancy extension or alteration","type":"object","properties":{"amount":{"format":"double","description":"The one fee amount","type":"number"},"summary":{"description":"The one of fee summary text","type":"string"},"type":{"description":"The fee type","type":"string"}}},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy extension or alteration. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyExtensionAlterationModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a tenancy extension or alteration","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the extension or alteration","type":"string"},"created":{"format":"date-time","description":"The date and time when the extension or alteration was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the extension or alteration was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"startDate":{"format":"date","description":"The start date of the extension or alteration","type":"string","example":"2019-08-14"},"endDate":{"format":"date","description":"The end date of the extension (alterations do not have an end date)","type":"string","example":"2019-08-14"},"type":{"description":"The type of entry (extension|alteration)","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator associated to the extension or alteration","type":"string"},"rent":{"format":"double","description":"The extension or alteration rent amount","type":"number"},"rentFrequency":{"description":"The rent frequency (weekly/monthly/4weeks/annually)","type":"string"},"payable":{"description":"The frequency of instalments payable on or after the alteration date","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy associated to the extension or alteration","type":"string"},"fee":{"description":"Represents a one off fee associated with tenancy extension or alteration","type":"object","properties":{"amount":{"format":"double","description":"The one fee amount","type":"number"},"summary":{"description":"The one of fee summary text","type":"string"},"type":{"description":"The fee type","type":"string"}}},"lettingFee":{"description":"Representation of the tenancy letting fee","type":"object","properties":{"type":{"description":"The letting fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (upfront/upfrontOver2Months/monthly/quarterly/halfYearly/yearly/28days/other/notApplicable)","type":"string"}}},"managementFee":{"description":"Representation of the tenancy management fee","type":"object","properties":{"type":{"description":"The management fee type (percentage/fixed)","type":"string"},"amount":{"format":"double","description":"The fee amount","type":"number"},"frequency":{"description":"The frequency of when the fee is to be collected (monthly/quarterly/halfYearly/yearly/28days/sameAsLettingFee)","type":"string"}}},"_eTag":{"description":"The ETag for the current version of the tenancy extension or alteration. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"TenancyRenewalCheckModel":{"description":"Representation of a tenancy renewal check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy renewal check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy renewal check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy renewal check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The status of the tenancy renewal check (needed/notNeeded/arranging/completed)","type":"string"},"description":{"description":"Textual description of what the tenancy renewal check relates to","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"renewalId":{"description":"The unique identifier of the renewal that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy renewal check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyRenewalCheckModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a tenancy renewal check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy renewal check","type":"string"},"created":{"format":"date-time","description":"The date and time when the tenancy renewal check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the tenancy renewal check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"status":{"description":"The status of the tenancy renewal check (needed/notNeeded/arranging/completed)","type":"string"},"description":{"description":"Textual description of what the tenancy renewal check relates to","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"renewalId":{"description":"The unique identifier of the renewal that this check relates to","type":"string"},"metadata":{"description":"App specific metadata that has been set against the tenancy renewal check","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTenancyRenewalCheckModel":{"description":"Request body used to create a new tenancy renewal check","required":["status"],"type":"object","properties":{"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured tenancy check. This will only be populated\r\nfor pre-configured tenancy checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"description":{"description":"The name of this tenancy check","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy renewal check","type":"object","additionalProperties":{}}},"example":{"status":"needed","checkTypeId":"RC123","description":null,"metadata":{}}},"UpdateTenancyRenewalCheckModel":{"description":"Request body used to update a tenancy renewal check","type":"object","properties":{"status":{"description":"The status of the tenancy check (needed/notNeeded/arranging/completed)","type":"string"},"metadata":{"description":"App specific metadata to set against the tenancy renewal check","type":"object","additionalProperties":{}}},"example":{"status":"notNeeded","metadata":{}}},"TenancyRentReviewTermsAgreedRentModel":{"description":"Represents the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"TenancyRentReviewTermsProposedRentModel":{"description":"Represents the proposal of the rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"TenancyRentReviewTermsModel":{"description":"Represents the rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Represents the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Represents the proposal of the rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"TenancyRentReviewAgreementModel":{"description":"Represents the rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"TenancyRentReviewModel":{"description":"Represents a rent review for a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordRecievedDate":{"format":"date","description":"The date the rent review was recieved by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantRecievedDate":{"format":"date","description":"The date the rent review was recieved by the tenant","type":"string","example":"2019-08-14"},"tenancyId":{"description":"The unique identifier of the tenancy this rent review relates to","type":"string"},"terms":{"description":"Represents the rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Represents the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Represents the proposal of the rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Represents the rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the rent review","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the rent review. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyRentReviewModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Represents a rent review for a tenancy","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordRecievedDate":{"format":"date","description":"The date the rent review was recieved by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantRecievedDate":{"format":"date","description":"The date the rent review was recieved by the tenant","type":"string","example":"2019-08-14"},"tenancyId":{"description":"The unique identifier of the tenancy this rent review relates to","type":"string"},"terms":{"description":"Represents the rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Represents the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Represents the proposal of the rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Represents the rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the rent review","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the rent review. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateTenancyRentReviewTermsAgreedRentModel":{"description":"Request body used to create the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"CreateTenancyRentReviewTermsProposedRentModel":{"description":"Request body used to create the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"CreateTenancyRentReviewTermsModel":{"description":"Request body used to create a new rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Request body used to create the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Request body used to create the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"CreateTenancyRentReviewAgreementModel":{"description":"Request body used to create rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"CreateTenancyRentReviewModel":{"description":"Request body used to create a new rent review for a tenancy","type":"object","properties":{"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordReceivedDate":{"format":"date","description":"The date the rent review was received by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantReceivedDate":{"format":"date","description":"The date the rent review was received by the tenant","type":"string","example":"2019-08-14"},"terms":{"description":"Request body used to create a new rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Request body used to create the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Request body used to create the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Request body used to create rent review agreement for a tenancy","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancies rent review","type":"object","additionalProperties":{}}},"example":{"landlordSentDate":"2023-01-01","landlordReceivedDate":"2023-01-15","tenantSentDate":"2023-02-01","tenantReceivedDate":"2023-02-15","terms":{"proposedOn":"2023-03-01","proposedStart":"2023-04-01","effectiveDate":"2023-05-01","landlordAgreed":true,"tenantAgreed":false,"agreedRent":{"amount":1350,"frequency":"monthly"},"proposedRent":{"amount":1400,"frequency":"monthly"}},"agreement":{"negotiatorId":"JAS","status":"started"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"UpdateTenancyRentReviewTermsAgreedRentModel":{"description":"Request body used to update the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"UpdateTenancyRentReviewTermsProposedRentModel":{"description":"Request body used to update the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"UpdateTenancyRentReviewTermsModel":{"description":"Request body used to update an existing rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Request body used to update the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Request body used to update the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"UpdateTenancyRentReviewAgreementModel":{"description":"Request body used to update the agreement section for a rent review","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"UpdateTenancyRentReviewModel":{"description":"Request body used to update an existing rent review for a tenancy","type":"object","properties":{"landlordSentDate":{"format":"date","description":"The date the rent review was sent to the landlord","type":"string","example":"2019-08-14"},"landlordReceivedDate":{"format":"date","description":"The date the rent review was received by the landlord","type":"string","example":"2019-08-14"},"tenantSentDate":{"format":"date","description":"The date the rent review was sent to the tenant","type":"string","example":"2019-08-14"},"tenantReceivedDate":{"format":"date","description":"The date the rent review was received by the tenant","type":"string","example":"2019-08-14"},"terms":{"description":"Request body used to update an existing rent review terms for a tenancy","type":"object","properties":{"proposedOn":{"format":"date","description":"The date the rent review was proposed on","type":"string","example":"2019-08-14"},"proposedStart":{"format":"date","description":"The date the rent reviews proposed start date","type":"string","example":"2019-08-14"},"effectiveDate":{"format":"date","description":"The date the rent review is effective from","type":"string","example":"2019-08-14"},"landlordAgreed":{"description":"A flag indicating whether the landlord has agreed to the rent review terms","type":"boolean"},"tenantAgreed":{"description":"A flag indicating whether the tenant has agreed to the rent review terms","type":"boolean"},"agreedRent":{"description":"Request body used to update the agreed terms of the rent review","type":"object","properties":{"amount":{"format":"double","description":"The agreed rent amount","type":"number"},"frequency":{"description":"The agreed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}},"proposedRent":{"description":"Request body used to update the proposed rent review terms for a tenancy","type":"object","properties":{"amount":{"format":"double","description":"The proposed rent amount","type":"number"},"frequency":{"description":"The proposed rent frequency (monthly/weekly/fourWeekly/annually)","type":"string"}}}}},"agreement":{"description":"Request body used to update the agreement section for a rent review","type":"object","properties":{"negotiatorId":{"description":"The unique identifier of the negotiator handling the rent review","type":"string"},"status":{"description":"The status of the rent review agreement (started/inNegotiation/completedRentUpdated/completedNoRentUpdate/comparables/tribunal)","type":"string"}}},"metadata":{"description":"App specific metadata to set against the tenancies rent review","type":"object","additionalProperties":{}}},"example":{"landlordSentDate":"2024-01-01","landlordReceivedDate":"2024-01-15","tenantSentDate":"2024-02-01","tenantReceivedDate":"2024-02-15","terms":{"proposedOn":"2024-03-01","proposedStart":"2024-04-01","effectiveDate":"2024-05-01","landlordAgreed":true,"tenantAgreed":true,"agreedRent":{"amount":1450,"frequency":"monthly"},"proposedRent":{"amount":1500,"frequency":"monthly"}},"agreement":{"negotiatorId":"JAS","status":"inNegotiation"},"metadata":{"CustomField1":"CustomValue1","CustomField2":"CustomValue2"}}},"TenancyRentReviewCheckModel":{"description":"Representation of a rent reviews check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review check","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the rent review check relates to","type":"string"},"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured rent review check. This will only be populated\r\nfor pre-configured rent review checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"rentReviewId":{"description":"The unique identifier of the rent review that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}},"TenancyRentReviewCheckModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a rent reviews check","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the rent review check","type":"string"},"created":{"format":"date-time","description":"The date and time when the rent review check was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the rent review check was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"description":{"description":"Textual description of what the rent review check relates to","type":"string"},"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured rent review check. This will only be populated\r\nfor pre-configured rent review checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that this check relates to","type":"string"},"rentReviewId":{"description":"The unique identifier of the rent review that this check relates to","type":"string"},"_eTag":{"description":"The ETag for the current version of the teanncy check. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateRentReviewCheckModel":{"description":"Request body used to create a new rent review check","required":["status"],"type":"object","properties":{"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"},"checkTypeId":{"description":"The identifier of the pre-configured rent review check. This will only be populated\r\nfor pre-configured rent review checks, and not for custom/ad-hoc checks added to individual tenancies","type":"string"}},"example":{"status":"needed","checkTypeId":"RR123"}},"UpdateRentReviewCheckModel":{"description":"Request body used to update a rent review check","required":["status"],"type":"object","properties":{"status":{"description":"The status of the rent review check (needed/notNeeded/arranging/completed)","type":"string"}},"example":{"status":"completed"}},"TenantNoticeModel":{"description":"Represents a notice tenant within notice management","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToLandlord":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"LandlordNoticeModel":{"description":"Represents a notice landlord within notice management","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToTenant":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"TenancyNoticeManagementModel":{"description":"Represents a tenancy notice management record","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the tenancy record","type":"string"},"created":{"format":"date-time","description":"The date and time when the record was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the record was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"tenancyId":{"description":"The unique identifier of the tenancy","type":"string"},"agreedEndDate":{"format":"date","description":"The agreed tenancy end date","type":"string","example":"2019-08-14"},"tenantNotice":{"description":"Represents a notice tenant within notice management","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToLandlord":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"landlordNotice":{"description":"Represents a notice landlord within notice management","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToTenant":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"_eTag":{"description":"The ETag for the current version of the tenancy record. Used for managing update concurrency","type":"string","readOnly":true}}},"UpdateTenantNoticeModel":{"description":"The payload required to update a notice tenant","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToLandlord":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"UpdateLandlordNoticeModel":{"description":"The payload required to update a notice landlord","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToTenant":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"UpdateTenancyNoticeManagementModel":{"description":"The payload required to update a tenancy notice management record","type":"object","properties":{"tenantNotice":{"description":"The payload required to update a notice tenant","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToLandlord":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}},"landlordNotice":{"description":"The payload required to update a notice landlord","type":"object","properties":{"requestReceived":{"format":"date","description":"The date when the notice request was received","type":"string","example":"2019-08-14"},"proposedEndDate":{"format":"date","description":"The proposed end date of the tenancy","type":"string","example":"2019-08-14"},"noticeReason":{"description":"The reason for the notice","type":"string"},"servedToTenant":{"format":"date","description":"The date when the notice was served","type":"string","example":"2019-08-14"}}}}},"TransactionModel":{"description":"Model representing a transaction","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the transaction","type":"string"},"created":{"format":"date-time","description":"The date and time when the transaction was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the transaction was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The transaction category (advertisingCharge,accountTransfer,bankCharges,buyerAdminFee,buyerDeposit,buyerPayment,deposit,depositDeduction,depositRefund,depositTransfer,depositTransferToAgent,depositTransferToLandlord,depositTransferToScheme,estateServiceCharge,estateWorksOrder,estateUnitWorksOrder,externalCredit,externalAgentFee,freeholderPayment,float,groundRent,goodwillPayment,holdingDeposit,introducingTenantFee,landlordAdminFee,landlordTax,landlordPayment,landlordToSupplierPayment,landlordWorksOrder,leaseholderAdminFee,leaseholderPayment,leaseholderRepayment,leaseholderWorksOrder,lettingFee,managementFee,paymentSurcharge,receipt,rent,rentGuarantee,recoveryPayment,reserveFund,tenantAdminFee,tenantPayment,tenantToLandlordPayment,tenantToSupplierPayment,trustAccountingInvoice,tenantWorksOrder,vacantManagementFee,vendorAdminFee,vendorCommission,vendorPayment,vendorToSupplierPayment,worksOrderPayment)","type":"string"},"type":{"description":"The transaction type (bankersDraft,bankTransfer,cash,cheque,creditCard,debitCard,directDebit,housingBenefit,paymentRequest,standingOrder)","type":"string"},"transactionType":{"description":"The type of transaction (credit/debit)","type":"string"},"description":{"description":"The transaction description","type":"string"},"status":{"description":"The status of the transaction (awaitingAuthorisation/awaitingPosting/posted/rejected)","type":"string"},"ledger":{"description":"The ledger the transaction is recorded in","type":"string"},"netAmount":{"format":"double","description":"The transaction net amount","type":"number"},"taxAmount":{"format":"double","description":"The transaction tax amount","type":"number"},"grossAmount":{"format":"double","description":"The transaction gross amount","type":"number"},"outstanding":{"format":"double","description":"The amount outstanding that remains to be paid","type":"number"},"companyId":{"description":"The unique identifier of the company the transaction is associated with, where applicable","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the transaction is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the transaction is associated with, where applicable","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the transaction is associated with, where applicable","type":"string"},"worksOrderId":{"description":"The unique identifier of the workds order the transaction is associated with, where applicable","type":"string"},"rejectReason":{"description":"The reason for rejection of an invoice","type":"string"},"_eTag":{"description":"The ETag for the current version of the transaction. Used for managing update concurrency","type":"string","readOnly":true}}},"TransactionModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing a transaction","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the transaction","type":"string"},"created":{"format":"date-time","description":"The date and time when the transaction was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the transaction was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"category":{"description":"The transaction category (advertisingCharge,accountTransfer,bankCharges,buyerAdminFee,buyerDeposit,buyerPayment,deposit,depositDeduction,depositRefund,depositTransfer,depositTransferToAgent,depositTransferToLandlord,depositTransferToScheme,estateServiceCharge,estateWorksOrder,estateUnitWorksOrder,externalCredit,externalAgentFee,freeholderPayment,float,groundRent,goodwillPayment,holdingDeposit,introducingTenantFee,landlordAdminFee,landlordTax,landlordPayment,landlordToSupplierPayment,landlordWorksOrder,leaseholderAdminFee,leaseholderPayment,leaseholderRepayment,leaseholderWorksOrder,lettingFee,managementFee,paymentSurcharge,receipt,rent,rentGuarantee,recoveryPayment,reserveFund,tenantAdminFee,tenantPayment,tenantToLandlordPayment,tenantToSupplierPayment,trustAccountingInvoice,tenantWorksOrder,vacantManagementFee,vendorAdminFee,vendorCommission,vendorPayment,vendorToSupplierPayment,worksOrderPayment)","type":"string"},"type":{"description":"The transaction type (bankersDraft,bankTransfer,cash,cheque,creditCard,debitCard,directDebit,housingBenefit,paymentRequest,standingOrder)","type":"string"},"transactionType":{"description":"The type of transaction (credit/debit)","type":"string"},"description":{"description":"The transaction description","type":"string"},"status":{"description":"The status of the transaction (awaitingAuthorisation/awaitingPosting/posted/rejected)","type":"string"},"ledger":{"description":"The ledger the transaction is recorded in","type":"string"},"netAmount":{"format":"double","description":"The transaction net amount","type":"number"},"taxAmount":{"format":"double","description":"The transaction tax amount","type":"number"},"grossAmount":{"format":"double","description":"The transaction gross amount","type":"number"},"outstanding":{"format":"double","description":"The amount outstanding that remains to be paid","type":"number"},"companyId":{"description":"The unique identifier of the company the transaction is associated with, where applicable","type":"string"},"landlordId":{"description":"The unique identifier of the landlord the transaction is associated with, where applicable","type":"string"},"propertyId":{"description":"The unique identifier of the property the transaction is associated with, where applicable","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the transaction is associated with, where applicable","type":"string"},"worksOrderId":{"description":"The unique identifier of the workds order the transaction is associated with, where applicable","type":"string"},"rejectReason":{"description":"The reason for rejection of an invoice","type":"string"},"_eTag":{"description":"The ETag for the current version of the transaction. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"NominalAccountModel":{"description":"Model representing a nominal account","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the nominal account","type":"string"},"created":{"format":"date-time","description":"The date and time when the nominal account was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the nominal account was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The nominal account name","type":"string"},"appliesToWorksOrders":{"description":"Flag indicating whether or not the nominal account can be associated with works orders","type":"boolean"}}},"NominalAccountModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Model representing a nominal account","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the nominal account","type":"string"},"created":{"format":"date-time","description":"The date and time when the nominal account was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the nominal account was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"name":{"description":"The nominal account name","type":"string"},"appliesToWorksOrders":{"description":"Flag indicating whether or not the nominal account can be associated with works orders","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateSupplierInvoiceModel":{"description":"Request body used to create a new supplier invoice","required":["description","accountId","invoiceRef","negotiatorId","invoiceDate","netAmount","taxAmount"],"type":"object","properties":{"worksOrderId":{"description":"The unique identifier of the works order the supplier invoice is associated with, where applicable\r\nMust be provided if propertyId/companyId/tenancyId are not present","type":"string"},"propertyId":{"description":"The unique identifier of the property the supplier invoice is associated with, where applicable\r\nWhen providing a propertyId along with a worksOrderId, the id will be validated against the works order to check they match","type":"string"},"companyId":{"description":"The unique identifier of the contractor (company) the supplier invoice is associated with, where applicable\r\nWhen providing a companyId along with a worksOrderId, the id will be validated against the works order to check they match","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy the supplier invoice is associated with, where applicable\r\nWhen providing a tenancyId along with a worksOrderId, the id will be validated against the works order to check they match","type":"string"},"description":{"description":"The supplier invoice work description","type":"string"},"accountId":{"description":"The identifier of the nominal account the supplier invoice should be attributed to","type":"string"},"invoiceRef":{"description":"The invoice reference","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator the invoice should be attributed to (normally the person creating it on the system)","type":"string"},"invoiceDate":{"format":"date","description":"The invoice date","type":"string","example":"2019-08-14"},"dueDate":{"format":"date","description":"The date the invoice should be paid by","type":"string","example":"2019-08-14"},"netAmount":{"format":"double","description":"The invoice net amount","type":"number"},"taxAmount":{"format":"double","description":"The invoice tax amount","type":"number"},"category":{"description":"The category type of the supplier invoice","type":"string"},"holdReserveFunds":{"format":"double","description":"The held reserve fund amount","type":"number"}},"example":{"worksOrderId":"WRK22000001","propertyId":null,"companyId":"CMP22000010","tenancyId":null,"description":"Fixed leaky tap in en-suite. Required replacement tap unit","accountId":"genman","invoiceRef":"RPR-INV-15945992","negotiatorId":"JAS","invoiceDate":"2022-12-06","dueDate":"2023-01-06","netAmount":120,"taxAmount":24,"category":"landlord","holdReserveFunds":0}},"VendorSourceModel":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"VendorContactAddressModel":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"VendorContactModel":{"description":"A summarised view of the details of a contact or company associated to a vendor","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"attentionId":{"description":"The identifier of the staff member who is the registered attention for the company. It can be used with the company staff members endpoint to retrieve contact details. This value may represent either a contact code or an index number.","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}},"VendorModel":{"description":"Representation of a vendor","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the vendor was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the vendor was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the vendor was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the vendor is next due to be called","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the type of vendor","type":"string"},"sellingReasonId":{"description":"The unique identifier of the reason the vendor is selling","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the vendor","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the vendor","type":"string"},"source":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the vendor. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a vendor","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"attentionId":{"description":"The identifier of the staff member who is the registered attention for the company. It can be used with the company staff members endpoint to retrieve contact details. This value may represent either a contact code or an index number.","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"correspondenceAddressType":{"description":"Value indicating where hard copies of correspondence should be sent for the primary contact (property/contact).\r\nWhen set to contact, any correspondence should be sent to the related contact's address, rather than the property address","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator attached to the vendor. The first item in the collection is considered the primary negotiator","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the vendor. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the vendor was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the vendor is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the vendor","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the vendor. Used for managing update concurrency","type":"string","readOnly":true}}},"VendorUpdateSourceModel":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"UpdateVendorModel":{"description":"Request body used to update an existing vendor","type":"object","properties":{"lastCall":{"format":"date","description":"The date the vendor was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the vendor is next due to be called","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the type of vendor","type":"string"},"sellingReasonId":{"description":"The unique identifier of the reason the vendor is selling","type":"string"},"solicitorId":{"description":"The unique identifier of the vendor's solicitor","type":"string"},"correspondenceAddressType":{"description":"Value indicating where hard copies of correspondence should be sent for the primary contact (property/contact)","type":"string"},"source":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"metadata":{"description":"App specific metadata that has been set against the vendor","type":"object","additionalProperties":{}}},"example":{"lastCall":"2019-11-12","nextCall":"2019-12-29","typeId":"S","sellingReasonId":"RL","solicitorId":"OXF12300101","correspondenceAddressType":null,"source":{"id":"OXF","type":"office"},"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"VendorModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a vendor","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the vendor was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the vendor was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"lastCall":{"format":"date","description":"The date the vendor was last called","type":"string","example":"2019-08-14"},"nextCall":{"format":"date","description":"The date the vendor is next due to be called","type":"string","example":"2019-08-14"},"typeId":{"description":"The unique identifier of the type of vendor","type":"string"},"sellingReasonId":{"description":"The unique identifier of the reason the vendor is selling","type":"string"},"solicitorId":{"description":"The unique identifier of the solicitor associated to the vendor","type":"string"},"propertyId":{"description":"The unique identifier of the property associated to the vendor","type":"string"},"source":{"description":"Representation of a vendor's source","type":"object","properties":{"id":{"description":"The unique identifier of the source of the vendor","type":"string"},"type":{"description":"The source type (office/source)","type":"string"}}},"related":{"description":"A collection of contacts and/or companies associated to the vendor. The first item in the collection is considered the primary relationship","type":"array","items":{"description":"A summarised view of the details of a contact or company associated to a vendor","type":"object","properties":{"id":{"description":"The unique identifier of the contact or company","type":"string"},"attentionId":{"description":"The identifier of the staff member who is the registered attention for the company. It can be used with the company staff members endpoint to retrieve contact details. This value may represent either a contact code or an index number.","type":"string"},"name":{"description":"The complete name of the contact or company","type":"string"},"title":{"description":"The title of the contact (Available when 'type' is 'contact')","type":"string"},"forename":{"description":"The forename of the contact (Available when 'type' is 'contact')","type":"string"},"surname":{"description":"The surname of the contact (Available when 'type' is 'contact')","type":"string"},"dateOfBirth":{"format":"date","description":"The date of birth of the contact (Available when 'type' is 'contact')","type":"string","example":"2019-08-14"},"type":{"description":"The type of the contact (company/contact)","type":"string"},"homePhone":{"description":"The home phone number of the contact or company","type":"string"},"workPhone":{"description":"The work phone number of the contact or company","type":"string"},"mobilePhone":{"description":"The mobile phone number of the contact or company","type":"string"},"email":{"description":"The email address of the contact or company","type":"string"},"marketingConsent":{"description":"The marketing consent status of the contact (grant/deny/notAsked/unknown)","type":"string"},"fromArchive":{"description":"Flag to determine if this role on the system is now archived","type":"boolean"},"primaryAddress":{"description":"Representation of the physical address of a building or premise","type":"object","properties":{"buildingName":{"description":"The building name","type":"string"},"buildingNumber":{"description":"The building number","type":"string"},"line1":{"description":"The first line of the address","type":"string"},"line2":{"description":"The second line of the address","type":"string"},"line3":{"description":"The third line of the address","type":"string"},"line4":{"description":"The fourth line of the address","type":"string"},"postcode":{"description":"The postcode","type":"string"},"countryId":{"description":"The ISO-3166 country code that the address resides within","type":"string"}}},"additionalContactDetails":{"description":"A collection of additional contact details","type":"array","items":{"description":"Representation of additional contact details","type":"object","properties":{"type":{"description":"The type of contact detail","type":"string"},"value":{"description":"The contact detail","type":"string"}}}}}}},"correspondenceAddressType":{"description":"Value indicating where hard copies of correspondence should be sent for the primary contact (property/contact).\r\nWhen set to contact, any correspondence should be sent to the related contact's address, rather than the property address","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator attached to the vendor. The first item in the collection is considered the primary negotiator","type":"string"},"officeIds":{"description":"A collection of unique identifiers of offices attached to the vendor. The first item in the collection is considered the primary office","type":"array","items":{"type":"string"}},"archivedOn":{"format":"date-time","description":"The date and time the vendor was archived","type":"string","example":"2019-08-14T12:30:02Z"},"fromArchive":{"description":"A flag determining whether or not the vendor is archived","type":"boolean"},"metadata":{"description":"App specific metadata that has been set against the vendor","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the vendor. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"VendorContactRelationshipModel":{"description":"Representation of a relationship between a vendor and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor relationship","type":"string"},"vendorId":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent vendor entity","type":"boolean"}}},"VendorContactRelationshipModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a relationship between a vendor and a contact or company","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the vendor relationship","type":"string"},"vendorId":{"description":"The unique identifier of the vendor","type":"string"},"created":{"format":"date-time","description":"The date and time when the relationship was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the relationship was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"associatedType":{"description":"The type of related entity (contact/company)","type":"string"},"associatedId":{"description":"The unique identifier of the related contact or company","type":"string"},"isMain":{"description":"A flag denoting whether or not this relationship should be regarded as the main relationship for the parent vendor entity","type":"boolean"}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"InsertVendorContactRelationshipModel":{"description":"Request body used to create or update a relationship between a vendor and a contact or company","required":["associatedId","associatedType","isMain"],"type":"object","properties":{"associatedId":{"description":"The unique identifier of the contact or company to create a relationship with","type":"string"},"associatedType":{"description":"The type of relationship to create (contact/company)","type":"string"},"isMain":{"description":"Flag denoting whether or not this relationship should be considered to be the main/primary relationship. Setting to true will automatically demote the existing primary relationship","type":"boolean"}},"example":{"associatedId":"OXF18000001","associatedType":"contact","isMain":false}},"WorksOrderItemModel":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}},"WorksOrderModel":{"description":"Representation of a works order","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique identifier of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"totalNetAmount":{"format":"double","description":"The total net cost for all of the items of work to be carried out","type":"number"},"totalVatAmount":{"format":"double","description":"The total additional vat cost for all of the items of work to be carried out","type":"number"},"totalGrossAmount":{"format":"double","description":"The total gross cost for all of the items of work to be carried out","type":"number"},"items":{"description":"A collection of jobs/items of work that the works order should fulfill","type":"array","items":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}}},"metadata":{"description":"App specific metadata that has been set against the works order","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the works order. Used for managing update concurrency","type":"string","readOnly":true}}},"WorksOrderModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a works order","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique identifier of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"totalNetAmount":{"format":"double","description":"The total net cost for all of the items of work to be carried out","type":"number"},"totalVatAmount":{"format":"double","description":"The total additional vat cost for all of the items of work to be carried out","type":"number"},"totalGrossAmount":{"format":"double","description":"The total gross cost for all of the items of work to be carried out","type":"number"},"items":{"description":"A collection of jobs/items of work that the works order should fulfill","type":"array","items":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}}},"metadata":{"description":"App specific metadata that has been set against the works order","type":"object","additionalProperties":{}},"extrasField":{"description":"The requested extras fields","type":"object","additionalProperties":{}},"_eTag":{"description":"The ETag for the current version of the works order. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"CreateWorksOrderItemModel":{"description":"Representation of a works order item","required":["notes","chargeTo"],"type":"object","properties":{"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The cost of the vat associated with the work","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"}},"example":{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":0}},"CreateWorksOrderModel":{"description":"Request body used to create a new works order","required":["propertyId","negotiatorId","status","description","reporter","items"],"type":"object","properties":{"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique id of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"items":{"description":"Individual work items to attach to the works order","type":"array","items":{"description":"Representation of a works order item","required":["notes","chargeTo"],"type":"object","properties":{"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The cost of the vat associated with the work","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"}},"example":{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":0}}},"metadata":{"description":"App specific metadata to set against the works order","type":"object","additionalProperties":{}}},"example":{"companyId":"OXF18000001","propertyId":"OXF190001","tenancyId":"OXF190022","negotiatorId":"JAS","typeId":"ES","status":"complete","description":"Light fitting in living room not working.","reporter":"landlord","priority":"low","booked":"2019-05-10","required":"2019-08-12","reviewDate":"2019-08-02","completed":"2019-10-01","items":[{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":0}],"metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"UpdateWorksOrderModel":{"description":"Request body used to update an existing works order","type":"object","properties":{"companyId":{"description":"The unique identifier of the company that has been selected to perform the work","type":"string"},"propertyId":{"description":"The unique identifier of the property where the work is to be carried out","type":"string"},"tenancyId":{"description":"The unique identifier of the tenancy that the works order originated from","type":"string"},"negotiatorId":{"description":"The unique identifier of the negotiator that booked the works order","type":"string"},"typeId":{"description":"The unique id of the type of work that needs to be carried out","type":"string"},"status":{"description":"The current status of the works order (pendingApproval/pendingQuote/raised/raisedToChase/landlordToComplete/complete/cancelled/quoteAccepted)","type":"string"},"description":{"description":"A free text description of the work required","type":"string"},"reporter":{"description":"The party requesting the work to be carried out (landlord/tenant/other)","type":"string"},"priority":{"description":"The priority level of the works order (low/medium/high)","type":"string"},"booked":{"format":"date","description":"The date when the works order was booked","type":"string","example":"2019-08-14"},"required":{"format":"date","description":"The date when the work is required to be completed by","type":"string","example":"2019-08-14"},"reviewDate":{"format":"date","description":"The date when the work is reviewed","type":"string","example":"2019-08-14"},"completed":{"format":"date","description":"The date when the work was completed","type":"string","example":"2019-08-14"},"metadata":{"description":"App specific metadata to set against the works order","type":"object","additionalProperties":{}}},"example":{"companyId":"OXF18000001","propertyId":"OXF190001","tenancyId":"OXF190022","negotiatorId":"JAS","typeId":"ES","status":"complete","description":"Light fitting in living room not working.","reporter":"landlord","priority":"low","booked":"2019-05-10","required":"2019-08-12","reviewDate":"2019-08-02","completed":"2019-10-01","metadata":{"CustomField1":"CustomValue1","CustomField2":true}}},"WorksOrderItemModelPagedResult":{"type":"object","properties":{"_embedded":{"type":"array","items":{"description":"Representation of a works order item","type":"object","properties":{"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}},"readOnly":true},"_embedded":{"type":"object","additionalProperties":{},"readOnly":true},"id":{"description":"The unique identifier of the works order item","type":"string"},"worksOrderId":{"description":"The unique identifier of the parent works order","type":"string"},"created":{"format":"date-time","description":"The date and time when the works order item was created","type":"string","example":"2019-08-14T12:30:02Z"},"modified":{"format":"date-time","description":"The date and time when the works order item was last modified","type":"string","example":"2019-08-14T12:30:02Z"},"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The additional vat cost for the work to be carried out","type":"number"},"grossAmount":{"format":"double","description":"The gross cost of the work to be carried out","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"},"nominalAccountId":{"description":"The unique identifier of the nominal account the works order financial transactions are allocated to","type":"string"},"_eTag":{"description":"The ETag for the current version of the works order item. Used for managing update concurrency","type":"string","readOnly":true}}}},"pageNumber":{"format":"int32","type":"integer"},"pageSize":{"format":"int32","type":"integer"},"pageCount":{"format":"int32","type":"integer"},"totalPageCount":{"format":"int32","type":"integer"},"totalCount":{"format":"int32","type":"integer"},"_links":{"type":"object","additionalProperties":{"type":"object","properties":{"href":{"type":"string"}}}}}},"UpdateWorksOrderItemModel":{"description":"Representation of a works order item","type":"object","properties":{"notes":{"description":"The notes attached to the works order item","type":"string"},"chargeTo":{"description":"The party to be charged for the work being carried out (landlord/tenant)","type":"string"},"estimate":{"format":"double","description":"The estimate of any costs associated with the work being carried out given to the party to be charged for the work","type":"number"},"estimateType":{"description":"The type of estimate supplied (agent/verbal/written)","type":"string"},"netAmount":{"format":"double","description":"The net cost of the work to be carried out","type":"number"},"vatAmount":{"format":"double","description":"The cost of the vat associated with the work","type":"number"},"reserveAmount":{"format":"double","description":"The amount of funds to be held back by the agent in landlord payment runs to cover the cost of any works required by the works order item","type":"number"}},"example":{"notes":"Please book the electrical certificate for either Thursday or Friday.","chargeTo":"landlord","estimate":120,"estimateType":"written","netAmount":100,"vatAmount":20,"reserveAmount":null}}},"tags":[{"name":"Applicants","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#applicant"}},{"name":"Areas","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#area"}},{"name":"Appointments","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#appointment"}},{"name":"Auctions","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#auction"}},{"name":"Certificates","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#certificate"}},{"name":"Companies","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#company"}},{"name":"Configuration","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#configuration"}},{"name":"Contacts","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#contact"}},{"name":"Conveyancing","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#conveyancing"}},{"name":"Departments","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#department"}},{"name":"Documents","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#document"}},{"name":"Enquiries","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#enquiry"}},{"name":"IdentityChecks","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#identity-check"}},{"name":"Invoices","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#invoice"}},{"name":"JournalEntries","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#journal-entry"}},{"name":"Negotiators","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#negotiator"}},{"name":"Landlords","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#landlord"}},{"name":"Metadata","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#metadata"}},{"name":"MetadataSchema","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#metadata"}},{"name":"Notifications","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#notification"}},{"name":"Offers","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#offer"}},{"name":"Offices","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#office"}},{"name":"Properties","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#property"}},{"name":"PropertyImages","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#property-image"}},{"name":"Referrals","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#referral"}},{"name":"RestHooks","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#rest-hook"}},{"name":"Sources","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#source"}},{"name":"Tasks","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#task"}},{"name":"Tenancies","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#tenancy"}},{"name":"Transactions","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#transaction"}},{"name":"Vendors","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#vendor"}},{"name":"WorksOrders","externalDocs":{"description":"More info","url":"http://foundations.link/glossary#works-order"}}]}