Nutzungsvertrag Positionen

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

Abruf Vertragspositionen

Hinweise zur Funktion

Die Position "BGBRelevant" ist notwendig für die Mietanpassung. Ist dieser Wert "wahr", kann diese Position durch eine Mietanpassung angepasst werden. Derzeit kann nur jeweils eine Position pro Mietvertrag einen "Wahr"-Wert in diesem Schlüssel aufweisen.

Die Position "WBRelevant" verhält sich analog zur "BGBRelevant"-Position. Diese bezieht sich auf die Wirtschaftlichkeitsberechnung (Kostenmiete).

"ReportAsSinkingFund" weist aus, dass diese Position Teil eines Vorauszahlungsblocks ist und im Rahmen von Abrechnungen den Kosten entgegengestellt wird.

Version 1.0

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

licenseAgreementIdinteger · int32Optional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

LicenseAgreementIdinteger · int32Optional

VATRateIdinteger · int32 · nullableOptional

VATRatestring · nullableOptional

NetAmountnumber · decimalOptional

Amountnumber · decimalOptional

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

ActiveTostring · date · nullableOptionalExample: 2026-05-12Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidContractPositionIdinteger · int32Optional

ValidContractPositionstring · nullableOptional

ChangeReasonIdinteger · int32Optional

ChangeReasonstring · nullableOptional

UseUnitIdinteger · int32Optional

UseUnitIdNumstring · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.0/RentAccounting/ContractPositions

HTTPcURLJavaScriptPython

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

[
  {
    "Id": 1,
    "LicenseAgreementId": 1,
    "VATRateId": 1,
    "VATRate": "text",
    "NetAmount": 1,
    "Amount": 1,
    "ActiveFrom": "2026-05-12",
    "ActiveTo": "2026-05-12",
    "ValidContractPositionId": 1,
    "ValidContractPosition": "text",
    "ChangeReasonId": 1,
    "ChangeReason": "text",
    "UseUnitId": 1,
    "UseUnitIdNum": "text",
    "ContractPositionContractPositionType": {
      "Id": 1,
      "Name": "text",
      "ShortCode": "text",
      "IsPartOfNetRentCensus": true,
      "IsPartOfNetRent": true,
      "ReportAsSinkingFund": true,
      "IsBasisCalculationReminderChargeInterest": true,
      "IsPrepaymentHeating": true,
      "IsPrepaymentRunningCost": true,
      "IsGrossRentWithoutHeating": true
    }
  }
]

---

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

contractPositionsActiveOnstring · date-timeOptional

contractPositionsTypeIdinteger · int32Optional

includeContractPositionTypeDetailsbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

NetAmountnumber · decimalOptional

Amountnumber · decimalOptional

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

ActiveTostring · date · nullableOptionalExample: 2026-05-12Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/RentAccounting/ContractPositions

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/RentAccounting/ContractPositions HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "NetAmount": 1,
    "Amount": 1,
    "ActiveFrom": "2026-05-12",
    "ActiveTo": "2026-05-12",
    "LicenseAgreement": {
      "Id": 1,
      "IdNum": "text",
      "UseUnit": {
        "Id": 1,
        "UseUnitNumber": "text"
      }
    },
    "VatRate": {
      "Id": 1,
      "Code": "text"
    },
    "ValidContractPosition": {
      "Id": 1,
      "Name": "text"
    },
    "ChangeReasonContracts": {
      "Id": 1,
      "Name": "text"
    },
    "ContractPositionType": {
      "Id": 1,
      "NodeId": 1,
      "Name": "text",
      "ShortCode": "text",
      "Deposit": true,
      "WBRelevant": true,
      "BGBRelevant": true,
      "IsPartOfNetRent": true,
      "UsingCpAsPrepaymentBlock": true,
      "AssignmentPrepayment": "text",
      "IsGrossRentWithoutHeating": true,
      "IsPartOfNetRentCensus": true,
      "IsBasisCalculationReminderChargeInterest": true,
      "IsPrepaymentHeating": true,
      "IsPrepaymentRunningCost": true,
      "ReportAsSinkingFund": true
    },
    "ContractPositionTypeSlim": {
      "Id": 1,
      "Name": "text",
      "ShortCode": "text"
    }
  }
]

---