Propriété & Actifs
Propriétés, réservations, actifs et compteurs — gérez les données immobilières via l'API.
Propriété
Points de terminaison
| GET | /assets | Récupère la collection de ressources Property. |
| POST | /assets | Crée une ressource Property. |
| GET | /assets/{id} | Récupère une ressource Property. |
| PATCH | /assets/{id} | Met à jour la ressource Property. |
| DELETE | /assets/{id} | Supprime la ressource Property. |
| GET | /assets/{id}/documents | Récupère une ressource Property. |
| GET | /properties | Récupère la collection de ressources Property. |
| POST | /properties | Crée une ressource Property. |
| GET | /properties/{id} | Récupère une ressource Property. |
| PATCH | /properties/{id} | Met à jour la ressource Property. |
| DELETE | /properties/{id} | Supprime la ressource Property. |
| GET | /properties/{id}/documents | Récupère une ressource Property. |
Réservation Propriété
Points de terminaison
| GET | /asset-bookings | Récupère la collection de ressources PropertyBooking. |
| POST | /asset-bookings | Crée une ressource PropertyBooking. |
| GET | /asset-bookings/{id} | Récupère une ressource PropertyBooking. |
| PATCH | /asset-bookings/{id} | Met à jour la ressource PropertyBooking. |
| POST | /asset-bookings/{id}/cancel | Crée une ressource PropertyBooking. |
| GET | /property-bookings | Récupère la collection de ressources PropertyBooking. |
| POST | /property-bookings | Crée une ressource PropertyBooking. |
| GET | /property-bookings/{id} | Récupère une ressource PropertyBooking. |
| PATCH | /property-bookings/{id} | Met à jour la ressource PropertyBooking. |
| POST | /property-bookings/{id}/cancel | Crée une ressource PropertyBooking. |
Champs de schéma
| Champ | 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) |
Compteur Actif
Points de terminaison
| GET | /asset-meters | Récupère la collection de ressources AssetMeter. |
| POST | /asset-meters | Crée une ressource AssetMeter. |
| GET | /asset-meters/{id} | Récupère une ressource AssetMeter. |
| PATCH | /asset-meters/{id} | Met à jour la ressource AssetMeter. |
| DELETE | /asset-meters/{id} | Supprime la ressource AssetMeter. |
Champs de schéma
| Champ | Type | Description |
|---|---|---|
| property* | string (iri-reference) | |
| name* | string | |
| utilityType* | string | |
| unit* | string | |
| readingMode* | string | |
| externalId | stringnull | |
| isActive | boolean | |
| note | stringnull |
Relation Commerciale Propriété
Points de terminaison
| GET | /asset-commercial-relations | Récupère la collection de ressources PropertyCommercialRelation. |
| POST | /asset-commercial-relations | Crée une ressource PropertyCommercialRelation. |
| GET | /asset-commercial-relations/{id} | Récupère une ressource PropertyCommercialRelation. |
| PATCH | /asset-commercial-relations/{id} | Met à jour la ressource PropertyCommercialRelation. |
| DELETE | /asset-commercial-relations/{id} | Supprime la ressource PropertyCommercialRelation. |
| GET | /property-commercial-relations | Récupère la collection de ressources PropertyCommercialRelation. |
| POST | /property-commercial-relations | Crée une ressource PropertyCommercialRelation. |
| GET | /property-commercial-relations/{id} | Récupère une ressource PropertyCommercialRelation. |
| PATCH | /property-commercial-relations/{id} | Met à jour la ressource PropertyCommercialRelation. |
| DELETE | /property-commercial-relations/{id} | Supprime la ressource PropertyCommercialRelation. |
Champs de schéma
| Champ | 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 |