Skip to main content
PATCH
Update rental agreement

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

If-Match
string

Apply the change only while the current ETag matches one of the supplied validators (or *); otherwise the request fails with 412 precondition_failed and nothing is written.

Path Parameters

order_id
string<uuid>
required

UUID of the parent order in this request.

Body

application/json

Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.

contract_date
string<date> | null

Date on which the rental contract was concluded; this is not the tenancy start or move-in date. Required before finalization. Updating it also updates the legal_basis.contract_date of H17/H19 claims in the order.

due_rule
object | null

Rule used to derive H17/H19 rental due dates. Omission preserves the current rule; null restores the default third German business day. Changes recalculate dates except claim-level dates explicitly overridden by the client.

monthly_rent
object | null

Total recurring Warmmiete, including ancillary-cost prepayments; it does not constrain an individual claim amount. May be absent or null while drafting; must be positive before finalization.

property_address
object | null

Complete address of the rented property, even when it matches the debtor address. Supply street, postal_code, city, and country; this creates a separate property address and does not reuse a debtor address id or primary flag. A complete property address is required before finalization.

Response

contract_date
string<date> | null
required
read-only

Date on which the rental contract was concluded; this is not the tenancy start or move-in date.

created_at
string<date-time>
required
read-only

Time at which the rental agreement was created.

documents
object[]
required
read-only

Documents owned by the agreement, including the optional rental-agreement and claim-statement primary slots.

due_rule
object | null
required

Rule used to derive H17/H19 rental due dates. Null means the default third German business day of the rental month applies; explicit claim-level dates override the derived result.

id
string<uuid>
required
read-only

Stable identifier of the rental agreement.

monthly_rent
object | null
required

Total recurring Warmmiete, including ancillary-cost prepayments; it does not constrain an individual claim amount.

property_address
object | null
required

Complete address of the rented property, even when it matches the debtor address.

updated_at
string<date-time>
required
read-only

Time at which the rental agreement last changed.