Propriedade e Ativos

Imóveis, reservas, ativos, contadores e leituras — gira dados imobiliários através da API.

Propriedade

Endpoints

GET	/assets	Recupera a coleção de recursos Property.
POST	/assets	Cria um recurso Property.
GET	/assets/{id}	Recupera um recurso Property.
PATCH	/assets/{id}	Atualiza o recurso Property.
DELETE	/assets/{id}	Remove o recurso Property.
GET	/assets/{id}/documents	Recupera um recurso Property.
GET	/properties	Recupera a coleção de recursos Property.
POST	/properties	Cria um recurso Property.
GET	/properties/{id}	Recupera um recurso Property.
PATCH	/properties/{id}	Atualiza o recurso Property.
DELETE	/properties/{id}	Remove o recurso Property.
GET	/properties/{id}/documents	Recupera um recurso Property.

Reserva de Propriedade

Endpoints

GET	/asset-bookings	Recupera a coleção de recursos PropertyBooking.
POST	/asset-bookings	Cria um recurso PropertyBooking.
GET	/asset-bookings/{id}	Recupera um recurso PropertyBooking.
PATCH	/asset-bookings/{id}	Atualiza o recurso PropertyBooking.
POST	/asset-bookings/{id}/cancel	Cria um recurso PropertyBooking.
GET	/property-bookings	Recupera a coleção de recursos PropertyBooking.
POST	/property-bookings	Cria um recurso PropertyBooking.
GET	/property-bookings/{id}	Recupera um recurso PropertyBooking.
PATCH	/property-bookings/{id}	Atualiza o recurso PropertyBooking.
POST	/property-bookings/{id}/cancel	Cria um recurso PropertyBooking.

Campos de schema

Campo	Tipo	Descrição
id	string
employee	string,null (iri-reference)
property*	object
relationName*	string
relationId*	string
startDate	string (date-time)
duration	integernull
billingAmount	stringnull
billingCurrency	string,null (iri-reference)
endDate	string,null (date-time)
cancelReason	stringnull
cancelledAt	string,null (date-time)
dateTo	string,null (date-time)	The booking's end, or NULL when it is unknown.

Medidor de Ativo

Endpoints

GET	/asset-meters	Recupera a coleção de recursos AssetMeter.
POST	/asset-meters	Cria um recurso AssetMeter.
GET	/asset-meters/{id}	Recupera um recurso AssetMeter.
PATCH	/asset-meters/{id}	Atualiza o recurso AssetMeter.
DELETE	/asset-meters/{id}	Remove o recurso AssetMeter.

Campos de schema

Campo	Tipo	Descrição
property*	string (iri-reference)
name*	string
utilityType*	string
unit*	string
readingMode*	string
externalId	stringnull
isActive	boolean
note	stringnull

Relação Comercial de Propriedade

Endpoints

GET	/asset-commercial-relations	Recupera a coleção de recursos PropertyCommercialRelation.
POST	/asset-commercial-relations	Cria um recurso PropertyCommercialRelation.
GET	/asset-commercial-relations/{id}	Recupera um recurso PropertyCommercialRelation.
PATCH	/asset-commercial-relations/{id}	Atualiza o recurso PropertyCommercialRelation.
DELETE	/asset-commercial-relations/{id}	Remove o recurso PropertyCommercialRelation.
GET	/property-commercial-relations	Recupera a coleção de recursos PropertyCommercialRelation.
POST	/property-commercial-relations	Cria um recurso PropertyCommercialRelation.
GET	/property-commercial-relations/{id}	Recupera um recurso PropertyCommercialRelation.
PATCH	/property-commercial-relations/{id}	Atualiza o recurso PropertyCommercialRelation.
DELETE	/property-commercial-relations/{id}	Remove o recurso PropertyCommercialRelation.

Campos de schema

Campo	Tipo	Descrição
property	string (iri-reference)
project	string (iri-reference)
propertyBooking	string,null (iri-reference)
relationType	string
amount	string
currency	string (iri-reference)
dateFrom	string,null (date-time)
dateTo	string,null (date-time)
invoiceable	boolean
note	stringnull

Leitura de Contador do Ativo

Endpoints

GET	/asset-meter-readings	Recupera a coleção de recursos AssetMeterReading.
POST	/asset-meter-readings	Cria um recurso AssetMeterReading.
GET	/asset-meter-readings/{id}	Recupera um recurso AssetMeterReading.
PATCH	/asset-meter-readings/{id}	Atualiza o recurso AssetMeterReading.
DELETE	/asset-meter-readings/{id}	Remove o recurso AssetMeterReading.
POST	/asset-meter-readings/analyze	Cria um recurso AssetMeterReading.
POST	/asset-meter-readings/analyze-photo	Cria um recurso AssetMeterReading.
POST	/asset-meter-readings/apply-rows	Cria um recurso AssetMeterReading.
POST	/asset-meter-readings/import	Cria um recurso AssetMeterReading.

Campos de schema

Campo	Tipo	Descrição
id	string
meter*	string (iri-reference)
readingAt*	string (date-time)
periodFrom	string,null (date-time)
periodTo	string,null (date-time)
readingType*	string
value*	string
source	stringnull
sourceReference	stringnull
isEstimated	boolean
note	stringnull
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
possibleReadingTypes	string
estimated	boolean
deleted	boolean	Check if the entity has been soft deleted.

Código QR do Ativo

Endpoints

GET	/asset-qr-codes	Recupera a coleção de recursos AssetQrCode.
POST	/asset-qr-codes	Cria um recurso AssetQrCode.
GET	/asset-qr-codes/{id}	Recupera um recurso AssetQrCode.
PATCH	/asset-qr-codes/{id}	Atualiza o recurso AssetQrCode.

Campos de schema

Campo	Tipo	Descrição
asset	string (iri-reference)
kind	string
visibility	string
label	stringnull