Nutzungsverträge

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

Abruf Verträge

Hinweise zur Funktion

Bitte beachten Sie, dass die Verträge und die Vertragskonten zwei unterschiedliche Entitäten sind. Die Endpunkte für die Vertragskonten finden Sie in den Transaktionsdaten.

Version 1.0

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

useUnitIdinteger · int32Optional

licenseAgreementIdinteger · int32Optional

personIdinteger · int32Optional

activeOnstring · date-timeOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

IdNumstring · nullfähigOptional

DifferingMaturityinteger · int32 · nullfähigOptional

StartContractstring · dateOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

EndOfContractstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CommonSetEndOfContractstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

RaValidFromstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

RaValidTostring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ForBrokerOnstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

NoteTerminationstring · nullfähigOptional

PeriodOfNoticeNotestring · nullfähigOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.0/RentAccounting/LicenseAgreements

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/RentAccounting/LicenseAgreements HTTP/1.1
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": "2026-03-17",
    "EndOfContract": "2026-03-17",
    "CommonSetEndOfContract": "2026-03-17",
    "RaValidFrom": "2026-03-17",
    "RaValidTo": "2026-03-17",
    "ForBrokerOn": "2026-03-17",
    "ContractTermination": {
      "TerminationOn": "2026-03-17",
      "DesireToTerminate": "2026-03-17",
      "Termination": "2026-03-17",
      "PreviewDate": "2026-03-17",
      "EndViewing": "2026-03-17",
      "UsageUnitFreeAt": "2026-03-17",
      "KeyLevyOn": "2026-03-17",
      "Dismissal": {
        "Id": 1,
        "Name": "text"
      },
      "Comment": "text",
      "TerminationFrom": {
        "Id": 1,
        "Name": "text"
      },
      "FlagOfTheInstantDismissal": "2026-03-17"
    },
    "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": "2026-03-17",
        "ValidTo": "2026-03-17",
        "FirstDebit": "2026-03-17",
        "InputDate": "2026-03-17",
        "Activated": true,
        "Comment": "text",
        "Type": {
          "Id": 1,
          "Name": "text"
        }
      }
    ]
  }
]

---

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

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

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

IdNumstring · nullfähigOptional

DifferingMaturityinteger · int32 · nullfähigOptional

StartContractstring · dateOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

EndOfContractstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CommonSetEndOfContractstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

RaValidFromstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

RaValidTostring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ForBrokerOnstring · date · nullfähigOptionalExample: 2026-03-17Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

NoteTerminationstring · nullfähigOptional

PeriodOfNoticeNotestring · nullfähigOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/RentAccounting/LicenseAgreements

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/RentAccounting/LicenseAgreements HTTP/1.1
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": "2026-03-17",
    "EndOfContract": "2026-03-17",
    "CommonSetEndOfContract": "2026-03-17",
    "RaValidFrom": "2026-03-17",
    "RaValidTo": "2026-03-17",
    "ForBrokerOn": "2026-03-17",
    "ContractTermination": {
      "TerminationOn": "2026-03-17",
      "DesireToTerminate": "2026-03-17",
      "Termination": "2026-03-17",
      "PreviewDate": "2026-03-17",
      "EndViewing": "2026-03-17",
      "UsageUnitFreeAt": "2026-03-17",
      "KeyLevyOn": "2026-03-17",
      "Dismissal": {
        "Id": 1,
        "Name": "text"
      },
      "Comment": "text",
      "TerminationFrom": {
        "Id": 1,
        "Name": "text"
      },
      "FlagOfTheInstantDismissal": "2026-03-17"
    },
    "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": "2026-03-17",
        "ValidTo": "2026-03-17",
        "FirstDebit": "2026-03-17",
        "InputDate": "2026-03-17",
        "Activated": true,
        "Comment": "text",
        "Type": {
          "Id": 1,
          "Name": "text"
        }
      }
    ]
  }
]

---

Zuständigkeit in Verträgen

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

useUnitIdinteger · int32Optional

useUnitNumberstringOptional

licenseAgreementIdinteger · int32Optional

licenseAgreementIdNumstringOptional

licenseAgreementActiveOnstring · date-timeOptional

personIdinteger · int32Optional

personIdNumstringOptional

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

UseUnitUniversalResponsibilitybooleanOptional

EconomicUnitUniversalResponsibilitybooleanOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/RentAccounting/LicenseAgreement/Jurisdiction

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/RentAccounting/LicenseAgreement/Jurisdiction HTTP/1.1
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"
        }
      }
    ]
  }
]

---