Vorgeschlagene Vertragsnehmer

Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "SuggestedContractor".

Um auf die Daten der vorgeschlagenen Vertragsnehmer über die API zugreifen zu können, muss die Endpunktberechtigung "Vorgeschlagene Vertragsnehmer lesen/bearbeiten" aktiviert werden.

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

Hinweise zur Funktion

Um einen neuen Vertragsnehmer anzulegen, müssen zuerst die Personendaten des neuen Vertragsnehmers in WOWIPORT erfasst werden. Sie können hierzu den Endpunkt für die Anlage von Personen verwenden.

Die Logik von WOWIPORT sieht vor, dass ein vermietetes Objekt nicht ohne Vertrag bestehen kann. Ist kein aktives Mietverhältnis hinterlegt, wird der Vertrag zu einem "Leerstandsvertrag".

Aus diesem Grund werden vorgeschlagene Vertragsnehmer nicht mit einzelnen Objekten verknüpft, sondern mit dem Vertrag, welchen diese durch einen neuen Vertrag ablösen sollen.

Sollte mehr als ein Vertragsnehmer in den Vertrag übernommen werden, reicht die Übermittlung der Vertragsdaten im "Ersten Vertragsnehmer" aus. Für weitere Vertragsnehmer benötigen Sie dann nur noch die "LicenceAgreementId", "PersonId" und "TypeOfUserId".

Abruf aller vorgeschlagenen Vertragsnehmer

Version 1.2

---

GET/openwowi/v1.2/SuggestedContractor/SuggestedContractor

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

LicenseAgreementnullable all of

ContractorTypenullable all of

EstimatedContractDatanullable all of

HasLicenseAgreementHandledboolean

HasContractPositionHandledboolean

SuggestedContractPositionsnullable array of object

Personnullable all of

Request

JavaScriptCurlPythonHTTP

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

Response

200400

[
  {
    "Id": 1,
    "LicenseAgreement": {
      "Id": 1,
      "UseUnit": {
        "Id": 1,
        "UseUnitNumber": "text",
        "BuildingLandId": 1,
        "EconomicUnitId": 1,
        "EconomicUnit": "text"
      },
      "RestrictionsOfUse": {
        "Id": 1,
        "NodeId": 1,
        "Name": "text",
        "IsVacancy": true
      },
      "ContractStatus": {
        "Id": 1,
        "Name": "text"
      },
      "IdNum": "text",
      "StartContract": "2025-02-05",
      "EndOfContract": "2025-02-05"
    },
    "ContractorType": {
      "Id": 1,
      "Name": "text",
      "Classification": "text"
    },
    "EstimatedContractData": {
      "EstimatedColdRent": 1,
      "EstimatedPrepaymentHeating": 1,
      "EstimatedRunningCost": 1,
      "EstimatedTotalRent": 1,
      "EstimatedContractSecurity": 1,
      "EstimatedStartContract": "2025-02-05",
      "ContractSignedAt": "2025-02-05",
      "CommonSetEndOfContract": "2025-02-05",
      "TaxSlimAgreementVatRate": {
        "Id": 1,
        "Code": "text"
      },
      "LifeOfAContract": {
        "Id": 1,
        "Code": "text"
      },
      "Address1": "text",
      "Address2": "text",
      "Address3": "text",
      "Address4": "text",
      "Address5": "text",
      "Address6": "text",
      "Title": "text",
      "FutureUpdateRecipientAddress": true
    },
    "HasLicenseAgreementHandled": true,
    "HasContractPositionHandled": true,
    "SuggestedContractPositions": [
      {
        "Id": 1,
        "ContractPositionContractPositionTypeObsolete": {
          "Id": 1,
          "Name": "text",
          "ShortCode": "text",
          "IsPartOfNetRentCensus": true,
          "IsPartOfNetRent": true,
          "ReportAsSinkingFund": true,
          "IsBasisCalculationReminderChargeInterest": true,
          "IsPrepaymentHeating": true,
          "IsPrepaymentRunningCost": true,
          "IsGrossRentWithoutHeating": true
        },
        "Amount": 1,
        "NetAmount": 1,
        "Currency": {
          "Id": 1,
          "Code": "text"
        },
        "ValidFrom": "2025-02-05",
        "ValidTo": "2025-02-05",
        "VatRate": {
          "Id": 1,
          "Code": "text"
        },
        "Info": "text"
      }
    ],
    "Person": {
      "Id": 1,
      "IdNum": "text",
      "Shortname": "text",
      "Name": "text",
      "NodeId": 1,
      "TaxNumber": "text",
      "TaxIdentificationNumber": "text",
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "IsNaturalPerson": true,
      "NaturalPerson": {
        "Title": "text",
        "FirstName": "text",
        "LastName": "text",
        "BirthName": "text",
        "CareOf": "text",
        "BirthDate": "2025-02-05",
        "DeathDate": "2025-02-05T03:58:44.038Z",
        "Gender": {
          "Id": 1,
          "Name": "text"
        },
        "MaritalType": {
          "Id": 1,
          "Name": "text"
        },
        "Nationality": {
          "Id": 1,
          "Name": "text",
          "Code": "text"
        },
        "ContactPreference": {
          "Id": 1,
          "Name": "text"
        }
      },
      "LegalPerson": {
        "LongName1": "text",
        "LongName2": "text",
        "VatId": "text",
        "CommercialRegisterNumber": "text",
        "CommercialRegisterTown": "text"
      },
      "Addresses": [
        {
          "Id": 1,
          "Zip": "text",
          "Town": "text",
          "Street": "text",
          "HouseNumber": "text",
          "HouseNumberAddition": "text",
          "ValidFrom": "2025-02-05",
          "ValidTo": "2025-02-05",
          "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-02-05",
          "ValidTo": "2025-02-05",
          "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"
        }
      }
    }
  }
]

