Nutzungsverträge

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

Abruf Verträge

Version 1.0

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

useUnitIdinteger · int32Optional

licenseAgreementIdinteger · int32Optional

personIdinteger · int32Optional

activeOnstring · date-timeOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/RentAccounting/LicenseAgreements HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text",
      "BuildingLandId": 1,
      "EconomicUnitId": 1,
      "EconomicUnit": "text"
    },
    "RestrictionOfUse": {
      "Id": 1,
      "NodeId": 1,
      "Name": "text",
      "IsVacancy": true
    },
    "StatusContract": {
      "Id": 1,
      "Name": "text"
    },
    "LifeOfContract": {
      "Id": 1,
      "Name": "text"
    },
    "PaymentInterval": {
      "Id": 1,
      "Name": "text"
    },
    "DunningData": {
      "Dunningblock": true,
      "DunningLevel": {
        "Id": 1,
        "Code": "text"
      }
    },
    "DifferingMaturity": 1,
    "StartContract": "2025-06-19",
    "EndOfContract": "2025-06-19",
    "CommonSetEndOfContract": "2025-06-19",
    "RaValidFrom": "2025-06-19",
    "RaValidTo": "2025-06-19",
    "ForBrokerOn": "2025-06-19",
    "ContractTermination": {
      "TerminationOn": "2025-06-19",
      "DesireToTerminate": "2025-06-19",
      "Termination": "2025-06-19",
      "PreviewDate": "2025-06-19",
      "EndViewing": "2025-06-19",
      "UsageUnitFreeAt": "2025-06-19",
      "KeyLevyOn": "2025-06-19",
      "Dismissal": {
        "Id": 1,
        "Name": "text"
      },
      "Comment": "text",
      "TerminationFrom": {
        "Id": 1,
        "Name": "text"
      },
      "FlagOfTheInstantDismissal": "2025-06-19"
    },
    "NoteTermination": "text",
    "PeriodOfNoticeNote": "text",
    "PeriodOfNotice": {
      "Id": 1,
      "Name": "text"
    },
    "DebitEntryType": {
      "Id": 1,
      "Name": "text"
    },
    "ResidentialAuthorization": {
      "Id": 1,
      "Name": "text"
    },
    "PaymentDate": {
      "Id": 1,
      "Name": "text"
    },
    "VacancyReason": {
      "Id": 1,
      "NodeId": 1,
      "Name": "text"
    },
    "Banking": {
      "Id": 1,
      "UseVirtualIban": true,
      "VirtualIban": "text",
      "FormerVirtualIban": "text",
      "CollectiveAccount": {
        "NoRealBankAccount": true,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text"
      }
    },
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ],
    "ContractAgreements": [
      {
        "Id": 1,
        "ValidFrom": "2025-06-19",
        "ValidTo": "2025-06-19",
        "FirstDebit": "2025-06-19",
        "InputDate": "2025-06-19",
        "Activated": true,
        "Comment": "text",
        "Type": {
          "Id": 1,
          "Name": "text"
        }
      }
    ]
  }
]

---

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

economicUnitIdinteger · int32Optional

economicUnitIdNumstringOptional

useUnitIdinteger · int32Optional

useUnitNumberstringOptional

licenseAgreementIdinteger · int32Optional

licenseAgreementIdNumstringOptional

licenseAgreementActiveOnstring · date-timeOptional

personIdinteger · int32Optional

personIdNumstringOptional

includeBankingbooleanOptionalDefault: false

includeAdditionalFieldbooleanOptionalDefault: false

