FoyerDevelopers

Generated · Live registry

vermietungAnfragen tools

6 tools in this domain, generated from the running registry.

All tool domains

vermietungAnfragen.ablehnen

writes

Rejects a request: status abgelehnt, open offers are withdrawn, and the prospective tenant receives a rejection (including nachricht, at most 4000 characters, if given). A paid, already rejected or withdrawn request results in CONFLICT, a request of another tenant in NOT_FOUND. Returns mailGesendet (false: the email did not go out, the rejection stands). Owner of a rental tenant only. Changes data and sends an email. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
anfrageIdstringyes
nachrichtstringno

Output fields

FieldTypeRequiredNotes
mailGesendetbooleanyes

vermietungAnfragen.angebotSchicken

writes

Sends the prospective tenant an offer with a payment link. Without einzug, auszug (last day of the tenancy) and monatsmieteCents, those of the request and of the apartment apply; the first payment is always the full monthly rent. The deadline is fristStunden (12 to 336) from now, otherwise the offer deadline from the settings. The HousingAnywhere calendar is pulled fresh beforehand; if that fails, the offer still goes out and haAbruf names the state. Duration (minimum and maximum months, move-in not in the past) and calendar are checked again: not permitted or occupied results in CONFLICT. A previously open offer of the same request is withdrawn and the request becomes angeboten; for rejected, paid or cancelled requests the result is CONFLICT. Returns angebotId, link, haAbruf and mailGesendet (false: the email did not go out, the link is returned here anyway). A request of another tenant results in NOT_FOUND. Owner of a rental tenant only. Changes data and sends an email to the prospective tenant. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
anfrageIdstringyes
einzugstringno
auszugstringno
monatsmieteCentsintegerno
hinweisstringno
fristStundenintegerno

Output fields

FieldTypeRequiredNotes
angebotIdstringyes
linkstringyes
haAbrufobjectyes
haAbruf.statusenumyesOne of: aktuell, zuletzt_gueltig, unbekannt, keine_quelle
haAbruf.letzterErfolgstring · nullableyes
haAbruf.fehlerstring · nullableyes
mailGesendetbooleanyes

vermietungAnfragen.angebotZurueckziehen

writes

Withdraws an open offer; the request goes back to angefragt. An offer that is no longer open (paid, expired, already withdrawn) results in CONFLICT, an offer of another tenant in NOT_FOUND. The prospective tenant is not notified. Owner of a rental tenant only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
angebotIdstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

vermietungAnfragen.holen

read-only

One request with all details of the prospective tenant (name, email, phone, message, language), its offers (period, monthly rent, first payment, deadline, status, and the link for an open offer) and frei: whether the requested period is still free right now. A request of another tenant or an unknown one results in NOT_FOUND. Owner of a rental tenant only. Read-only query.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
wohnungobjectyes
wohnung.idstringyes
wohnung.kuerzelstringyes
wohnung.titelstringyes
vornamestringyes
nachnamestringyes
emailstringyes
telefonstring · nullableyes
nachrichtstring · nullableyes
spracheenumyesOne of: de, en
einzugstringyes
auszugstringyes
monateintegeryes
statusenumyesOne of: angefragt, angeboten, bezahlt, abgelehnt, zurueckgezogen, abgelaufen, storniert
createdAtstringyes
updatedAtstringyes
angebotearray of objectyes
angebote.idstringyes
angebote.einzugstringyes
angebote.auszugstringyes
angebote.monatsmieteCentsintegeryes
angebote.ersteZahlungCentsintegeryes
angebote.hinweisstring · nullableyes
angebote.friststringyes
angebote.statusenumyesOne of: offen, angenommen, abgelaufen, zurueckgezogen
angebote.linkstring · nullableyes
angebote.createdAtstringyes
freibooleanyes

vermietungAnfragen.liste

read-only

The requests from prospective tenants, newest first (at most 500): id, wohnung (title), name, einzug and auszug (YYYY-MM-DD, auszug = last day of the tenancy), monate, status (angefragt, angeboten, bezahlt, abgelehnt, zurueckgezogen, abgelaufen, storniert) and createdAt. With status only requests in that status. Owner of a rental tenant only. Read-only query.

Input parameters

FieldTypeRequiredNotes
statusenumnoOne of: angefragt, angeboten, bezahlt, abgelehnt, zurueckgezogen, abgelaufen, storniert

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
wohnungstringyes
namestringyes
einzugstringyes
auszugstringyes
monateintegeryes
statusenumyesOne of: angefragt, angeboten, bezahlt, abgelehnt, zurueckgezogen, abgelaufen, storniert
createdAtstringyes

vermietungAnfragen.nachfragen

writes

Sends the prospective tenant a question from the landlord (text, 1 to 4000 characters) by email; the reply goes directly to the landlord. The status of the request stays. Only for requests in status angefragt or angeboten, otherwise CONFLICT; a request of another tenant results in NOT_FOUND. If sending fails, the call fails. Owner of a rental tenant only. Sends an email. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
anfrageIdstringyes
textstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true