Imóvel
Modelo de Imóvel
type
string
Tipo de imóvel. Um de [Apartment, House, Building, Farm, Land, BusinessOffice, Store, Warehouse, Garage, HouseFloor, SaleOfBusiness]
required
subType
string
Subtipo do imóvel. Um de [UrbanLand, BuildableLand, RusticLand, IndustrialLand]
reference
string
Referência interna do imóvel no seu CRM. Deve ser única.
required
minLength: 1
string ^.{0,100}$
referenceURL
string
Link público para o imóvel.
nullable: true
string ^.{0,150}$
address
object
Modelo de Morada
Morada do imóvel; é obrigatório enviar as coordenadas do imóvel ou o código postal, mesmo que decida ocultar a localização exata no site.
required
contact
object
Modelo de Contacto Modelo
Informações de contacto para o imóvel. Por defeito, as informações de contacto serão retiradas da Agência a que o imóvel pertence. Opcionalmente, é possível usar este objeto para substituir estas informações e atribuir automaticamente o imóvel a um utilizador fornecendo o email do utilizador registado no Portal CasaYes.
nullable: true
operation
object
Modelo da Operação
Informações relacionadas com o preço e comissões do imóvel.
required
descriptions
object[]
Modelo das Descrições
Lista de descrições a mostrar no detalhe do imóvel.
required
images
object[]
Modelo das Imagens
Lista de imagens a mostrar na página de detalhe do imóvel. A ordem das imagens será automaticamente definida pela ordem das imagens nesta lista. Opcionalmente, o campo "order" pode ser preenchido para especificar uma ordem personalizada. A imagem principal do imóvel será sempre a primeira imagem, em qualquer caso.
nullable: true
virtualTourUrl
string
Tour virtual a mostrar no detalhe do imóvel.
nullable: true
string ^.{0,500}$
buildingName
string
Nome do empreendimento ao qual o imóvel pode pertencer.
nullable: true
string ^.{0,100}$
privateNotes
string
Notas privadas do imóvel. Estas notas privadas podem ser acedidas ao visitar o detalhe do imóvel no Portal CasaYes.
nullable: true
string ^.{0,1000}$
overrideTitle
string
Título alternativo a mostrar no site público antes da descrição.
nullable: true
string ^.{0,100}$
Modelo de Morada
visibility
boolean
Se a morada do imóvel é público. Por defeito, verdadeiro.
street
string
Nome da rua do imóvel.
nullable: true
floor
string
Andar do imóvel.
nullable: true
pattern: -[1-2]|[1-9]|[1-5][0-9]|60|rc|cv|scv|ult
Onde: rc = Rés-do-chão, cv = Cave, scv = Semi-cave, ult = Último piso.
town
string
Nome da cidade do imóvel.
nullable: true
doorNumber
integer ($int32)
Número da porta do imóvel.
nullable: true
zipCode
string
Código postal do imóvel. Obrigatório se não fornecer as coordenadas do imóvel.
nullable: true
string ^.{0,10}$
country
string
País do imóvel. Um de [Portuguese, Spanish, French, English, German, Italian]
coordinates
object
Modelo de Coordenadas de Morada
Coordenadas do imóvel. Obrigatório se não enviar o código postal.
nullable: true
Modelo de Coordenadas de Morada
latitude
number ($double)
Latitude do imóvel. Precisão melhora com mais decimais.
required
number [-90 ... 90]
longitude
number ($double)
Longitude do imóvel. Precisão melhora com mais decimais.
required
number [-180 ... 180]
Modelo de Contacto
name
string
Nome para substituir as informações da agência no site.
nullable: true
email
string ($email)
Email de um utilizador no Portal CasaYes. Este email permite atribuir o imóvel ao utilizador. Se o utilizador não existir, este email irá substituir o email da agência no site.
required
minLength: 1
phonePrefix
integer ($int32)
Prefixo do país para substituir as informações da agência no site.
nullable: true
pattern: ^[1-9][0-9]{1,3}$
phone
integer ($int64)
Telefone para substituir as informações da agência no site.
nullable: true
pattern: ^[1-9][0-9]{4,15}$
Modelo de Atributos
plotArea
integer ($int32)
Área do lote.
nullable: true
builtArea
integer ($int32)
Área bruta.
nullable: true
totalArea
integer ($int32)
Área bruta privativa.
required
usableArea
integer ($int32)
Área útil.
nullable: true
maxConstructionArea
integer ($int32)
Área máxima para construção.
nullable: true
floors
integer ($int32)
Número de pisos.
nullable: true
characteristics
string[]
Lista com características do imóvel.
Lista de [ AirConditioning, EquippedKitchen, Balcony, Terrace, StorageRoom, Garden, SwimmingPool, Heating, ElectricCarsCharging, BoxGarage, OutdoorParking, SharedGarage ]
nullable: true
depositMonths
integer ($int32)
Apenas para arrendamento. Meses de caução exigidos.
nullable: true
parking
boolean
Se existe estacionamento disponível. "Parking" refere-se a "Garagem"; para outros tipos de estacionamento use characteristics.
parkingCapacity
integer ($int32)
Capacidade do estacionamento (garagem). Apenas se parking for verdadeiro.
nullable: true
builtYear
integer ($int32)
Ano de construção do imóvel.
nullable: true
number [999 ... 2100]
conservation
string
Estado de conservação do imóvel.
Um de [ New, Renovated, GoodGeneralConditions, RefreshmentsToPredict, WorkNeeded, WorkInProgress ]
nullable: true
energyCertificateRating
string
Classe energética do imóvel.
Um de [ APlus, A, B, BMinus, C, D, E, F, NA ]
required
energyCertificatePerformance
number ($double)
Desempenho energético do imóvel.
nullable: true
bathrooms
integer ($int32)
Número de casas de banho.
nullable: true
bedrooms
integer ($int32)
Número de quartos.
nullable: true
rooms
integer ($int32)
Número de divisões.
nullable: true
parkingIncludedInPrice
boolean
Se o estacionamento (garagem) está incluído no preço do imóvel. Apenas disponível se parking for verdadeiro.
parkingPrice
number ($decimal)
Valor do estacionamento (garagem). Apenas disponível se parking for verdadeiro e parkingIncludedInPrice for falso.
nullable: true
minimalStay
integer ($int32)
Apenas para arrendamento. Meses mínimos de permanência após o arrendamento.
nullable: true
availableFrom
string ($date-time)
Apenas para arrendamento. Data em que o imóvel ficará disponível.
nullable: true
minAge
integer ($int32)
Apenas para arrendamento. Idade mínima para arrendar.
nullable: true
maxAge
integer ($int32)
Apenas para arrendamento. Idade máxima para arrendar.
nullable: true
bankProperty
boolean
Se o imóvel pertence a um banco. Por defeito, falso.
elevator
boolean
Se o imóvel tem elevador. Por defeito, falso.
landRegister
string
Código do registo predial.
nullable: true
string ^.{0,100}$
treasuryLandRegister
string
Código do registo predial da tesouraria.
nullable: true
string ^.{0,50}$
houseLicensing
string
Apenas para arrendamento.
nullable: true
string ^.{0,150}$
condominiumValue
number ($decimal)
Valor do condomínio.
nullable: true
Modelo da Operação
price
number ($decimal)
Valor do imóvel.
required
privatePrice
boolean
Verdadeiro se o valor do imóvel não deve aparecer no site.
priceGranularity
string
Apenas para arrendamento. Um de [ Daily, Weekly, Annually, Monthly ]
nullable: true
type
string
Tipo de negócio. Um de [ Buy, Lease ]
required
sharingCommission
number ($double)
Valor para o vendedor. Se SharingCommissionType for Percentage, só são permitidos valores entre 0 e 100.
nullable: true
sharingCommissionType
string
Tipo de comissão. Um de [ Percentage, Fixed ]
nullable: true
Modelo das Descrições
language
string
Língua da descrição. Um de [ Portuguese, Spanish, French, English, German, Italian ]
required
mainText
string
Texto da descrição. Se o texto tiver mais de 5000 caracteres, será truncado para 4997 + "..."
required
minLength: 1
string ^.{0,5000}$
Modelo das Divisões
type
string
Tipo da divisão. Um de [ LivingRoom, DiningRoom, Kitchen, Bedroom, Library, Laundry, Bathroom, GamesRoom, PartyRoom, WorkRoom, Loft, Basement ]
required
usableArea
number ($double)
Área útil da divisão.
required
heigth
number ($double)
Altura da divisão.
nullable: true
width
number ($double)
Largura da divisão.
nullable: true
Modelo das Imagens
url
string
Link da imagem.
required
minLength: 1
order
integer ($int32)
Ordem da imagem no site.
nullable: true
Modelos dos Vídeos
url
string
Link do vídeo.
required
minLength: 1
order
integer ($int32)
Ordem do vídeo no site.
nullable: true
language
string
Se desejar, pode mostrar um vídeo apenas para utilizadores que pesquisem no site na língua especificada aqui. Um de [ Portuguese, Spanish, French, English, German, Italian]
nullable: true
Last updated