Endpunkte mit personenbezogenen Daten

Die Endpunkte dieser Berechtigung finden Sie im Controller RentAccountingPersonDetails.

Um auf die Daten der Mietenbuchhaltung über die API zugreifen zu können, müssen die Endpunktberechtigungen "Vertragsdaten mit personenbezogenen Details" aktiviert werden.

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Vertragsnehmer abrufen

Dieser Abruf stellt die zeitlich abgrenzbare Zuordnung von Personen als Vertragsnehmer zum Nutzungsvertrag dar.

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

licenseAgreementIdinteger · int32Optional

personIdinteger · int32Optional

includeMainAddressbooleanOptionalDefault: false

includeMainCommunicationbooleanOptionalDefault: false

includePersonAddressesbooleanOptionalDefault: false

includePersonCommunicationsbooleanOptionalDefault: false

includePersonBankAccountsbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/RentAccountingPersonDetails/Contractors HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "LicenseAgreementId": 1,
    "LicenseAgreement": "text",
    "StartContract": "2025-06-27",
    "EndOfContract": "2025-06-27",
    "IsLegalPerson": true,
    "IsNaturalPerson": true,
    "PersonId": 1,
    "PersonIdNum": "text",
    "PersonName": "text",
    "PersonFirstName": "text",
    "PersonLastName": "text",
    "BirthDate": "2025-06-27",
    "PersonValidFrom": "2025-06-27",
    "PersonValidTo": "2025-06-27",
    "ContractorTypeId": 1,
    "ContractorType": "text",
    "GenderId": 1,
    "Gender": "text",
    "UseUnitId": 1,
    "UseUnit": "text",
    "Addresses": [
      {
        "AddressTypeId": 1,
        "Zip": "text",
        "Town": "text",
        "Street": "text",
        "HouseNumber": "text",
        "HouseNumberAddition": "text",
        "CountryId": 1,
        "ValidFrom": "2025-06-27",
        "ValidTo": "2025-06-27",
        "Id": 1,
        "AddressType": "text",
        "CountryCode": "text",
        "StreetComplete": "text",
        "HouseNumberComplete": "text",
        "MainAddress": true
      }
    ],
    "Communications": [
      {
        "CommunicationTypeId": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "Id": 1,
        "CommunicationType": "text",
        "RelatedAddress": "text"
      }
    ],
    "PersonBankAccounts": [
      {
        "Id": 1,
        "BankAccountId": 1,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text",
        "ValidFrom": "2025-06-27",
        "ValidTo": "2025-06-27",
        "BankAccountType": {
          "Id": 1,
          "Code": "text"
        },
        "BankAccountUsageType": {
          "Id": 1,
          "Code": "text"
        }
      }
    ],
    "AddressId": 1,
    "Address": {
      "AddressTypeId": 1,
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "CountryId": 1,
      "ValidFrom": "2025-06-27",
      "ValidTo": "2025-06-27",
      "Id": 1,
      "AddressType": "text",
      "CountryCode": "text",
      "StreetComplete": "text",
      "HouseNumberComplete": "text",
      "MainAddress": true
    },
    "FirstEmailCommunication": {
      "CommunicationTypeId": 1,
      "RelatedAddressId": 1,
      "Content": "text",
      "Explanation": "text",
      "Id": 1,
      "CommunicationType": "text",
      "RelatedAddress": "text"
    },
    "FirstLandlinePhoneCommunication": {
      "CommunicationTypeId": 1,
      "RelatedAddressId": 1,
      "Content": "text",
      "Explanation": "text",
      "Id": 1,
      "CommunicationType": "text",
      "RelatedAddress": "text"
    },
    "FirstMobilePhoneCommunication": {
      "CommunicationTypeId": 1,
      "RelatedAddressId": 1,
      "Content": "text",
      "Explanation": "text",
      "Id": 1,
      "CommunicationType": "text",
      "RelatedAddress": "text"
    }
  }
]

---

Version 1.1

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

licenseAgreementIdinteger · int32Optional

personIdinteger · int32Optional

licenseAgreementActiveOnstring · date-timeOptional

contractualUseActiveOnstring · date-timeOptional

includeMainAddressbooleanOptionalDefault: false

includeMainCommunicationbooleanOptionalDefault: false

includePersonAddressesbooleanOptionalDefault: false

includePersonCommunicationsbooleanOptionalDefault: false

includePersonBankAccountsbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.1/RentAccountingPersonDetails/Contractors HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "LicenseAgreementId": 1,
    "LicenseAgreement": "text",
    "StartContract": "2025-06-27",
    "EndOfContract": "2025-06-27",
    "ContractualUseValidFrom": "2025-06-27",
    "ContractualUseValidTo": "2025-06-27",
    "ContractorType": {
      "Id": 1,
      "Name": "text"
    },
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text",
      "BuildingLandId": 1,
      "EconomicUnitId": 1,
      "EconomicUnit": "text"
    },
    "Person": {
      "Id": 1,
      "IdNum": "text",
      "Shortname": "text",
      "Name": "text",
      "NodeId": 1,
      "TaxNumber": "text",
      "TaxIdentificationNumber": "text",
      "ValidFrom": "2025-06-27",
      "ValidTo": "2025-06-27",
      "IsNaturalPerson": true,
      "NaturalPerson": {
        "Title": "text",
        "FirstName": "text",
        "LastName": "text",
        "BirthName": "text",
        "CareOf": "text",
        "BirthDate": "2025-06-27",
        "DeathDate": "2025-06-27T09:20:37.387Z",
        "Gender": {
          "Id": 1,
          "Name": "text"
        },
        "MaritalType": {
          "Id": 1,
          "Name": "text"
        },
        "Nationality": {
          "Id": 1,
          "Name": "text",
          "Code": "text"
        },
        "ContactPreference": {
          "Id": 1,
          "Name": "text"
        },
        "PersonInCare": {
          "Id": 1,
          "IdNum": "text"
        },
        "ContactFor": [
          {
            "Id": 1,
            "IdNum": "text",
            "LongName1": "text",
            "LongName2": "text"
          }
        ]
      },
      "LegalPerson": {
        "LongName1": "text",
        "LongName2": "text",
        "VatId": "text",
        "CommercialRegisterNumber": "text",
        "CommercialRegisterTown": "text",
        "ContractPersons": [
          {
            "Id": 1,
            "IdNum": "text",
            "FirstName": "text",
            "LastName": "text"
          }
        ]
      },
      "Addresses": [
        {
          "Id": 1,
          "Zip": "text",
          "Town": "text",
          "Street": "text",
          "HouseNumber": "text",
          "HouseNumberAddition": "text",
          "ValidFrom": "2025-06-27",
          "ValidTo": "2025-06-27",
          "StreetComplete": "text",
          "HouseNumberComplete": "text",
          "MainAddress": true,
          "AddressType": {
            "Id": 1,
            "Name": "text"
          },
          "Country": {
            "Id": 1,
            "Name": "text",
            "Code": "text"
          }
        }
      ],
      "Communications": [
        {
          "Id": 1,
          "RelatedAddressId": 1,
          "Content": "text",
          "Explanation": "text",
          "RelatedAddress": "text",
          "CommunicationType": {
            "Id": 1,
            "Name": "text"
          }
        }
      ],
      "BankAccounts": [
        {
          "Id": 1,
          "BankAccountId": 1,
          "Iban": "text",
          "Bic": "text",
          "AccountHolder": "text",
          "ValidFrom": "2025-06-27",
          "ValidTo": "2025-06-27",
          "BankAccountType": {
            "Id": 1,
            "Code": "text"
          },
          "BankAccountUsageType": {
            "Id": 1,
            "Code": "text"
          }
        }
      ],
      "FirstEmailCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      },
      "FirstLandlinePhoneCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      },
      "FirstMobilePhoneCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      }
    },
    "DefaultAddress": {
      "Id": 1,
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "ValidFrom": "2025-06-27",
      "ValidTo": "2025-06-27",
      "StreetComplete": "text",
      "HouseNumberComplete": "text",
      "MainAddress": true,
      "AddressType": {
        "Id": 1,
        "Name": "text"
      },
      "Country": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      }
    }
  }
]

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

licenseAgreementIdinteger · int32Optional

personIdinteger · int32Optional

licenseAgreementActiveOnstring · date-timeOptional

contractualUseActiveOnstring · date-timeOptional

includeMainAddressbooleanOptionalDefault: false

includeMainCommunicationbooleanOptionalDefault: false

includePersonAddressesbooleanOptionalDefault: false

includePersonCommunicationsbooleanOptionalDefault: false

includePersonBankAccountsbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/RentAccountingPersonDetails/Contractors HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "LicenseAgreementId": 1,
    "LicenseAgreement": "text",
    "StartContract": "2025-06-27",
    "EndOfContract": "2025-06-27",
    "ContractualUseValidFrom": "2025-06-27",
    "ContractualUseValidTo": "2025-06-27",
    "ContractorType": {
      "Id": 1,
      "Name": "text"
    },
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text",
      "BuildingLandId": 1,
      "EconomicUnitId": 1,
      "EconomicUnit": "text"
    },
    "Person": {
      "Id": 1,
      "IdNum": "text",
      "Shortname": "text",
      "Name": "text",
      "NodeId": 1,
      "TaxNumber": "text",
      "TaxIdentificationNumber": "text",
      "ValidFrom": "2025-06-27",
      "ValidTo": "2025-06-27",
      "IsNaturalPerson": true,
      "NaturalPerson": {
        "Title": "text",
        "FirstName": "text",
        "LastName": "text",
        "BirthName": "text",
        "CareOf": "text",
        "BirthDate": "2025-06-27",
        "DeathDate": "2025-06-27T09:20:37.387Z",
        "Gender": {
          "Id": 1,
          "Name": "text"
        },
        "MaritalType": {
          "Id": 1,
          "Name": "text"
        },
        "Nationality": {
          "Id": 1,
          "Name": "text",
          "Code": "text"
        },
        "ContactPreference": {
          "Id": 1,
          "Name": "text"
        },
        "PersonInCare": {
          "Id": 1,
          "IdNum": "text"
        },
        "ContactFor": [
          {
            "Id": 1,
            "IdNum": "text",
            "LongName1": "text",
            "LongName2": "text"
          }
        ]
      },
      "LegalPerson": {
        "LongName1": "text",
        "LongName2": "text",
        "VatId": "text",
        "CommercialRegisterNumber": "text",
        "CommercialRegisterTown": "text",
        "ContractPersons": [
          {
            "Id": 1,
            "IdNum": "text",
            "FirstName": "text",
            "LastName": "text"
          }
        ]
      },
      "Addresses": [
        {
          "Id": 1,
          "Zip": "text",
          "Town": "text",
          "Street": "text",
          "HouseNumber": "text",
          "HouseNumberAddition": "text",
          "ValidFrom": "2025-06-27",
          "ValidTo": "2025-06-27",
          "StreetComplete": "text",
          "HouseNumberComplete": "text",
          "MainAddress": true,
          "AddressType": {
            "Id": 1,
            "Name": "text"
          },
          "Country": {
            "Id": 1,
            "Name": "text",
            "Code": "text"
          }
        }
      ],
      "Communications": [
        {
          "Id": 1,
          "RelatedAddressId": 1,
          "Content": "text",
          "Explanation": "text",
          "RelatedAddress": "text",
          "CommunicationType": {
            "Id": 1,
            "Name": "text"
          }
        }
      ],
      "BankAccounts": [
        {
          "Id": 1,
          "BankAccountId": 1,
          "Iban": "text",
          "Bic": "text",
          "AccountHolder": "text",
          "ValidFrom": "2025-06-27",
          "ValidTo": "2025-06-27",
          "BankAccountType": {
            "Id": 1,
            "Code": "text"
          },
          "BankAccountUsageType": {
            "Id": 1,
            "Code": "text"
          }
        }
      ],
      "FirstEmailCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      },
      "FirstLandlinePhoneCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      },
      "FirstMobilePhoneCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      }
    },
    "DefaultAddress": {
      "Id": 1,
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "ValidFrom": "2025-06-27",
      "ValidTo": "2025-06-27",
      "StreetComplete": "text",
      "HouseNumberComplete": "text",
      "MainAddress": true,
      "AddressType": {
        "Id": 1,
        "Name": "text"
      },
      "Country": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      }
    }
  }
]

---

Zahlungsdaten zu den Mietern abrufen

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

paymentModeModeIdinteger · int32Optional

economicUnitIdinteger · int32Optional

economicUnitIdNumstringOptional

useUnitIdinteger · int32Optional

useUnitNumberstringOptional

licenseAgreementIdinteger · int32Optional

licenseAgreementIdNumstringOptional

licenseAgreementActiveOnstring · date-timeOptional

paymentModeActiveOnstring · date-timeOptional

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/RentAccountingPersonDetails/PaymentModes HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "ActiveFrom": "2025-06-27",
    "ActiveTo": "2025-06-27",
    "LicenseAgreement": {
      "Id": 1,
      "IdNum": "text",
      "UseUnit": {
        "Id": 1,
        "UseUnitNumber": "text"
      }
    },
    "Mode": {
      "Id": 1,
      "Name": "text"
    },
    "Type": {
      "Id": 1,
      "Name": "text"
    },
    "SepaMandate": {
      "Id": 1,
      "MandateId": "text",
      "Iban": "text"
    },
    "BankAccount": {
      "Id": 1,
      "Iban": "text",
      "Bic": "text"
    }
  }
]

---

