Roadmap: ERPs that write
The Partner API is read-only today. This page describes what we are building so that an ERP can also write occupancies (who lives in which unit, from when to when). Nothing on this page can be called today, and there are no dates. What the API does today is in the ERP guide and the Reference.
Two statuses, no dates. In progress means we are building it now. With the first write partner means we build it together with the first ERP that writes occupancies, and the details are settled with that partner. Until a building block appears in the changelog and the OpenAPI document, it does not exist.
Who owns which data
This is a fixed commitment, and the building blocks below follow from it.
| Data | Owner |
|---|---|
| Measurement data: devices, measuring points, meter readings, consumption | messpunkt.io, always |
| Occupancy: resident name, move-in, move-out, optionally an e-mail address for the invitation to the resident portal | the ERP, once the landlord grants that ERP write access for a Property; otherwise messpunkt.io |
- Exactly one owner per Property. For each Property, either messpunkt.io or one ERP owns the occupancy, never both.
- The landlord's consent is the switch. When the landlord grants your ERP write access for a Property, your ERP owns its occupancy. When the landlord disconnects, ownership returns to messpunkt.io.
- While your ERP owns a Property, tenant changes for it are blocked in the messpunkt.io portal and chat. messpunkt.io operations can step in for an emergency; your ERP learns about it through the event feed.
- The resident's portal access stays with messpunkt.io. It is derived from the move-out date your ERP writes.
Building blocks
| Building block | What it is | Status |
|---|---|---|
Event feedGET /v1/events | A cursor-based list of events without payload: type, resource ID, time. You read the details through the existing read endpoints. Event types along the lines of consumption.available, device.replaced, measuring_point.created, measuring_point.removed, occupancy.changed. | In progress |
| Closed billing periods | Data in a billing period that has been closed can no longer be changed. | In progress |
| Writing occupancies | Move-in, move-out and corrections, written by the ERP that owns the Property. | With the first write partner |
external_ref | Your ERP's own identifier on usage units and occupancies. Today the field is always null. | With the first write partner |
| Handover from a cut-off date | Your ERP takes over a Property's occupancy from a cut-off date and links its own records to ours itself. | With the first write partner |
| Webhooks | A signed nudge without payload: “there are new events”. You then read the event feed. | With the first write partner |
Semantics you can prepare for
Whatever the details turn out to be, writing will follow these rules:
Idempotency-Keyis mandatory on every write call.If-Matchwith theETagis mandatory on every call that changes a resource. A stale state is answered with412 Precondition Failed.409billing_period_closed: the data falls into a billing period that is closed.409before_handover: the occupancy lies before the cut-off date from which your ERP owns the Property.- History before the cut-off date stays unchanged.
Write with us
You want to write occupancies? Write to kontakt@messpunkt.io — the first partner shapes the interface.