Власність та активи
Об'єкти нерухомості, бронювання, активи, лічильники та показники — керуйте даними нерухомості через API.
Об'єкт нерухомості
Endpoints
| GET | /assets | Отримує колекцію ресурсів Property. |
| POST | /assets | Створює ресурс Property. |
| GET | /assets/{id} | Отримує ресурс Property. |
| PATCH | /assets/{id} | Оновлює ресурс Property. |
| DELETE | /assets/{id} | Видаляє ресурс Property. |
| GET | /assets/{id}/documents | Отримує ресурс Property. |
| GET | /properties | Отримує колекцію ресурсів Property. |
| POST | /properties | Створює ресурс Property. |
| GET | /properties/{id} | Отримує ресурс Property. |
| PATCH | /properties/{id} | Оновлює ресурс Property. |
| DELETE | /properties/{id} | Видаляє ресурс Property. |
| GET | /properties/{id}/documents | Отримує ресурс Property. |
Бронювання об'єкта
Endpoints
| GET | /asset-bookings | Отримує колекцію ресурсів PropertyBooking. |
| POST | /asset-bookings | Створює ресурс PropertyBooking. |
| GET | /asset-bookings/{id} | Отримує ресурс PropertyBooking. |
| PATCH | /asset-bookings/{id} | Оновлює ресурс PropertyBooking. |
| POST | /asset-bookings/{id}/cancel | Створює ресурс PropertyBooking. |
| GET | /property-bookings | Отримує колекцію ресурсів PropertyBooking. |
| POST | /property-bookings | Створює ресурс PropertyBooking. |
| GET | /property-bookings/{id} | Отримує ресурс PropertyBooking. |
| PATCH | /property-bookings/{id} | Оновлює ресурс PropertyBooking. |
| POST | /property-bookings/{id}/cancel | Створює ресурс PropertyBooking. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| 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) |
Лічильник активу
Endpoints
| GET | /asset-meters | Отримує колекцію ресурсів AssetMeter. |
| POST | /asset-meters | Створює ресурс AssetMeter. |
| GET | /asset-meters/{id} | Отримує ресурс AssetMeter. |
| PATCH | /asset-meters/{id} | Оновлює ресурс AssetMeter. |
| DELETE | /asset-meters/{id} | Видаляє ресурс AssetMeter. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| property* | string (iri-reference) | |
| name* | string | |
| utilityType* | string | |
| unit* | string | |
| readingMode* | string | |
| externalId | stringnull | |
| isActive | boolean | |
| note | stringnull |
Комерційна угода з об'єктом
Endpoints
| GET | /asset-commercial-relations | Отримує колекцію ресурсів PropertyCommercialRelation. |
| POST | /asset-commercial-relations | Створює ресурс PropertyCommercialRelation. |
| GET | /asset-commercial-relations/{id} | Отримує ресурс PropertyCommercialRelation. |
| PATCH | /asset-commercial-relations/{id} | Оновлює ресурс PropertyCommercialRelation. |
| DELETE | /asset-commercial-relations/{id} | Видаляє ресурс PropertyCommercialRelation. |
| GET | /property-commercial-relations | Отримує колекцію ресурсів PropertyCommercialRelation. |
| POST | /property-commercial-relations | Створює ресурс PropertyCommercialRelation. |
| GET | /property-commercial-relations/{id} | Отримує ресурс PropertyCommercialRelation. |
| PATCH | /property-commercial-relations/{id} | Оновлює ресурс PropertyCommercialRelation. |
| DELETE | /property-commercial-relations/{id} | Видаляє ресурс PropertyCommercialRelation. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| 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 |
Показник лічильника активу
Endpoints
| GET | /asset-meter-readings | Отримує колекцію ресурсів AssetMeterReading. |
| POST | /asset-meter-readings | Створює ресурс AssetMeterReading. |
| GET | /asset-meter-readings/{id} | Отримує ресурс AssetMeterReading. |
| PATCH | /asset-meter-readings/{id} | Оновлює ресурс AssetMeterReading. |
| DELETE | /asset-meter-readings/{id} | Видаляє ресурс AssetMeterReading. |
| POST | /asset-meter-readings/analyze | Створює ресурс AssetMeterReading. |
| POST | /asset-meter-readings/analyze-photo | Створює ресурс AssetMeterReading. |
| POST | /asset-meter-readings/apply-rows | Створює ресурс AssetMeterReading. |
| POST | /asset-meter-readings/import | Створює ресурс AssetMeterReading. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| 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. |
QR-код активу
Endpoints
| GET | /asset-qr-codes | Отримує колекцію ресурсів AssetQrCode. |
| POST | /asset-qr-codes | Створює ресурс AssetQrCode. |
| GET | /asset-qr-codes/{id} | Отримує ресурс AssetQrCode. |
| PATCH | /asset-qr-codes/{id} | Оновлює ресурс AssetQrCode. |
Поля схеми
| Поле | Тип | Опис |
|---|---|---|
| asset | string (iri-reference) | |
| kind | string | |
| visibility | string | |
| label | stringnull |