Skip to content

VermittlerWebservice - Vertragsverwaltung

Funktionen

Name HTTP Eingabe Ausgabe
addVertrag POST ${pfad}/{$vmt}/kunden/{Kunde-Id}/vertraege JSON Vertrag JSON Vertrag
getVertraege GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege JSON ArrayOf Vertrag
getVertrag GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id} JSON Vertrag
setVertrag PUT ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id} JSON PartOf Vertrag JSON PartOf Vertrag
uebertrageVertrag POST ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/uebertragen
getVertragsdokumente GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/dokumente JSON ArrayOf Archiveintrag
searchVertraege GET ${pfad}/{$vmt}/vertraege/_suche JSON Vertragssuche JSON ArrayOf Vertrag
addVertragskuendigung POST ${pfad}/{$vmt}/kunden/{Kunde-Id}/vertraege/${Vertrag-Id}/kuendigung JSON PartOf Kuendigung JSON PartOf Kuendigung
setVertragVorversicherung PUT ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/vorversicherung JSON PartOf Vorversicherung JSON PartOf Vorversicherung
getVertragVorversicherung GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/vorversicherung JSON PartOf Vorversicherung
getVertragVorschäden GET ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/vorschaeden JSON ArrayOf Vorschäden
addVertragVorschäden POST ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/vorschaeden JSON Vorschäden JSON PartOf Vorschäden

Detaildaten

VermittlerWebservice - Vertragsverwaltung - Detaildaten

addVertrag

Legt einen Vertrag an.

Beispiele

Request (formatiert)
POST ${path}/${vmt}/kunden/${Kunde-Id}/vertraege HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 278
Connection: close

{
    "Status": "F",
    "Gesellschaft": "10330",
    "Sparte": "050",
    "Beitrag": {
        "Brutto": 100,
        "Zahlweise": "5"
    },
    "Laufzeit": {
        "Beginn": "2010-01-01",
        "Ablauf": "2016-12-31"
    },
    "Risiko": "",
    "Versicherungsscheinnummer": "123-546",
    "Adresse": "0",
    "Bankkonto": {
        "IBAN": "",
        "BIC": "",
        "Inhaber": {
            "Abweichend": false
        }
    }

}
Response (formatiert)
HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Connection: close

{
    "Uri": "https:\/\/maklerinfo.dio\/service\/bd\/broker\/1.0\/rest\/999999\/kunden\/1\/vertraege\/1475",
    "Id": "1475",
    "Vermittler": "999999",
    "Sparte": "050",
    "Gesellschaft": "10330",
    "Versicherungsscheinnummer": "123-546",
    "Beitrag": {
        "Zahlweise": "5",
        "Netto": 84.0336134454,
        "Brutto": 100,
        "Steuer": 19
    },
    "Risiko": null,
    "Status": "F",
    "Laufzeit": {
        "Beginn": "2010-01-01",
        "Ablauf": "2016-12-31"
    },
    "Adresse": "0",
    "Bankkonto": {
        "IBAN": null,
        "BIC": null,
        "Bankname": null,
        "Inhaber": {
            "Abweichend": false,
            "Vorname": null,
            "Nachname": null,
            "Geburtsdatum": null,
            "Strasse": null,
            "Postleitzahl": null,
            "Ort": null,
            "Land": null
        }
    }
}

setVertrag

Bearbeitung eines bestehenden Vertrages.

Beispiele

Request (formatiert)
PUT ${path}/${vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id} HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 212
Connection: close

{
    "Status": "F",
    "Gesellschaft": "12345",
    "Sparte": "123",
    "Beitrag": {
        "Brutto": "123.45",
        "Zahlweise": "4"
    },
    "Laufzeit": {
        "Beginn": "2011-02-22",
        "Ablauf": "2025-01-09"
    },
    "Risiko": "",
    "Versicherungsscheinnummer": "VSN1234567890"
}
Response (formatiert)
HTTP/1.1 200 OK
Connection: close
Content-Type: application/json

{
    "Uri": "https://maklerinfo.biz/service/bd/broker/1.0/rest/123456/kunden/123/vertraege/1234567",
    "Id": "1234567",
    "Vermittler": "999999",
    "Sparte": "123",
    "Gesellschaft": "12345",
    "Versicherungsscheinnummer": "VSN1234567890",
    "Beitrag": {
        "Zahlweise": "4",
        "Netto": 123.45,
        "Brutto": 103.74,
        "Steuer": 19
    },
    "Risiko": null,
    "Status": "F",
    "Laufzeit": {
        "Beginn": "2011-02-22",
        "Ablauf": "2025-01-09"
    }
}

getVertraege