includeContractAgreementbooleanOptionalDefault: 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/RentAccounting/LicenseAgreements HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text",
      "BuildingLandId": 1,
      "EconomicUnitId": 1,
      "EconomicUnit": "text"
    },
    "RestrictionOfUse": {
      "Id": 1,
      "NodeId": 1,
      "Name": "text",
      "IsVacancy": true
    },
    "StatusContract": {
      "Id": 1,
      "Name": "text"
    },
    "LifeOfContract": {
      "Id": 1,
      "Name": "text"
    },
    "PaymentInterval": {
      "Id": 1,
      "Name": "text"
    },
    "DunningData": {
      "Dunningblock": true,
      "DunningLevel": {
        "Id": 1,
        "Code": "text"
      }
    },
    "DifferingMaturity": 1,
    "StartContract": "2025-06-19",
    "EndOfContract": "2025-06-19",
    "CommonSetEndOfContract": "2025-06-19",
    "RaValidFrom": "2025-06-19",
    "RaValidTo": "2025-06-19",
    "ForBrokerOn": "2025-06-19",
    "ContractTermination": {
      "TerminationOn": "2025-06-19",
      "DesireToTerminate": "2025-06-19",
      "Termination": "2025-06-19",
      "PreviewDate": "2025-06-19",
      "EndViewing": "2025-06-19",
      "UsageUnitFreeAt": "2025-06-19",
      "KeyLevyOn": "2025-06-19",
      "Dismissal": {
        "Id": 1,
        "Name": "text"
      },
      "Comment": "text",
      "TerminationFrom": {
        "Id": 1,
        "Name": "text"
      },
      "FlagOfTheInstantDismissal": "2025-06-19"
    },
    "NoteTermination": "text",
    "PeriodOfNoticeNote": "text",
    "PeriodOfNotice": {
      "Id": 1,
      "Name": "text"
    },
    "DebitEntryType": {
      "Id": 1,
      "Name": "text"
    },
    "ResidentialAuthorization": {
      "Id": 1,
      "Name": "text"
    },
    "PaymentDate": {
      "Id": 1,
      "Name": "text"
    },
    "VacancyReason": {
      "Id": 1,
      "NodeId": 1,
      "Name": "text"
    },
    "Banking": {
      "Id": 1,
      "UseVirtualIban": true,
      "VirtualIban": "text",
      "FormerVirtualIban": "text",
      "CollectiveAccount": {
        "NoRealBankAccount": true,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text"
      }
    },
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ],
    "ContractAgreements": [
      {
        "Id": 1,
        "ValidFrom": "2025-06-19",
        "ValidTo": "2025-06-19",
        "FirstDebit": "2025-06-19",
        "InputDate": "2025-06-19",
        "Activated": true,
        "Comment": "text",
        "Type": {
          "Id": 1,
          "Name": "text"
        }
      }
    ]
  }
]

---

Zuständigkeit in Verträgen

Version 1.2

---

get

Authorizations

Query parameters

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

useUnitIdinteger · int32Optional

useUnitNumberstringOptional

licenseAgreementIdinteger · int32Optional

licenseAgreementIdNumstringOptional

licenseAgreementActiveOnstring · date-timeOptional

personIdinteger · int32Optional

personIdNumstringOptional

showNullValuesbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/RentAccounting/LicenseAgreement/Jurisdiction HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "LicenseAgreement": {
      "Id": 1,
      "IdNum": "text",
      "UseUnit": {
        "Id": 1,
        "UseUnitNumber": "text"
      }
    },
    "UseUnitUniversalResponsibility": true,
    "UseUnitUniversalResponsibleOfficial": {
      "Id": 1,
      "CodeShort": "text",
      "AutomaticMailsActivated": true,
      "UniversalResponsibilityPossible": true,
      "PersonId": 1,
      "PersonName": "text",
      "UserId": 1
    },
    "EconomicUnitUniversalResponsibility": true,
    "EconomicUnitUniversalResponsibleOfficial": {
      "Id": 1,
      "CodeShort": "text",
      "AutomaticMailsActivated": true,
      "UniversalResponsibilityPossible": true,
      "PersonId": 1,
      "PersonName": "text",
      "UserId": 1
    },
    "UseUnitJurisdictionList": [
      {
        "Id": 1,
        "MainJurisdiction": true,
        "ResponsibleOfficial": {
          "Id": 1,
          "CodeShort": "text",
          "AutomaticMailsActivated": true,
          "UniversalResponsibilityPossible": true,
          "PersonId": 1,
          "PersonName": "text",
          "UserId": 1
        },
        "Department": {
          "Id": 1,
          "Name": "text"
        },
        "DepartmentType": {
          "Id": 1,
          "Name": "text"
        }
      }
    ]
  }
]

---