← Referência da API

Propriedade e Ativos

Propriedades, reservas, ativos e medidores — gerencie dados imobiliários via API.

Propriedade

Endpoints

GET	/assets	Retrieves the collection of Property resources.
POST	/assets	Creates a Property resource.
GET	/assets/{id}	Retrieves a Property resource.
PATCH	/assets/{id}	Updates the Property resource.
DELETE	/assets/{id}	Removes the Property resource.
GET	/assets/{id}/documents	Retrieves a Property resource.
GET	/properties	Retrieves the collection of Property resources.
POST	/properties	Creates a Property resource.
GET	/properties/{id}	Retrieves a Property resource.
PATCH	/properties/{id}	Updates the Property resource.
DELETE	/properties/{id}	Removes the Property resource.
GET	/properties/{id}/documents	Retrieves a Property resource.

Reserva de Propriedade

Endpoints

GET	/asset-bookings	Retrieves the collection of PropertyBooking resources.
POST	/asset-bookings	Creates a PropertyBooking resource.
GET	/asset-bookings/{id}	Retrieves a PropertyBooking resource.
PATCH	/asset-bookings/{id}	Updates the PropertyBooking resource.
POST	/asset-bookings/{id}/cancel	Creates a PropertyBooking resource.
GET	/property-bookings	Retrieves the collection of PropertyBooking resources.
POST	/property-bookings	Creates a PropertyBooking resource.
GET	/property-bookings/{id}	Retrieves a PropertyBooking resource.
PATCH	/property-bookings/{id}	Updates the PropertyBooking resource.
POST	/property-bookings/{id}/cancel	Creates a PropertyBooking resource.

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)

Medidor de Ativo

Endpoints

GET	/asset-meters	Retrieves the collection of AssetMeter resources.
POST	/asset-meters	Creates a AssetMeter resource.
GET	/asset-meters/{id}	Retrieves a AssetMeter resource.
PATCH	/asset-meters/{id}	Updates the AssetMeter resource.
DELETE	/asset-meters/{id}	Removes the AssetMeter resource.

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	Retrieves the collection of PropertyCommercialRelation resources.
POST	/asset-commercial-relations	Creates a PropertyCommercialRelation resource.
GET	/asset-commercial-relations/{id}	Retrieves a PropertyCommercialRelation resource.
PATCH	/asset-commercial-relations/{id}	Updates the PropertyCommercialRelation resource.
DELETE	/asset-commercial-relations/{id}	Removes the PropertyCommercialRelation resource.
GET	/property-commercial-relations	Retrieves the collection of PropertyCommercialRelation resources.
POST	/property-commercial-relations	Creates a PropertyCommercialRelation resource.
GET	/property-commercial-relations/{id}	Retrieves a PropertyCommercialRelation resource.
PATCH	/property-commercial-relations/{id}	Updates the PropertyCommercialRelation resource.
DELETE	/property-commercial-relations/{id}	Removes the PropertyCommercialRelation resource.

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