Property & assets

Properties, bookings, assets, meters and readings — manage real-estate data via the API.

Property

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.

Property Booking

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.

Schema fields

Field	Type	Description
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)

Asset Meter

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.

Schema fields

Field	Type	Description
property*	string (iri-reference)
name*	string
utilityType*	string
unit*	string
readingMode*	string
externalId	stringnull
isActive	boolean
note	stringnull

Property Commercial Relation

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.

Schema fields

Field	Type	Description
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

Asset Meter Reading

Endpoints

GET	/asset-meter-readings	Retrieves the collection of AssetMeterReading resources.
POST	/asset-meter-readings	Creates a AssetMeterReading resource.
GET	/asset-meter-readings/{id}	Retrieves a AssetMeterReading resource.
PATCH	/asset-meter-readings/{id}	Updates the AssetMeterReading resource.
DELETE	/asset-meter-readings/{id}	Removes the AssetMeterReading resource.
POST	/asset-meter-readings/analyze	Creates a AssetMeterReading resource.
POST	/asset-meter-readings/analyze-photo	Creates a AssetMeterReading resource.
POST	/asset-meter-readings/apply-rows	Creates a AssetMeterReading resource.
POST	/asset-meter-readings/import	Creates a AssetMeterReading resource.

Schema fields

Field	Type	Description
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.

Asset QR Code

Endpoints

GET	/asset-qr-codes	Retrieves the collection of AssetQrCode resources.
POST	/asset-qr-codes	Creates a AssetQrCode resource.
GET	/asset-qr-codes/{id}	Retrieves a AssetQrCode resource.
PATCH	/asset-qr-codes/{id}	Updates the AssetQrCode resource.

Schema fields

Field	Type	Description
asset	string (iri-reference)
kind	string
visibility	string
label	stringnull