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/openwowi/v1.0/RentAccounting/ContractPositions

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

LicenseAgreementIdinteger (int32)

VATRateIdnullable integer (int32)

VATRatenullable string

NetAmountnumber (decimal)

Amountnumber (decimal)

ActiveFromstring (date)

Example: "2025-02-05"

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

ActiveTonullable string (date)

Example: "2025-02-05"

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

ValidContractPositionIdinteger (int32)

ValidContractPositionnullable string

ChangeReasonIdinteger (int32)

ChangeReasonnullable string

UseUnitIdinteger (int32)

UseUnitIdNumnullable string

ContractPositionContractPositionTypenullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/RentAccounting/ContractPositions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "LicenseAgreementId": 1,
    "VATRateId": 1,
    "VATRate": "text",
    "NetAmount": 1,
    "Amount": 1,
    "ActiveFrom": "2025-02-05",
    "ActiveTo": "2025-02-05",
    "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/openwowi/v1.2/RentAccounting/ContractPositions

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

NetAmountnumber (decimal)

Amountnumber (decimal)

ActiveFromstring (date)

Example: "2025-02-05"

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

ActiveTonullable string (date)

Example: "2025-02-05"

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

LicenseAgreementnullable all of

VatRatenullable all of

ValidContractPositionnullable all of

ChangeReasonContractsnullable all of

ContractPositionTypenullable all of

ContractPositionTypeSlimnullable all of

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/RentAccounting/ContractPositions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "NetAmount": 1,
    "Amount": 1,
    "ActiveFrom": "2025-02-05",
    "ActiveTo": "2025-02-05",
    "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"
    }
  }
]

---