4.1 Mieterstammdaten-Prozess

Unter Punkt "4.1.1 Mieterstammdaten vom Produkt zum Partner" wird der Mieterstammdatenaustausch aus Sicht des Partners beschrieben.

Der Partner holt die Mieterstammdaten aus der CloudApi ab.



optionale Mieterstammdaten-Endpunkte:

Mieterstammdaten JSON-Schema

Gibt das JSON-Schema eines Mieterstammdaten-RequestType zurück

GET SchemaMieterstammdatenRequest

HTTP request
GET /CloudApi/V1/api//jobschemas/MieterstammdatenRequest HTTP/1.1
Ocp-Apim-Subscription-Key: ••••••••••••••••••••••••••••••••
Accept: */*
Cache-Control: no-cache
Host: api.realestatehub.haufe.io
Accept-Encoding: gzip, deflate, br
Connection: keep-alive


HTTP response
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
Content-Encoding: gzip
Expires: -1
Vary: Accept-Encoding
X-Powered-By: ASP.NET
Date: Mon, 16 Nov 2020 10:25:18 GMT
 
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "MieterstammdatenRequest",
"type": "object",
"properties": {
"RequestType": {
"type": [
"null",
"string"
]
},
"MandantEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/MandantEntity"
}
},
"UnternehmenEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/UnternehmenEntity"
}
},
"WirtschaftseinheitEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/WirtschaftseinheitEntity"
}
},
"GebaeudeEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/GebaeudeEntity"
}
},
"HausEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/HausEntity"
}
},
"NutzungseinheitEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/NutzungseinheitEntity"
}
},
"RaumEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/RaumEntity"
}
},
"NutzerEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/NutzerEntity"
}
},
"AdresseEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/AdresseEntity"
}
},
"BankKontoEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/BankKontoEntity"
}
},
"BudgetEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/BudgetEntity"
}
},
"GewerkEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/GewerkEntity"
}
},
"KostenstellenEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/KostenstellenEntity"
}
},
"KreditorEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/KreditorEntity"
}
},
"SachbearbeiterEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/SachbearbeiterEntity"
}
},
"SachkontenEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/SachkontenEntity"
}
},
"SachkontoSperreEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/SachkontoSperreEntity"
}
},
"BenutzerEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/BenutzerEntity"
}
}
},
"definitions": {
"MandantEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Mandant",
"Bezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"Mandant": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"UnternehmenEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierMandant",
"UniqueEntityIdentifierAdresse",
"Unternehmen",
"Bezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierMandant": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierAdresse": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierStandardBankkonto": {
"type": [
"null",
"string"
]
},
"Unternehmen": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierBankkonten": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"WirtschaftseinheitEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierUnternehmen",
"Wirtschaftseinheit",
"Bezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierUnternehmen": {
"type": "string",
"minLength": 1
},
"Wirtschaftseinheit": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string",
"minLength": 1
},
"Postleitzahl": {
"type": [
"null",
"string"
]
},
"Ort": {
"type": [
"null",
"string"
]
},
"Strasse": {
"type": [
"null",
"string"
]
},
"Baujahr": {
"type": [
"null",
"string"
]
},
"Inaktivdatum": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierSachbearbeiter": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"GebaeudeEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"GebaeudeNummer",
"Bezeichnung",
"UniqueEntityIdentifierWirtschaftseinheit",
"UniqueEntityIdentifier"
],
"properties": {
"GebaeudeNummer": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string"
},
"UniqueEntityIdentifierWirtschaftseinheit": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"HausEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Hausnummer",
"Bezeichnung",
"UniqueEntityIdentifierWirtschaftseinheit",
"UniqueEntityIdentifier"
],
"properties": {
"Hausnummer": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string"
},
"UniqueEntityIdentifierWirtschaftseinheit": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierGebaeude": {
"type": [
"null",
"string"
]
},
"Postleitzahl": {
"type": [
"null",
"string"
]
},
"Ort": {
"type": [
"null",
"string"
]
},
"Strasse": {
"type": [
"null",
"string"
]
},
"Baujahr": {
"type": [
"null",
"string"
]
},
"Inaktivdatum": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierSachbearbeiter": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"NutzungseinheitEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierHaus",
"NutzungseinheitNummer",
"Bezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierHaus": {
"type": "string",
"minLength": 1
},
"NutzungseinheitNummer": {
"type": "string",
"minLength": 1
},
"NutzungseinheitNummerZusatz": {
"type": [
"null",
"string"
]
},
"Bezeichnung": {
"type": "string",
"minLength": 1
},
"Zimmeranzahl": {
"type": [
"null",
"string"
]
},
"Wohnflaeche": {
"type": [
"null",
"string"
]
},
"Gewerbeflaeche": {
"type": [
"null",
"string"
]
},
"Nutzungsart": {
"type": [
"null",
"string"
]
},
"NutzungsartText": {
"type": [
"null",
"string"
]
},
"Geschosstext": {
"type": [
"null",
"string"
]
},
"Wohnlagetext": {
"type": [
"null",
"string"
]
},
"Inaktivdatum": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierSachbearbeiter": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"RaumEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierNutzungseinheit",
"Raumnummer",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierNutzungseinheit": {
"type": "string",
"minLength": 1
},
"Raumnummer": {
"type": "string",
"minLength": 1
},
"Raumart": {
"type": [
"null",
"string"
]
},
"GesamtflaecheBrutto": {
"type": [
"null",
"string"
]
},
"GesamtflaecheNetto": {
"type": [
"null",
"string"
]
},
"BeheizteFlaeche": {
"type": [
"null",
"string"
]
},
"Laenge": {
"type": [
"null",
"string"
]
},
"Breite": {
"type": [
"null",
"string"
]
},
"Hoehe": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"NutzerEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierNutzerAdresse",
"UniqueEntityIdentifierNutzungseinheit",
"Nutzernummer",
"Bezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierNutzerAdresse": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierVertragspartnerAdresse": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierNutzungseinheit": {
"type": "string",
"minLength": 1
},
"Nutzernummer": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string",
"minLength": 1
},
"Auszugsdatum": {
"type": [
"null",
"string"
]
},
"Einzugsdatum": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"AdresseEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"AdressNummer",
"UniqueEntityIdentifier"
],
"properties": {
"AdressNummer": {
"type": "string",
"minLength": 1
},
"Anrede": {
"type": [
"null",
"string"
]
},
"Vorname": {
"type": [
"null",
"string"
]
},
"Nachname": {
"type": [
"null",
"string"
]
},
"Firma": {
"type": [
"null",
"string"
]
},
"Strasse": {
"type": [
"null",
"string"
]
},
"Postleitzahl": {
"type": [
"null",
"string"
]
},
"Ortname": {
"type": [
"null",
"string"
]
},
"Vorwahl1": {
"type": [
"null",
"string"
]
},
"Telefon1": {
"type": [
"null",
"string"
]
},
"Vorwahl2": {
"type": [
"null",
"string"
]
},
"Telefon2": {
"type": [
"null",
"string"
]
},
"VorwahlMobil": {
"type": [
"null",
"string"
]
},
"TelefonMobil": {
"type": [
"null",
"string"
]
},
"VorwahlFax": {
"type": [
"null",
"string"
]
},
"Telefax": {
"type": [
"null",
"string"
]
},
"Email": {
"type": [
"null",
"string"
]
},
"LaendercodeAlpha2": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"BankKontoEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Iban",
"Bic",
"UniqueEntityIdentifier"
],
"properties": {
"Iban": {
"type": "string"
},
"Bic": {
"type": "string"
},
"GueltigVon": {
"type": [
"null",
"string"
]
},
"GueltigBis": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"BudgetEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"BudgetNummer",
"Bezeichnung",
"UniqueEntityIdentifierUnternehmen",
"UniqueEntityIdentifier"
],
"properties": {
"BudgetNummer": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierUnternehmen": {
"type": "string",
"minLength": 1
},
"GueltigkeitVon": {
"type": [
"null",
"string"
]
},
"GueltigkeitBis": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"GewerkEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Gewerknummer",
"Bezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"Gewerknummer": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string"
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"KostenstellenEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Kostenstellennummer",
"Bezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"Kostenstellennummer": {
"type": "string",
"minLength": 1
},
"Stufe": {
"type": [
"null",
"string"
]
},
"Bezeichnung": {
"type": "string"
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"KreditorEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierUnternehmen",
"UniqueEntityIdentifierAdresse",
"KreditorenNummer",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierUnternehmen": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierAdresse": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierStandardBankkonto": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierBankkonten": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"KreditorenNummer": {
"type": "string",
"minLength": 1
},
"SperrGrundAuftrag": {
"type": [
"null",
"string"
]
},
"SperrGrundBuchung": {
"type": [
"null",
"string"
]
},
"SperrGrundZahlung": {
"type": [
"null",
"string"
]
},
"Skonto": {
"type": [
"null",
"object"
],
"additionalProperties": {
"type": "string"
}
},
"SicherheitsNummer": {
"type": [
"null",
"string"
]
},
"SicherheitsNummerGueltigVon": {
"type": [
"null",
"string"
]
},
"SicherheitsNummerGueltigBis": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierGewerke": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"SachbearbeiterEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Sachbearbeiternummer",
"Bezeichnung",
"SachbearbeiterTyp",
"UniqueEntityIdentifier"
],
"properties": {
"Sachbearbeiternummer": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": "string",
"minLength": 1
},
"SachbearbeiterTyp": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"SachkontenEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Kontonummer",
"Kontobezeichnung",
"UniqueEntityIdentifier"
],
"properties": {
"Kontonummer": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierKostenstelle": {
"type": [
"null",
"string"
]
},
"Kontobezeichnung": {
"type": "string"
},
"Betriebskostenrelevant": {
"type": [
"null",
"string"
]
},
"Kontenart": {
"type": [
"null",
"string"
]
},
"Buchungsschluessel": {
"type": [
"null",
"string"
]
},
"BezeichnungBuchungsschluessel": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierUnternehmen": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"SachkontoSperreEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierSachkonto",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierSachkonto": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierWirtschaftseinheit": {
"type": [
"null",
"string"
]
},
"WertstellungsdatumVon": {
"type": [
"null",
"string"
]
},
"WertstellungsdatumBis": {
"type": [
"null",
"string"
]
},
"AbrechnungsdatumVon": {
"type": [
"null",
"string"
]
},
"AbrechnungsdatumBis": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"BenutzerEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Benutzerkennzeichen",
"UniqueEntityIdentifier"
],
"properties": {
"Benutzerkennzeichen": {
"type": "string",
"minLength": 1
},
"Bezeichnung": {
"type": [
"null",
"string"
]
},
"Inaktiv": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
}
}
}


Nicht abgeschlossene Mieterstammdaten-Job´s aufrufen

Gibt die ersten 20 Job´s zurück, die nicht den Job-Status:"ResponseRetrieved" haben.

GET Jobsexchangeincomplete


HTTP request
GET /CloudApi/V1/api//jobs/exchangeincomplete HTTP/1.1
Ocp-Apim-Subscription-Key: ••••••••••••••••••••••••••••••••
Authorization: Bearer 4ab49fd1-4cf3-4736-86a4-5dc416a56199
Accept: */*
Cache-Control: no-cache
Host: api.realestatehub.haufe.io
Accept-Encoding: gzip, deflate, br
Connection: keep-alive


HTTP response
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 284
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Expires: -1
Vary: Accept-Encoding
X-Powered-By: ASP.NET
Date: Mon, 16 Nov 2020 09:41:20 GMT
 
{
"ExchangeIncompleteJobs": [
{
"Id": "d23eddb0-0a52-4448-bd02-13f70c7fffa3",
"State": "Queued"
},
{
"Id": "e92e7860-f6b3-4770-8142-ada6fed79eb5",
"State": "New"
},
{
"Id": "0fd3ce4c-dc96-4d65-9cf4-35e08c929952",
"State": "Confirmed"
},
{
"Id": "2846ace1-561d-4325-ad7a-8b9811816e37",
"State": "Processed"
},
{
"Id": "e84a355c-8223-45c1-af4e-5162f8c8dd1e",
"State": "Error"
},
.
.
.
.
.
{
"Id": "375fe710-8023-4a79-a078-d783b084e24a",
"State": "New"
}
],
"_links": {
"self": {
"href": "https://api.realestatehub.haufe.io/CloudApi/V1/api/jobs/exchangeincomplete"
}
}
}