Gibt die Verträge eines Kunden zurück.

uebertrageVertrag

☛ Der Vertragsstatus muss F oder X sein
☛ Mit dem Vertrag muss ein Dokument mit Tag Maklervollmacht verknüpft sein

getVertragsDokumente

Gibt alle dem Kunden und Vertrag zugeordnete, nicht ausgeblendete Archiveinträge vom Typ "dokument" und vorhandener Datei zurück.

addVertragskuendigung

Legt eine Küendigung zum Vertrag an.

Beispiele

Request (formatiert)
POST ${pfad}/{$vmt}/kunden/{Kunde-Id}/vertraege/${Vertrag-Id}/kuendigung HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 278
Connection: close

{
      "Typ": "naechstmoeglich",
      "Termin":"2020-12-31"
}
Response (formatiert)
HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Connection: close

{
       "Id": "EB8DC7F5E713E604CC89"
}

setVertragVorversicherung

Bearbeitung der Vertrags Vorversicherung.

Beispiele

Request (formatiert)
PUT ${pfad}/{$vmt}/kunden/${Kunde-Id}/vertraege/${Vertrag-Id}/vorversicherung HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 212
Connection: close

{
     "Policennummer": "2164651679835",
     "Gesellschaft": "Tester",
     "Beginn": "2019-05-01", 
     "Ablauf": "2020-05-25",
     "Status": "ges"
}
Response (formatiert)
HTTP/1.1 200 OK
Connection: close
Content-Type: application/json

{
     "Uri": "https:\/\/maklerinfo.dio\/service\/bd\/broker\/1.0\/rest\/999999\/kunden\/1\/vertraege\/176/vorversicherung",
     "Id": "176",
     "Vermittler": "999999",
     "Policennummer": "2164651679835",
     "Gesellschaft": "Tester",
     "Beginn": "2019-05-01",
     "Ablauf": "2020-05-25", 
     "Status":"Gek\u00fcndigt durch Gesellschaft"
}

getVertragVorversicherung

Gibt die Vorversicherung des Vertrages zurück.

getVertragVorschäden

Gibt die Vorschäden des Vertrages zurück.

addVertragVorschäden

Legt einen Vorschaden zum Vertrag an.

Beispiele

Request (formatiert)
POST ${pfad}/{$vmt}/kunden/{Kunde-Id}/vertraege/${Vertrag-Id}/vorschaeden HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 66
Connection: close

{
        "Schadenshoehe":"2,99",
        "Datum":1580079600,
        "Text":"zeh gestossen"
}
Response (formatiert)
HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Connection: close

{
       "Id": "0bd49669"
}

Datentypen

Vertrag

Name Datentyp Beschreibung
Uri Uri
Id string
Vermittler string Vermittlernummer
Sparte EnumValue getSparten
Gesellschaft EnumValue getGesellschaften
Versicherungsscheinnummer string
Beitrag Beitrag
Risiko string
Status EnumValue getVertragsstatus
Laufzeit Laufzeit
Adresse string Id der Adresse
Bankkonto Bankkonto

Beitrag

Name Datentyp Beschreibung
Zahlweise EnumValue getZahlweisen
Netto double
Brutto double
Steuer double

Laufzeit

Name Datentyp Beschreibung
Beginn Date
Ablauf Date

Bankkonto

Name Datentyp Beschreibung
IBAN string
BIC string
Bankname string
Inhaber KontoInhaber

KontoInhaber

Name Datentyp Beschreibung
Abweichend boolean Ist der Kontoinhaber abweichend zum Versicherungsnehmer des Vertrages
Vorname string
Nachname string
Geburtsdatum Date
Strasse string
Postleitzahl string
Ort string
Land EnumValue getLaender

Vertragssuche

Erbt von Suche.
Mindestens ein Filterkriterium muss gegeben sein.

Name Datentyp Beschreibung
Vermittler Enumarationfilter (Unter-) Vermittlernummern
Sparte Enumarationfilter getSparten
Status Enumarationfilter getVertragsstatus
Gesellschaft Enumarationfilter getGesellschaften
Versicherungsscheinnummer Volltextfilter

Kuendigung

Name Datentyp Beschreibung
Id string
Typ EnumValue getVertragskuendigungsGruende
Termin Date

Vorversicherung

Name Datentyp Beschreibung
Uri Uri
Id string
Vermittler Enumarationfilter (Unter-) Vermittlernummern
Policennummer string
Gesellschaft Enumarationfilter getGesellschaften
Beginn Date
Ablauf Date
Status EnumValue getVorversicherungStatus

Vorschäden

Name Datentyp Beschreibung
Id string
Text string
Datum Date
Schadenshoehe double