Imóveis e ativos – construir no Flowtly

Utilize este instantâneo selecionado do esquema OpenAPI do Flowtly para planear integrações, automatizar fluxos de trabalho e sincronizar os dados em que as suas equipas confiam.

Estado da documentação

Última sincronização em 2026-04-03 18:31 (versão da aplicação 2.0.0)

Apenas um subconjunto de entidades é tornado público. Execute ambos os comandos de sincronização para atualizar esta documentação quando a aplicação Flowtly disponibilizar novas capacidades.

Imóveis e ativos

Ativos imobiliários, reservas, contadores e relações comerciais.

Visão geral da entidade

Imóvel

Gerir registos de imóveis com localização, avaliação e ligações a projetos para operações imobiliárias.

Endpoints

GET https://api.flowtly.eu/assets

Listar imóveis

Obtém a coleção de recursos Property.

POST https://api.flowtly.eu/assets

Criar imóvel

Cria um recurso Property.

GET https://api.flowtly.eu/assets/{id}

Obter imóvel por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/assets/{id}

Eliminar imóvel

Eliminar o recurso.

PATCH https://api.flowtly.eu/assets/{id}

Atualizar imóvel

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/properties

Listar imóveis

Obtém a coleção de recursos Property.

POST https://api.flowtly.eu/properties

Criar imóvel

Cria um recurso Property.

GET https://api.flowtly.eu/properties/{id}

Obter imóvel por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/properties/{id}

Eliminar imóvel

Eliminar o recurso.

PATCH https://api.flowtly.eu/properties/{id}

Atualizar imóvel

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/assets/project-relations

Listar relações de projeto

Obtém a coleção de recursos PropertyProjectRelationOutput.

GET https://api.flowtly.eu/properties/project-relations

Listar relações de projeto

Obtém a coleção de recursos PropertyProjectRelationOutput.

Casos de uso

Sincronizar o seu portfólio de imóveis a partir de sistemas externos de gestão de ativos.
Associar imóveis a projetos para acompanhamento de construção ou renovação.

Campos do esquema

PropertyCommercialRelation-property_commercial_relation.read_property.read
Campo Tipo Descrição
id string Campo id.
property reference Campo property.
project string Campo project.
propertyBooking string Campo propertyBooking.
relationType string Campo relationType.
amount string Campo amount.
currency string Campo currency.
dateFrom string Campo dateFrom.
dateTo string Campo dateTo.
invoiceable boolean Campo invoiceable.
note string Campo note.
createdAt string Campo createdAt.
updatedAt string Campo updatedAt.

Visão geral da entidade

Reserva de imóvel

Acompanhar a disponibilidade de imóveis, reservas de inquilinos e estado das reservas.

Endpoints

GET https://api.flowtly.eu/asset-bookings

Listar reservas de imóveis

Obtém a coleção de recursos PropertyBooking.

POST https://api.flowtly.eu/asset-bookings

Criar reserva de imóvel

Cria um recurso PropertyBooking.

GET https://api.flowtly.eu/asset-bookings/{id}

Obter reserva de imóvel por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/asset-bookings/{id}

Atualizar reserva de imóvel

Atualizar campos do recurso utilizando JSON Merge Patch.

POST https://api.flowtly.eu/asset-bookings/{id}/cancel

Cria um recurso PropertyBooking.

Cria um recurso PropertyBooking.

GET https://api.flowtly.eu/property-bookings

Listar reservas de imóveis

Obtém a coleção de recursos PropertyBooking.

POST https://api.flowtly.eu/property-bookings

Criar reserva de imóvel

Cria um recurso PropertyBooking.

GET https://api.flowtly.eu/property-bookings/{id}

Obter reserva de imóvel por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/property-bookings/{id}

Atualizar reserva de imóvel

Atualizar campos do recurso utilizando JSON Merge Patch.

POST https://api.flowtly.eu/property-bookings/{id}/cancel

Cria um recurso PropertyBooking.

Cria um recurso PropertyBooking.

Casos de uso

Sincronizar reservas do seu sistema de gestão de imóveis para relatórios de ocupação.
Criar reservas quando são assinados contratos de arrendamento.

Campos do esquema