---

Abruf einzelner vorgeschlagener Vertragsnehmer

Version 1.0

---

GET/openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Personnullable all of

LicenseAgreementnullable all of

ContractorTypenullable all of

EstimatedContractDatanullable all of

HasLicenseAgreementHandledboolean

HasContractPositionHandledboolean

SuggestedContractPositionsnullable array of object

Request

JavaScriptCurlPythonHTTP

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

Response

200400

{
  "Id": 1,
  "Person": {
    "Id": 1,
    "IdNum": "text",
    "Name": "text",
    "ShortName": "text",
    "ValidFrom": "2025-02-05",
    "ValidTo": "2025-02-05",
    "IsNaturalPerson": true,
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text"
    },
    "NaturalPerson": {
      "Title": "text",
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "BirthDate": "2025-02-05",
      "DeathDate": "2025-02-05T03:58:44.038Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      },
      "ContactPreference": {
        "Id": 1,
        "Name": "text"
      }
    }
  },
  "LicenseAgreement": {
    "Id": 1,
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text",
      "BuildingLandId": 1,
      "EconomicUnitId": 1,
      "EconomicUnit": "text"
    },
    "RestrictionsOfUse": {
      "Id": 1,
      "NodeId": 1,
      "Name": "text",
      "IsVacancy": true
    },
    "ContractStatus": {
      "Id": 1,
      "Name": "text"
    },
    "IdNum": "text",
    "StartContract": "2025-02-05",
    "EndOfContract": "2025-02-05"
  },
  "ContractorType": {
    "Id": 1,
    "Name": "text",
    "Classification": "text"
  },
  "EstimatedContractData": {
    "EstimatedColdRent": 1,
    "EstimatedPrepaymentHeating": 1,
    "EstimatedRunningCost": 1,
    "EstimatedTotalRent": 1,
    "EstimatedContractSecurity": 1,
    "EstimatedStartContract": "2025-02-05",
    "ContractSignedAt": "2025-02-05",
    "CommonSetEndOfContract": "2025-02-05",
    "TaxSlimAgreementVatRate": {
      "Id": 1,
      "Code": "text"
    },
    "LifeOfAContract": {
      "Id": 1,
      "Code": "text"
    },
    "Address1": "text",
    "Address2": "text",
    "Address3": "text",
    "Address4": "text",
    "Address5": "text",
    "Address6": "text",
    "Title": "text",
    "FutureUpdateRecipientAddress": true
  },
  "HasLicenseAgreementHandled": true,
  "HasContractPositionHandled": true,
  "SuggestedContractPositions": [
    {
      "Id": 1,
      "ContractPositionContractPositionTypeObsolete": {
        "Id": 1,
        "Name": "text",
        "ShortCode": "text",
        "IsPartOfNetRentCensus": true,
        "IsPartOfNetRent": true,
        "ReportAsSinkingFund": true,
        "IsBasisCalculationReminderChargeInterest": true,
        "IsPrepaymentHeating": true,
        "IsPrepaymentRunningCost": true,
        "IsGrossRentWithoutHeating": true
      },
      "Amount": 1,
      "NetAmount": 1,
      "Currency": {
        "Id": 1,
        "Code": "text"
      },
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "VatRate": {
        "Id": 1,
        "Code": "text"
      },
      "Info": "text"
    }
  ]
}

