Nieruchomości i majątek
Nieruchomości, rezerwacje, zasoby, liczniki i odczyty — zarządzaj danymi nieruchomości przez API.
Nieruchomość
Endpoints
| GET | /assets | Pobiera kolekcję zasobów Property. |
| POST | /assets | Tworzy zasób Property. |
| GET | /assets/{id} | Pobiera zasób Property. |
| PATCH | /assets/{id} | Aktualizuje zasób Property. |
| DELETE | /assets/{id} | Usuwa zasób Property. |
| GET | /assets/{id}/documents | Pobiera zasób Property. |
| GET | /properties | Pobiera kolekcję zasobów Property. |
| POST | /properties | Tworzy zasób Property. |
| GET | /properties/{id} | Pobiera zasób Property. |
| PATCH | /properties/{id} | Aktualizuje zasób Property. |
| DELETE | /properties/{id} | Usuwa zasób Property. |
| GET | /properties/{id}/documents | Pobiera zasób Property. |
Rezerwacja nieruchomości
Endpoints
| GET | /asset-bookings | Pobiera kolekcję zasobów PropertyBooking. |
| POST | /asset-bookings | Tworzy zasób PropertyBooking. |
| GET | /asset-bookings/{id} | Pobiera zasób PropertyBooking. |
| PATCH | /asset-bookings/{id} | Aktualizuje zasób PropertyBooking. |
| POST | /asset-bookings/{id}/cancel | Tworzy zasób PropertyBooking. |
| GET | /property-bookings | Pobiera kolekcję zasobów PropertyBooking. |
| POST | /property-bookings | Tworzy zasób PropertyBooking. |
| GET | /property-bookings/{id} | Pobiera zasób PropertyBooking. |
| PATCH | /property-bookings/{id} | Aktualizuje zasób PropertyBooking. |
| POST | /property-bookings/{id}/cancel | Tworzy zasób PropertyBooking. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| 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) |
Licznik zasobów
Endpoints
| GET | /asset-meters | Pobiera kolekcję zasobów AssetMeter. |
| POST | /asset-meters | Tworzy zasób AssetMeter. |
| GET | /asset-meters/{id} | Pobiera zasób AssetMeter. |
| PATCH | /asset-meters/{id} | Aktualizuje zasób AssetMeter. |
| DELETE | /asset-meters/{id} | Usuwa zasób AssetMeter. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| property* | string (iri-reference) | |
| name* | string | |
| utilityType* | string | |
| unit* | string | |
| readingMode* | string | |
| externalId | stringnull | |
| isActive | boolean | |
| note | stringnull |
Relacja handlowa nieruchomości
Endpoints
| GET | /asset-commercial-relations | Pobiera kolekcję zasobów PropertyCommercialRelation. |
| POST | /asset-commercial-relations | Tworzy zasób PropertyCommercialRelation. |
| GET | /asset-commercial-relations/{id} | Pobiera zasób PropertyCommercialRelation. |
| PATCH | /asset-commercial-relations/{id} | Aktualizuje zasób PropertyCommercialRelation. |
| DELETE | /asset-commercial-relations/{id} | Usuwa zasób PropertyCommercialRelation. |
| GET | /property-commercial-relations | Pobiera kolekcję zasobów PropertyCommercialRelation. |
| POST | /property-commercial-relations | Tworzy zasób PropertyCommercialRelation. |
| GET | /property-commercial-relations/{id} | Pobiera zasób PropertyCommercialRelation. |
| PATCH | /property-commercial-relations/{id} | Aktualizuje zasób PropertyCommercialRelation. |
| DELETE | /property-commercial-relations/{id} | Usuwa zasób PropertyCommercialRelation. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| 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 |
Odczyt licznika zasobu
Endpoints
| GET | /asset-meter-readings | Pobiera kolekcję zasobów AssetMeterReading. |
| POST | /asset-meter-readings | Tworzy zasób AssetMeterReading. |
| GET | /asset-meter-readings/{id} | Pobiera zasób AssetMeterReading. |
| PATCH | /asset-meter-readings/{id} | Aktualizuje zasób AssetMeterReading. |
| DELETE | /asset-meter-readings/{id} | Usuwa zasób AssetMeterReading. |
| POST | /asset-meter-readings/analyze | Tworzy zasób AssetMeterReading. |
| POST | /asset-meter-readings/analyze-photo | Tworzy zasób AssetMeterReading. |
| POST | /asset-meter-readings/apply-rows | Tworzy zasób AssetMeterReading. |
| POST | /asset-meter-readings/import | Tworzy zasób AssetMeterReading. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| 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. |
Kod QR zasobu
Endpoints
| GET | /asset-qr-codes | Pobiera kolekcję zasobów AssetQrCode. |
| POST | /asset-qr-codes | Tworzy zasób AssetQrCode. |
| GET | /asset-qr-codes/{id} | Pobiera zasób AssetQrCode. |
| PATCH | /asset-qr-codes/{id} | Aktualizuje zasób AssetQrCode. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| asset | string (iri-reference) | |
| kind | string | |
| visibility | string | |
| label | stringnull |