Vertragsnehmer zur Wohnungsübergabe

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

handoverIdinteger · int32Optional

licenseAgreementIdinteger · int32Optional

personIdinteger · int32Optional

licenseAgreementActiveOnstring · date-timeOptional

contractualUseActiveOnstring · date-timeOptional

includeMainAddressbooleanOptionalDefault: false

includeMainCommunicationbooleanOptionalDefault: false

includePersonAddressesbooleanOptionalDefault: false

includePersonCommunicationsbooleanOptionalDefault: false

includePersonBankAccountsbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/RentAccountingPersonDetails/HandoverContractParties HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "LicenseAgreementId": 1,
    "LicenseAgreement": "text",
    "StartContract": "2025-06-27",
    "EndOfContract": "2025-06-27",
    "ContractualUseValidFrom": "2025-06-27",
    "ContractualUseValidTo": "2025-06-27",
    "ContractorType": {
      "Id": 1,
      "Name": "text"
    },
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text",
      "BuildingLandId": 1,
      "EconomicUnitId": 1,
      "EconomicUnit": "text"
    },
    "Person": {
      "Id": 1,
      "IdNum": "text",
      "Shortname": "text",
      "Name": "text",
      "NodeId": 1,
      "TaxNumber": "text",
      "TaxIdentificationNumber": "text",
      "ValidFrom": "2025-06-27",
      "ValidTo": "2025-06-27",
      "IsNaturalPerson": true,
      "NaturalPerson": {
        "Title": "text",
        "FirstName": "text",
        "LastName": "text",
        "BirthName": "text",
        "CareOf": "text",
        "BirthDate": "2025-06-27",
        "DeathDate": "2025-06-27T09:20:37.387Z",
        "Gender": {
          "Id": 1,
          "Name": "text"
        },
        "MaritalType": {
          "Id": 1,
          "Name": "text"
        },
        "Nationality": {
          "Id": 1,
          "Name": "text",
          "Code": "text"
        },
        "ContactPreference": {
          "Id": 1,
          "Name": "text"
        },
        "PersonInCare": {
          "Id": 1,
          "IdNum": "text"
        },
        "ContactFor": [
          {
            "Id": 1,
            "IdNum": "text",
            "LongName1": "text",
            "LongName2": "text"
          }
        ]
      },
      "LegalPerson": {
        "LongName1": "text",
        "LongName2": "text",
        "VatId": "text",
        "CommercialRegisterNumber": "text",
        "CommercialRegisterTown": "text",
        "ContractPersons": [
          {
            "Id": 1,
            "IdNum": "text",
            "FirstName": "text",
            "LastName": "text"
          }
        ]
      },
      "Addresses": [
        {
          "Id": 1,
          "Zip": "text",
          "Town": "text",
          "Street": "text",
          "HouseNumber": "text",
          "HouseNumberAddition": "text",
          "ValidFrom": "2025-06-27",
          "ValidTo": "2025-06-27",
          "StreetComplete": "text",
          "HouseNumberComplete": "text",
          "MainAddress": true,
          "AddressType": {
            "Id": 1,
            "Name": "text"
          },
          "Country": {
            "Id": 1,
            "Name": "text",
            "Code": "text"
          }
        }
      ],
      "Communications": [
        {
          "Id": 1,
          "RelatedAddressId": 1,
          "Content": "text",
          "Explanation": "text",
          "RelatedAddress": "text",
          "CommunicationType": {
            "Id": 1,
            "Name": "text"
          }
        }
      ],
      "BankAccounts": [
        {
          "Id": 1,
          "BankAccountId": 1,
          "Iban": "text",
          "Bic": "text",
          "AccountHolder": "text",
          "ValidFrom": "2025-06-27",
          "ValidTo": "2025-06-27",
          "BankAccountType": {
            "Id": 1,
            "Code": "text"
          },
          "BankAccountUsageType": {
            "Id": 1,
            "Code": "text"
          }
        }
      ],
      "FirstEmailCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      },
      "FirstLandlinePhoneCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      },
      "FirstMobilePhoneCommunication": {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      }
    },
    "DefaultAddress": {
      "Id": 1,
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "ValidFrom": "2025-06-27",
      "ValidTo": "2025-06-27",
      "StreetComplete": "text",
      "HouseNumberComplete": "text",
      "MainAddress": true,
      "AddressType": {
        "Id": 1,
        "Name": "text"
      },
      "Country": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      }
    },
    "ContractorId": 1,
    "HandoverId": 1,
    "Attendance": true
  }
]

---

Kataloge finden Sie im Abschnitt "Personendaten lesen".