Proprietà e asset

Immobili, prenotazioni, asset, contatori e letture — gestisci i dati immobiliari tramite l'API.

Questo riferimento è generato dallo schema API. Le descrizioni dei campi e qualsiasi testo non ancora tradotto sono mostrati in inglese.

Proprietà

Endpoint

Proprietà: Endpoint
Metodo	Percorso	Descrizione
GET	/assets	Recupera la raccolta di risorse Property.
POST	/assets	Crea una risorsa Property.
GET	/assets/{id}	Recupera una risorsa Property.
PATCH	/assets/{id}	Aggiorna la risorsa Property.
DELETE	/assets/{id}	Rimuove la risorsa Property.
GET	/assets/{id}/documents	Recupera una risorsa Property.
GET	/properties	Recupera la raccolta di risorse Property.
POST	/properties	Crea una risorsa Property.
GET	/properties/{id}	Recupera una risorsa Property.
PATCH	/properties/{id}	Aggiorna la risorsa Property.
DELETE	/properties/{id}	Rimuove la risorsa Property.
GET	/properties/{id}/documents	Recupera una risorsa Property.

Prenotazione Proprietà

Endpoint

Prenotazione Proprietà: Endpoint
Metodo	Percorso	Descrizione
GET	/asset-bookings	Recupera la raccolta di risorse PropertyBooking.
POST	/asset-bookings	Crea una risorsa PropertyBooking.
GET	/asset-bookings/{id}	Recupera una risorsa PropertyBooking.
PATCH	/asset-bookings/{id}	Aggiorna la risorsa PropertyBooking.
POST	/asset-bookings/{id}/cancel	Crea una risorsa PropertyBooking.
GET	/property-bookings	Recupera la raccolta di risorse PropertyBooking.
POST	/property-bookings	Crea una risorsa PropertyBooking.
GET	/property-bookings/{id}	Recupera una risorsa PropertyBooking.
PATCH	/property-bookings/{id}	Aggiorna la risorsa PropertyBooking.
POST	/property-bookings/{id}/cancel	Crea una risorsa PropertyBooking.

Campi schema

Prenotazione Proprietà: Campi schema
Campo	Tipo	Descrizione
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)
consumptionSharePercent	stringnull	This booking's share of the asset's metered consumption, 0–100.
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.

Contatore Asset

Endpoint

Contatore Asset: Endpoint
Metodo	Percorso	Descrizione
GET	/asset-meters	Recupera la raccolta di risorse AssetMeter.
POST	/asset-meters	Crea una risorsa AssetMeter.
GET	/asset-meters/{id}	Recupera una risorsa AssetMeter.
PATCH	/asset-meters/{id}	Aggiorna la risorsa AssetMeter.
DELETE	/asset-meters/{id}	Rimuove la risorsa AssetMeter.

Campi schema

Contatore Asset: Campi schema
Campo	Tipo	Descrizione
property*	string (iri-reference)
name*	string
utilityType*	string
unit*	string
readingMode*	string
externalId	stringnull
isActive	boolean
note	stringnull

Relazione Commerciale Proprietà

Endpoint

Relazione Commerciale Proprietà: Endpoint
Metodo	Percorso	Descrizione
GET	/asset-commercial-relations	Recupera la raccolta di risorse PropertyCommercialRelation.
POST	/asset-commercial-relations	Crea una risorsa PropertyCommercialRelation.
GET	/asset-commercial-relations/{id}	Recupera una risorsa PropertyCommercialRelation.
PATCH	/asset-commercial-relations/{id}	Aggiorna la risorsa PropertyCommercialRelation.
DELETE	/asset-commercial-relations/{id}	Rimuove la risorsa PropertyCommercialRelation.
GET	/property-commercial-relations	Recupera la raccolta di risorse PropertyCommercialRelation.
POST	/property-commercial-relations	Crea una risorsa PropertyCommercialRelation.
GET	/property-commercial-relations/{id}	Recupera una risorsa PropertyCommercialRelation.
PATCH	/property-commercial-relations/{id}	Aggiorna la risorsa PropertyCommercialRelation.
DELETE	/property-commercial-relations/{id}	Rimuove la risorsa PropertyCommercialRelation.

Campi schema

Relazione Commerciale Proprietà: Campi schema
Campo	Tipo	Descrizione
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

Lettura contatore asset

Endpoint

Lettura contatore asset: Endpoint
Metodo	Percorso	Descrizione
GET	/asset-meter-readings	Recupera la raccolta di risorse AssetMeterReading.
POST	/asset-meter-readings	Crea una risorsa AssetMeterReading.
GET	/asset-meter-readings/{id}	Recupera una risorsa AssetMeterReading.
PATCH	/asset-meter-readings/{id}	Aggiorna la risorsa AssetMeterReading.
DELETE	/asset-meter-readings/{id}	Rimuove la risorsa AssetMeterReading.
POST	/asset-meter-readings/analyze	Crea una risorsa AssetMeterReading.
POST	/asset-meter-readings/analyze-photo	Crea una risorsa AssetMeterReading.
POST	/asset-meter-readings/apply-rows	Crea una risorsa AssetMeterReading.
POST	/asset-meter-readings/import	Crea una risorsa AssetMeterReading.

Campi schema

Lettura contatore asset: Campi schema
Campo	Tipo	Descrizione
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.

Codice QR asset

Endpoint

Codice QR asset: Endpoint
Metodo	Percorso	Descrizione
GET	/asset-qr-codes	Recupera la raccolta di risorse AssetQrCode.
POST	/asset-qr-codes	Crea una risorsa AssetQrCode.
GET	/asset-qr-codes/{id}	Recupera una risorsa AssetQrCode.
PATCH	/asset-qr-codes/{id}	Aggiorna la risorsa AssetQrCode.

Campi schema

Codice QR asset: Campi schema
Campo	Tipo	Descrizione
asset	string (iri-reference)
kind	string
visibility	string
label	stringnull