---

Version 1.2

---

GET/openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

LicenseAgreementnullable all of

ContractorTypenullable all of

EstimatedContractDatanullable all of

HasLicenseAgreementHandledboolean

HasContractPositionHandledboolean

SuggestedContractPositionsnullable array of object

Personnullable all of

Request

JavaScriptCurlPythonHTTP

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

Response

200400

{
  "Id": 1,
  "LicenseAgreement": {
    "Id": 1,
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text",
      "BuildingLandId": 1,
      "EconomicUnitId": 1,
      "EconomicUnit": "text"
    },
    "RestrictionsOfUse": {
      "Id": 1,
      "NodeId": 1,
      "Name": "text",
      "IsVacancy": true
    },
    "ContractStatus": {
      "Id": 1,
      "Name": "text"
    },
    "IdNum": "text",
    "StartContract": "2025-02-05",
    "EndOfContract": "2025-02-05"
  },
  "ContractorType": {
    "Id": 1,
    "Name": "text",
    "Classification": "text"
  },
  "EstimatedContractData": {
    "EstimatedColdRent": 1,
    "EstimatedPrepaymentHeating": 1,
    "EstimatedRunningCost": 1,
    "EstimatedTotalRent": 1,
    "EstimatedContractSecurity": 1,
    "EstimatedStartContract": "2025-02-05",
    "ContractSignedAt": "2025-02-05",
    "CommonSetEndOfContract": "2025-02-05",
    "TaxSlimAgreementVatRate": {
      "Id": 1,
      "Code": "text"
    },
    "LifeOfAContract": {
      "Id": 1,
      "Code": "text"
    },
    "Address1": "text",
    "Address2": "text",
    "Address3": "text",
    "Address4": "text",
    "Address5": "text",
    "Address6": "text",
    "Title": "text",
    "FutureUpdateRecipientAddress": true
  },
  "HasLicenseAgreementHandled": true,
  "HasContractPositionHandled": true,
  "SuggestedContractPositions": [
    {
      "Id": 1,
      "ContractPositionContractPositionTypeObsolete": {
        "Id": 1,
        "Name": "text",
        "ShortCode": "text",
        "IsPartOfNetRentCensus": true,
        "IsPartOfNetRent": true,
        "ReportAsSinkingFund": true,
        "IsBasisCalculationReminderChargeInterest": true,
        "IsPrepaymentHeating": true,
        "IsPrepaymentRunningCost": true,
        "IsGrossRentWithoutHeating": true
      },
      "Amount": 1,
      "NetAmount": 1,
      "Currency": {
        "Id": 1,
        "Code": "text"
      },
      "ValidFrom": "2025-02-05",
      "ValidTo": "2025-02-05",
      "VatRate": {
        "Id": 1,
        "Code": "text"
      },
      "Info": "text"
    }
  ],
  "Person": {
    "Id": 1,
    "IdNum": "text",
    "Shortname": "text",
    "Name": "text",
    "NodeId": 1,
    "TaxNumber": "text",
    "TaxIdentificationNumber": "text",
    "ValidFrom": "2025-02-05",
    "ValidTo": "2025-02-05",
    "IsNaturalPerson": true,
    "NaturalPerson": {
      "Title": "text",
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "BirthDate": "2025-02-05",
      "DeathDate": "2025-02-05T03:58:44.038Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      },
      "ContactPreference": {
        "Id": 1,
        "Name": "text"
      }
    },
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text",
      "VatId": "text",
      "CommercialRegisterNumber": "text",
      "CommercialRegisterTown": "text"
    },
    "Addresses": [
      {
        "Id": 1,
        "Zip": "text",
        "Town": "text",
        "Street": "text",
        "HouseNumber": "text",
        "HouseNumberAddition": "text",
        "ValidFrom": "2025-02-05",
        "ValidTo": "2025-02-05",
        "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-02-05",
        "ValidTo": "2025-02-05",
        "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"
      }
    }
  }
}

