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

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

useUnitIdinteger · int32Optional

licenseAgreementIdinteger · int32Optional

personIdinteger · int32Optional

includeMainCommunicationbooleanOptionalDefault: false

includePersonAddressesbooleanOptionalDefault: false

includePersonCommunicationsbooleanOptionalDefault: false

includePersonBankAccountsbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

HasLicenseAgreementHandledbooleanOptional

HasContractPositionHandledbooleanOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/SuggestedContractor/SuggestedContractor

HTTPcURLJavaScriptPython

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

[
  {
    "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": "2026-04-03",
      "EndOfContract": "2026-04-03"
    },
    "ContractorType": {
      "Id": 1,
      "Name": "text",
      "Classification": "text"
    },
    "EstimatedContractData": {
      "EstimatedColdRent": 1,
      "EstimatedPrepaymentHeating": 1,
      "EstimatedRunningCost": 1,
      "EstimatedTotalRent": 1,
      "EstimatedContractSecurity": 1,
      "EstimatedStartContract": "2026-04-03",
      "ContractSignedAt": "2026-04-03",
      "CommonSetEndOfContract": "2026-04-03",
      "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": "2026-04-03",
        "ValidTo": "2026-04-03",
        "VatRate": {
          "Id": 1,
          "Code": "text"
        },
        "Info": "text"
      }
    ],
    "Person": {
      "Id": 1,
      "IdNum": "text",
      "Shortname": "text",
      "Name": "text",
      "NodeId": 1,
      "TaxNumber": "text",
      "TaxIdentificationNumber": "text",
      "ValidFrom": "2026-04-03",
      "ValidTo": "2026-04-03",
      "IsNaturalPerson": true,
      "NaturalPerson": {
        "Title": "text",
        "FirstName": "text",
        "LastName": "text",
        "BirthName": "text",
        "CareOf": "text",
        "BirthDate": "2026-04-03",
        "DeathDate": "2026-04-03T13:17:52.049Z",
        "Gender": {
          "Id": 1,
          "Name": "text"
        },
        "MaritalType": {
          "Id": 1,
          "Name": "text"
        },
        "Nationality": {
          "Id": 1,
          "Name": "text",
          "Code": "text"
        },
        "PersonInCare": {
          "Id": 1,
          "IdNum": "text"
        },
        "ContactFor": [
          {
            "Id": 1,
            "IdNum": "text",
            "LongName1": "text",
            "LongName2": "text"
          }
        ]
      },
      "LegalPerson": {
        "LongName1": "text",
        "LongName2": "text",
        "VatId": "text",
        "CommercialRegisterNumber": "text",
        "CommercialRegisterTown": "text",
        "ContractPersons": [
          {
            "Id": 1,
            "IdNum": "text",
            "FirstName": "text",
            "LastName": "text"
          }
        ]
      },
      "Addresses": [
        {
          "Id": 1,
          "Zip": "text",
          "Town": "text",
          "Street": "text",
          "HouseNumber": "text",
          "HouseNumberAddition": "text",
          "ValidFrom": "2026-04-03",
          "ValidTo": "2026-04-03",
          "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,
          "Iban": "text",
          "Bic": "text",
          "AccountHolder": "text",
          "ValidFrom": "2026-04-03",
          "ValidTo": "2026-04-03",
          "BankAccountType": {
            "Id": 1,
            "Code": "text"
          },
          "BankAccountId": 1,
          "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

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

idinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

HasLicenseAgreementHandledbooleanOptional

HasContractPositionHandledbooleanOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

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

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": 1,
  "Person": {
    "Id": 1,
    "IdNum": "text",
    "Name": "text",
    "ShortName": "text",
    "ValidFrom": "2026-04-03",
    "ValidTo": "2026-04-03",
    "IsNaturalPerson": true,
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text"
    },
    "NaturalPerson": {
      "Title": "text",
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "BirthDate": "2026-04-03",
      "DeathDate": "2026-04-03T13:17:52.049Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      },
      "PersonInCare": {
        "Id": 1,
        "IdNum": "text"
      },
      "ContactFor": [
        {
          "Id": 1,
          "IdNum": "text",
          "LongName1": "text",
          "LongName2": "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": "2026-04-03",
    "EndOfContract": "2026-04-03"
  },
  "ContractorType": {
    "Id": 1,
    "Name": "text",
    "Classification": "text"
  },
  "EstimatedContractData": {
    "EstimatedColdRent": 1,
    "EstimatedPrepaymentHeating": 1,
    "EstimatedRunningCost": 1,
    "EstimatedTotalRent": 1,
    "EstimatedContractSecurity": 1,
    "EstimatedStartContract": "2026-04-03",
    "ContractSignedAt": "2026-04-03",
    "CommonSetEndOfContract": "2026-04-03",
    "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": "2026-04-03",
      "ValidTo": "2026-04-03",
      "VatRate": {
        "Id": 1,
        "Code": "text"
      },
      "Info": "text"
    }
  ]
}

---

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

idinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

includeMainCommunicationbooleanOptionalDefault: false

includePersonAddressesbooleanOptionalDefault: false

includePersonCommunicationsbooleanOptionalDefault: false

includePersonBankAccountsbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

HasLicenseAgreementHandledbooleanOptional

HasContractPositionHandledbooleanOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

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

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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": "2026-04-03",
    "EndOfContract": "2026-04-03"
  },
  "ContractorType": {
    "Id": 1,
    "Name": "text",
    "Classification": "text"
  },
  "EstimatedContractData": {
    "EstimatedColdRent": 1,
    "EstimatedPrepaymentHeating": 1,
    "EstimatedRunningCost": 1,
    "EstimatedTotalRent": 1,
    "EstimatedContractSecurity": 1,
    "EstimatedStartContract": "2026-04-03",
    "ContractSignedAt": "2026-04-03",
    "CommonSetEndOfContract": "2026-04-03",
    "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": "2026-04-03",
      "ValidTo": "2026-04-03",
      "VatRate": {
        "Id": 1,
        "Code": "text"
      },
      "Info": "text"
    }
  ],
  "Person": {
    "Id": 1,
    "IdNum": "text",
    "Shortname": "text",
    "Name": "text",
    "NodeId": 1,
    "TaxNumber": "text",
    "TaxIdentificationNumber": "text",
    "ValidFrom": "2026-04-03",
    "ValidTo": "2026-04-03",
    "IsNaturalPerson": true,
    "NaturalPerson": {
      "Title": "text",
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "BirthDate": "2026-04-03",
      "DeathDate": "2026-04-03T13:17:52.049Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      },
      "PersonInCare": {
        "Id": 1,
        "IdNum": "text"
      },
      "ContactFor": [
        {
          "Id": 1,
          "IdNum": "text",
          "LongName1": "text",
          "LongName2": "text"
        }
      ]
    },
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text",
      "VatId": "text",
      "CommercialRegisterNumber": "text",
      "CommercialRegisterTown": "text",
      "ContractPersons": [
        {
          "Id": 1,
          "IdNum": "text",
          "FirstName": "text",
          "LastName": "text"
        }
      ]
    },
    "Addresses": [
      {
        "Id": 1,
        "Zip": "text",
        "Town": "text",
        "Street": "text",
        "HouseNumber": "text",
        "HouseNumberAddition": "text",
        "ValidFrom": "2026-04-03",
        "ValidTo": "2026-04-03",
        "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,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text",
        "ValidFrom": "2026-04-03",
        "ValidTo": "2026-04-03",
        "BankAccountType": {
          "Id": 1,
          "Code": "text"
        },
        "BankAccountId": 1,
        "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

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger · int32Optional

PersonIdinteger · int32Optional

TypeOfUserIdinteger · int32Optional

EstimatedColdRentnumber · decimal · nullableOptional

EstimatedPrepaymentHeatingnumber · decimal · nullableOptional

EstimatedRunningCostnumber · decimal · nullableOptional

EstimatedTotalRentnumber · decimal · nullableOptional

EstimatedContractSecuritynumber · decimal · nullableOptional

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

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

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

Address1string · nullableOptional

Address2string · nullableOptional

Address3string · nullableOptional

Address4string · nullableOptional

Address5string · nullableOptional

Address6string · nullableOptional

Titlestring · nullableOptional

FutureUpdateRecipientAddressbooleanOptional

TaxAgreementVatRateIdinteger · int32 · nullableOptional

LifeOfAContractIdinteger · int32 · nullableOptional

Antworten

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.0/SuggestedContractor/SuggestedContractor

HTTPcURLJavaScriptPython

POST /openwowi/v1.0/SuggestedContractor/SuggestedContractor HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 500

{
  "LicenseAgreementId": 1,
  "PersonId": 1,
  "TypeOfUserId": 1,
  "EstimatedColdRent": 1,
  "EstimatedPrepaymentHeating": 1,
  "EstimatedRunningCost": 1,
  "EstimatedTotalRent": 1,
  "EstimatedContractSecurity": 1,
  "EstimatedStartContract": "2026-04-03",
  "ContractSignedAt": "2026-04-03",
  "CommonSetEndOfContract": "2026-04-03",
  "Address1": "text",
  "Address2": "text",
  "Address3": "text",
  "Address4": "text",
  "Address5": "text",
  "Address6": "text",
  "Title": "text",
  "FutureUpdateRecipientAddress": true,
  "TaxAgreementVatRateId": 1,
  "LifeOfAContractId": 1
}

application/jsontext/jsonapplication/*+json

{
  "Id": 1
}

---

Version 1.2

---

post

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger · int32Optional

PersonIdinteger · int32Optional

TypeOfUserIdinteger · int32Optional

EstimatedColdRentnumber · decimal · nullableOptional

EstimatedPrepaymentHeatingnumber · decimal · nullableOptional

EstimatedRunningCostnumber · decimal · nullableOptional

EstimatedTotalRentnumber · decimal · nullableOptional

EstimatedContractSecuritynumber · decimal · nullableOptional

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

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

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

Address1string · nullableOptional

Address2string · nullableOptional

Address3string · nullableOptional

Address4string · nullableOptional

Address5string · nullableOptional

Address6string · nullableOptional

Titlestring · nullableOptional

FutureUpdateRecipientAddressbooleanOptional

TaxAgreementVatRateIdinteger · int32 · nullableOptional

LifeOfAContractIdinteger · int32 · nullableOptional

Antworten

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.2/SuggestedContractor/SuggestedContractor

HTTPcURLJavaScriptPython

POST /openwowi/v1.2/SuggestedContractor/SuggestedContractor HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 500

{
  "LicenseAgreementId": 1,
  "PersonId": 1,
  "TypeOfUserId": 1,
  "EstimatedColdRent": 1,
  "EstimatedPrepaymentHeating": 1,
  "EstimatedRunningCost": 1,
  "EstimatedTotalRent": 1,
  "EstimatedContractSecurity": 1,
  "EstimatedStartContract": "2026-04-03",
  "ContractSignedAt": "2026-04-03",
  "CommonSetEndOfContract": "2026-04-03",
  "Address1": "text",
  "Address2": "text",
  "Address3": "text",
  "Address4": "text",
  "Address5": "text",
  "Address6": "text",
  "Title": "text",
  "FutureUpdateRecipientAddress": true,
  "TaxAgreementVatRateId": 1,
  "LifeOfAContractId": 1
}

application/jsontext/jsonapplication/*+json

{
  "Id": 1
}

---

Vorgeschlagenen Vertragsnehmer ändern

Version 1.0

---

put

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

idinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger · int32Optional

PersonIdinteger · int32Optional

TypeOfUserIdinteger · int32Optional

EstimatedColdRentnumber · decimal · nullableOptional

EstimatedPrepaymentHeatingnumber · decimal · nullableOptional

EstimatedRunningCostnumber · decimal · nullableOptional

EstimatedTotalRentnumber · decimal · nullableOptional

EstimatedContractSecuritynumber · decimal · nullableOptional

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

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

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

Address1string · nullableOptional

Address2string · nullableOptional

Address3string · nullableOptional

Address4string · nullableOptional

Address5string · nullableOptional

Address6string · nullableOptional

Titlestring · nullableOptional

FutureUpdateRecipientAddressbooleanOptional

TaxAgreementVatRateIdinteger · int32 · nullableOptional

LifeOfAContractIdinteger · int32 · nullableOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

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

HTTPcURLJavaScriptPython

PUT /openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 500

{
  "LicenseAgreementId": 1,
  "PersonId": 1,
  "TypeOfUserId": 1,
  "EstimatedColdRent": 1,
  "EstimatedPrepaymentHeating": 1,
  "EstimatedRunningCost": 1,
  "EstimatedTotalRent": 1,
  "EstimatedContractSecurity": 1,
  "EstimatedStartContract": "2026-04-03",
  "ContractSignedAt": "2026-04-03",
  "CommonSetEndOfContract": "2026-04-03",
  "Address1": "text",
  "Address2": "text",
  "Address3": "text",
  "Address4": "text",
  "Address5": "text",
  "Address6": "text",
  "Title": "text",
  "FutureUpdateRecipientAddress": true,
  "TaxAgreementVatRateId": 1,
  "LifeOfAContractId": 1
}

application/jsontext/jsonapplication/*+json

{
  "Id": 1
}

---

Version 1.2

---

put

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

idinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

LicenseAgreementIdinteger · int32Optional

PersonIdinteger · int32Optional

TypeOfUserIdinteger · int32Optional

EstimatedColdRentnumber · decimal · nullableOptional

EstimatedPrepaymentHeatingnumber · decimal · nullableOptional

EstimatedRunningCostnumber · decimal · nullableOptional

EstimatedTotalRentnumber · decimal · nullableOptional

EstimatedContractSecuritynumber · decimal · nullableOptional

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

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

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

Address1string · nullableOptional

Address2string · nullableOptional

Address3string · nullableOptional

Address4string · nullableOptional

Address5string · nullableOptional

Address6string · nullableOptional

Titlestring · nullableOptional

FutureUpdateRecipientAddressbooleanOptional

TaxAgreementVatRateIdinteger · int32 · nullableOptional

LifeOfAContractIdinteger · int32 · nullableOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

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

HTTPcURLJavaScriptPython

PUT /openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 500

{
  "LicenseAgreementId": 1,
  "PersonId": 1,
  "TypeOfUserId": 1,
  "EstimatedColdRent": 1,
  "EstimatedPrepaymentHeating": 1,
  "EstimatedRunningCost": 1,
  "EstimatedTotalRent": 1,
  "EstimatedContractSecurity": 1,
  "EstimatedStartContract": "2026-04-03",
  "ContractSignedAt": "2026-04-03",
  "CommonSetEndOfContract": "2026-04-03",
  "Address1": "text",
  "Address2": "text",
  "Address3": "text",
  "Address4": "text",
  "Address5": "text",
  "Address6": "text",
  "Title": "text",
  "FutureUpdateRecipientAddress": true,
  "TaxAgreementVatRateId": 1,
  "LifeOfAContractId": 1
}

application/jsontext/jsonapplication/*+json

{
  "Id": 1
}

---

Vorgeschlagenen Vertragsnehmer löschen

Version 1.0

---

delete

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

idinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

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

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.0/SuggestedContractor/SuggestedContractor/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": 1
}

---

Version 1.2

---

delete

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

idinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

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

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.2/SuggestedContractor/SuggestedContractor/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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