PropertyBooking-property_booking.read_property.read
Campo Tipo Descrição
id string Campo id.
employee string | null Campo employee.
property object Campo property.
relationName string Campo relationName.
relationId string Campo relationId.
startDate string Campo startDate.
duration integer | null Campo duration.
cancelReason string | null Campo cancelReason.
cancelledAt string | null Campo cancelledAt.
dateTo string | null Campo dateTo.

Visão geral da entidade

Contador de ativo

Registar contadores (eletricidade, água, gás) e registar leituras para alocação de custos de serviços.

Endpoints

GET https://api.flowtly.eu/asset-meters

Listar contadores de ativos

Obtém a coleção de recursos AssetMeterReading.

POST https://api.flowtly.eu/asset-meters

Criar contador de ativo

Cria um recurso AssetMeterReading.

GET https://api.flowtly.eu/asset-meters/{id}

Obter contador de ativo por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/asset-meters/{id}

Eliminar contador de ativo

Eliminar o recurso.

PATCH https://api.flowtly.eu/asset-meters/{id}

Atualizar contador de ativo

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/asset-meter-readings

Listar contadores de ativos

Obtém a coleção de recursos AssetMeterReading.

POST https://api.flowtly.eu/asset-meter-readings

Criar contador de ativo

Cria um recurso AssetMeterReading.

GET https://api.flowtly.eu/asset-meter-readings/{id}

Obter contador de ativo por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/asset-meter-readings/{id}

Eliminar contador de ativo

Eliminar o recurso.

PATCH https://api.flowtly.eu/asset-meter-readings/{id}

Atualizar contador de ativo

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Importar leituras de contadores a partir de sensores IoT para faturação automatizada.
Acompanhar o consumo de serviços por inquilino para faturação de custos por repercussão.

Campos do esquema

AssetMeterReading-asset_meter_reading.read_asset_meter.read
Campo Tipo Descrição
id string Campo id.
meter reference Campo meter.
readingAt string Campo readingAt.
periodFrom string Campo periodFrom.
periodTo string Campo periodTo.
readingType string Campo readingType.
value string Campo value.
source string Campo source.
sourceReference string Campo sourceReference.
isEstimated boolean Campo isEstimated.
note string Campo note.

Visão geral da entidade

Relação comercial de imóvel

Gerir contratos de arrendamento, dados de inquilinos e termos comerciais para ativos imobiliários.

Endpoints

GET https://api.flowtly.eu/asset-commercial-relations

Listar relações comerciais de imóveis

Obtém a coleção de recursos PropertyCommercialRelation.

POST https://api.flowtly.eu/asset-commercial-relations

Criar relação comercial de imóvel

Cria um recurso PropertyCommercialRelation.

GET https://api.flowtly.eu/asset-commercial-relations/{id}

Obter relação comercial de imóvel por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/asset-commercial-relations/{id}

Eliminar relação comercial de imóvel

Eliminar o recurso.

PATCH https://api.flowtly.eu/asset-commercial-relations/{id}

Atualizar relação comercial de imóvel

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/property-commercial-relations

Listar relações comerciais de imóveis

Obtém a coleção de recursos PropertyCommercialRelation.

POST https://api.flowtly.eu/property-commercial-relations

Criar relação comercial de imóvel

Cria um recurso PropertyCommercialRelation.

GET https://api.flowtly.eu/property-commercial-relations/{id}

Obter relação comercial de imóvel por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/property-commercial-relations/{id}

Eliminar relação comercial de imóvel

Eliminar o recurso.

PATCH https://api.flowtly.eu/property-commercial-relations/{id}

Atualizar relação comercial de imóvel

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Importar contratos de inquilinos do seu sistema de arrendamento.
Acompanhar datas de renovação de arrendamento e cronogramas de escalada de renda.

Campos do esquema

PropertyCommercialRelation-property_commercial_relation.read_property.read
Campo Tipo Descrição
id string Campo id.
property reference Campo property.
project string Campo project.
propertyBooking string Campo propertyBooking.
relationType string Campo relationType.
amount string Campo amount.
currency string Campo currency.
dateFrom string Campo dateFrom.
dateTo string Campo dateTo.
invoiceable boolean Campo invoiceable.
note string Campo note.
createdAt string Campo createdAt.
updatedAt string Campo updatedAt.
Whatsapp