---

Neuen vorgeschlagenen Vertragsnehmer anlegen

Version 1.0

---

POST/openwowi/v1.0/SuggestedContractor/SuggestedContractor

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger (int32)

PersonIdinteger (int32)

TypeOfUserIdinteger (int32)

EstimatedColdRentnullable number (decimal)

EstimatedPrepaymentHeatingnullable number (decimal)

EstimatedRunningCostnullable number (decimal)

EstimatedTotalRentnullable number (decimal)

EstimatedContractSecuritynullable number (decimal)

EstimatedStartContractnullable string (date)

Example: "2025-02-05"

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

ContractSignedAtnullable string (date)

Example: "2025-02-05"

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

CommonSetEndOfContractnullable string (date)

Example: "2025-02-05"

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

Address1nullable string

Address2nullable string

Address3nullable string

Address4nullable string

Address5nullable string

Address6nullable string

Titlenullable string

FutureUpdateRecipientAddressboolean

TaxAgreementVatRateIdnullable integer (int32)

LifeOfAContractIdnullable integer (int32)

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/SuggestedContractor/SuggestedContractor', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "EstimatedStartContract": "2025-02-05",
      "ContractSignedAt": "2025-02-05",
      "CommonSetEndOfContract": "2025-02-05"
    }),
});
const data = await response.json();

Response

201400

{
  "Id": 1
}

---

Version 1.2

---

POST/openwowi/v1.2/SuggestedContractor/SuggestedContractor

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger (int32)

PersonIdinteger (int32)

TypeOfUserIdinteger (int32)

EstimatedColdRentnullable number (decimal)

EstimatedPrepaymentHeatingnullable number (decimal)

EstimatedRunningCostnullable number (decimal)

EstimatedTotalRentnullable number (decimal)

EstimatedContractSecuritynullable number (decimal)

EstimatedStartContractnullable string (date)

Example: "2025-02-05"

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

ContractSignedAtnullable string (date)

Example: "2025-02-05"

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

CommonSetEndOfContractnullable string (date)

Example: "2025-02-05"

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

Address1nullable string

Address2nullable string

Address3nullable string

Address4nullable string

Address5nullable string

Address6nullable string

Titlenullable string

FutureUpdateRecipientAddressboolean

TaxAgreementVatRateIdnullable integer (int32)

LifeOfAContractIdnullable integer (int32)

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/SuggestedContractor/SuggestedContractor', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "EstimatedStartContract": "2025-02-05",
      "ContractSignedAt": "2025-02-05",
      "CommonSetEndOfContract": "2025-02-05"
    }),
});
const data = await response.json();

