Create Unit Contract

Create Unit Contract

Creates a new unit contract from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Account Permission: ManageUnit (91)

This will be evaluated against your used access token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Identifier of the unit contract at its property management company, which isn't necessarily unique.
Usually comes from the ERP system.

date-time | null

Move-in date, from which on the contract is current.
An empty value counts as already started.
Only holds a date, which is returned as midnight in Europe/Berlin converted to UTC, e.g. 1 May 2024 as 2024-04-30T22:00:00Z.
More info: Dates and Times

date-time | null

Move-out date, until which the contract is current.
An empty value counts as not ended.
Only holds a date, like effectiveFrom.
More info: Dates and Times

int32
required

The party holding the contract, e.g. the tenant or owner of the unit.

int32
required

The unit this unit contract belongs to.

int32
required

Reference to the UnitContractType, e.g. 3 for owner or 4 for tenant.
More info: Parties and Accounts

string | null

External ID of the unit contract, unique among the unit contracts of the creator party.
More info: External IDs

Headers
string
Defaults to en-DE

Language preference header. Allowed languages: German (en-DE).

string
Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

Responses

401

Error: Unauthorized

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json