Property & assets – build on Flowtly

Use this curated snapshot of the Flowtly OpenAPI schema to plan integrations, automate workflows, and sync the data your teams rely on.

Documentation status

Last synced on 2026-04-03 18:31 (app version 2.0.0)

Only a subset of entities is made public. Run both sync commands to refresh this documentation when the Flowtly app ships new capabilities.

Property & assets

Real estate assets, bookings, meters, and commercial relations.

Entity overview

Property

Manage property records with location, valuation, and project linkages for real estate operations.

Endpoints

GET https://api.flowtly.eu/assets

List propertys

Retrieves the collection of Property resources.

POST https://api.flowtly.eu/assets

Create property

Creates a Property resource.

GET https://api.flowtly.eu/assets/{id}

Get property by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/assets/{id}

Delete property

Remove the resource.

PATCH https://api.flowtly.eu/assets/{id}

Update property

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/properties

List propertys

Retrieves the collection of Property resources.

POST https://api.flowtly.eu/properties

Create property

Creates a Property resource.

GET https://api.flowtly.eu/properties/{id}

Get property by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/properties/{id}

Delete property

Remove the resource.

PATCH https://api.flowtly.eu/properties/{id}

Update property

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/assets/project-relations

List project relations

Retrieves the collection of PropertyProjectRelationOutput resources.

GET https://api.flowtly.eu/properties/project-relations

List project relations

Retrieves the collection of PropertyProjectRelationOutput resources.

Use cases

Sync your property portfolio from external asset management systems.
Link properties to projects for construction or renovation tracking.

Schema fields

PropertyCommercialRelation-property_commercial_relation.read_property.read
Field Type Description
id string id field.
property reference property field.
project string project field.
propertyBooking string propertyBooking field.
relationType string relationType field.
amount string amount field.
currency string currency field.
dateFrom string dateFrom field.
dateTo string dateTo field.
invoiceable boolean invoiceable field.
note string note field.
createdAt string createdAt field.
updatedAt string updatedAt field.

Entity overview

Property booking

Track property availability, tenant bookings, and reservation status.

Endpoints

GET https://api.flowtly.eu/asset-bookings

List property bookings

Retrieves the collection of PropertyBooking resources.

POST https://api.flowtly.eu/asset-bookings

Create property booking

Creates a PropertyBooking resource.

GET https://api.flowtly.eu/asset-bookings/{id}

Get property booking by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/asset-bookings/{id}

Update property booking

Update resource fields using JSON Merge Patch.

POST https://api.flowtly.eu/asset-bookings/{id}/cancel

Creates a PropertyBooking resource.

Creates a PropertyBooking resource.

GET https://api.flowtly.eu/property-bookings

List property bookings

Retrieves the collection of PropertyBooking resources.

POST https://api.flowtly.eu/property-bookings

Create property booking

Creates a PropertyBooking resource.

GET https://api.flowtly.eu/property-bookings/{id}

Get property booking by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/property-bookings/{id}

Update property booking

Update resource fields using JSON Merge Patch.

POST https://api.flowtly.eu/property-bookings/{id}/cancel

Creates a PropertyBooking resource.

Creates a PropertyBooking resource.

Use cases

Sync bookings from your property management system for occupancy reporting.
Create reservations when lease agreements are signed.

Schema fields

PropertyBooking-property_booking.read_property.read
Field Type Description
id string id field.
employee string | null employee field.
property object property field.
relationName string relationName field.
relationId string relationId field.
startDate string startDate field.
duration integer | null duration field.
cancelReason string | null cancelReason field.
cancelledAt string | null cancelledAt field.
dateTo string | null dateTo field.

Entity overview

Asset meter

Register meters (electricity, water, gas) and record readings for utility cost allocation.

Endpoints

GET https://api.flowtly.eu/asset-meters

List asset meters

Retrieves the collection of AssetMeterReading resources.

POST https://api.flowtly.eu/asset-meters

Create asset meter

Creates a AssetMeterReading resource.

GET https://api.flowtly.eu/asset-meters/{id}

Get asset meter by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/asset-meters/{id}

Delete asset meter

Remove the resource.

PATCH https://api.flowtly.eu/asset-meters/{id}

Update asset meter

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/asset-meter-readings

List asset meters

Retrieves the collection of AssetMeterReading resources.

POST https://api.flowtly.eu/asset-meter-readings

Create asset meter

Creates a AssetMeterReading resource.

GET https://api.flowtly.eu/asset-meter-readings/{id}

Get asset meter by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/asset-meter-readings/{id}

Delete asset meter

Remove the resource.

PATCH https://api.flowtly.eu/asset-meter-readings/{id}

Update asset meter

Update resource fields using JSON Merge Patch.

Use cases

Import meter readings from IoT sensors for automated billing.
Track utility consumption per tenant for cost pass-through invoicing.

Schema fields

AssetMeterReading-asset_meter_reading.read_asset_meter.read
Field Type Description
id string id field.
meter reference meter field.
readingAt string readingAt field.
periodFrom string periodFrom field.
periodTo string periodTo field.
readingType string readingType field.
value string value field.
source string source field.
sourceReference string sourceReference field.
isEstimated boolean isEstimated field.
note string note field.

Entity overview

Property commercial relation

Manage lease agreements, tenant data, and commercial terms for property assets.

Endpoints

GET https://api.flowtly.eu/asset-commercial-relations

List property commercial relations

Retrieves the collection of PropertyCommercialRelation resources.

POST https://api.flowtly.eu/asset-commercial-relations

Create property commercial relation

Creates a PropertyCommercialRelation resource.

GET https://api.flowtly.eu/asset-commercial-relations/{id}

Get property commercial relation by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/asset-commercial-relations/{id}

Delete property commercial relation

Remove the resource.

PATCH https://api.flowtly.eu/asset-commercial-relations/{id}

Update property commercial relation

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/property-commercial-relations

List property commercial relations

Retrieves the collection of PropertyCommercialRelation resources.

POST https://api.flowtly.eu/property-commercial-relations

Create property commercial relation

Creates a PropertyCommercialRelation resource.

GET https://api.flowtly.eu/property-commercial-relations/{id}

Get property commercial relation by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/property-commercial-relations/{id}

Delete property commercial relation

Remove the resource.

PATCH https://api.flowtly.eu/property-commercial-relations/{id}

Update property commercial relation

Update resource fields using JSON Merge Patch.

Use cases

Import tenant contracts from your leasing system.
Track lease renewal dates and rent escalation schedules.

Schema fields

PropertyCommercialRelation-property_commercial_relation.read_property.read
Field Type Description
id string id field.
property reference property field.
project string project field.
propertyBooking string propertyBooking field.
relationType string relationType field.
amount string amount field.
currency string currency field.
dateFrom string dateFrom field.
dateTo string dateTo field.
invoiceable boolean invoiceable field.
note string note field.
createdAt string createdAt field.
updatedAt string updatedAt field.
Whatsapp