Response

201400

{
  "Id": 1
}

---

Vorgeschlagenen Vertragsnehmer ändern

Version 1.0

---

PUT/openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger (int32)

PersonIdinteger (int32)

TypeOfUserIdinteger (int32)

EstimatedColdRentnullable number (decimal)

EstimatedPrepaymentHeatingnullable number (decimal)

EstimatedRunningCostnullable number (decimal)

EstimatedTotalRentnullable number (decimal)

EstimatedContractSecuritynullable number (decimal)

EstimatedStartContractnullable string (date)

Example: "2025-02-05"

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

ContractSignedAtnullable string (date)

Example: "2025-02-05"

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

CommonSetEndOfContractnullable string (date)

Example: "2025-02-05"

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

Address1nullable string

Address2nullable string

Address3nullable string

Address4nullable string

Address5nullable string

Address6nullable string

Titlenullable string

FutureUpdateRecipientAddressboolean

TaxAgreementVatRateIdnullable integer (int32)

LifeOfAContractIdnullable integer (int32)

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "EstimatedStartContract": "2025-02-05",
      "ContractSignedAt": "2025-02-05",
      "CommonSetEndOfContract": "2025-02-05"
    }),
});
const data = await response.json();

Response

200400

{
  "Id": 1
}

---

Version 1.2

---

PUT/openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger (int32)

PersonIdinteger (int32)

TypeOfUserIdinteger (int32)

EstimatedColdRentnullable number (decimal)

EstimatedPrepaymentHeatingnullable number (decimal)

EstimatedRunningCostnullable number (decimal)

EstimatedTotalRentnullable number (decimal)

EstimatedContractSecuritynullable number (decimal)

EstimatedStartContractnullable string (date)

Example: "2025-02-05"

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

ContractSignedAtnullable string (date)

Example: "2025-02-05"

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

CommonSetEndOfContractnullable string (date)

Example: "2025-02-05"

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

Address1nullable string

Address2nullable string

Address3nullable string

Address4nullable string

Address5nullable string

Address6nullable string

Titlenullable string

FutureUpdateRecipientAddressboolean

TaxAgreementVatRateIdnullable integer (int32)

LifeOfAContractIdnullable integer (int32)

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "EstimatedStartContract": "2025-02-05",
      "ContractSignedAt": "2025-02-05",
      "CommonSetEndOfContract": "2025-02-05"
    }),
});
const data = await response.json();

Response

200400

{
  "Id": 1
}

---

Vorgeschlagenen Vertragsnehmer löschen

Version 1.0

---

DELETE/openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1
}

---

Version 1.2

---

DELETE/openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1
}

---

Den Katalog für "TaxAgreementVatRateId" finden Sie im Katalog für "SalesTax" im Belegsystem.

Den Katalog für TypeOfUserId finden Sie im Katalog "ContractorType" in der Mietenbuchhaltung (die ID kann aus dem Katalog übernommen werden). Bitte beachten Sie, dass kundendefinierte Nutzerarten keine Rollen aufweisen müssen und deshalb ggf. nicht per API akzeptiert werden. Alle IDs über "1000" können aus diesem Grund nicht verlässlich für die Nutzerarten verwendet werden. Sollten Sie diese verwenden wollen, so muss der Kunde die "FIO-VE-Steuerung Nutzerart" im Katalog für den entsprechenden Eintrag hinterlegen. Sie erkennen diesen Eintrag im Katalog Endpunkt, durch Daten im Schlüssel "Classification".

Enumerationen für "LiveOfContractId"

Id	Type
1	Unlimited
2	Limited
3	Duration4Years
4	Duration5Years
5	Duration10Years
6	LimitedWithOption
7	Duration2Years
8	Duration3Years
9	Duration6Years
10	Duration7Years
11	Duration8Years
12	Duration9Years
13	Duration15Years