Skip to content

MitarbeiterWebservice - Vertragsverwaltung

Funktionen

Name HTTP Eingabe Ausgabe
addVertrag POST ${pfad}/{$ma}/vertraege JSON Vertrag JSON Vertrag
getVertraege GET ${pfad}/{$ma}/vertraege JSON ArrayOf Vertrag
getVertrag GET ${pfad}/{$ma}/vertraege/${Vertrag-Id} JSON Vertrag
getVertragBestandsuebertragungDetails GET ${pfad}/{$ma}/vertraege/${Vertrag-Id}/bestandsuebertragung JSON ArrayOf BestandsuebertragungDetails
getVertragsdokumente GET ${pfad}/{$ma}/vertraege/${Vertrag-Id}/dokumente JSON ArrayOf Archiveintrag
getVertragStatusAnzahl GET ${pfad}/{$ma}/vertragstatus-counts/?gesellschaftIds=${Gesellschaft-IDs} JSON ArrayOf VertragStatusAnzahl
getVertragMahnungen GET ${pfad}/{$ma}/vertraege/${Vertrag-Id}/mahnungen JSON ArrayOf VertragMahnung
handleServeOrder POST ${pfad}/{$ma}/vertraege/${Vertrag-Id}/serviciereAntrag JSON Meldungen

Detaildaten

☛ MitarbeiterWebservice - Vertragsverwaltung - Detaildaten

addVertrag

Legt einen Vertrag an.

Beispiele

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

{
    "Status": "F",
    "Gesellschaft": "10330",
    "Kunde": "123456",
    "Sparte": "050",
    "Beitrag": {
        "Brutto": 100,
        "Zahlweise": "5"
    },
    "Laufzeit": {
        "Beginn": "2010-01-01",
        "Ablauf": "2016-12-31"
    },
    "Risiko": "",
    "Antragsnummer": "",
    "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:\/\/www.maklerinfo.biz\/service\/bd\/employee\/1.0\/rest\/123456_123456\/vertraege\/1475",
    "Id": "1475",
    "PublicID": "3b1584f5187fca7",
    "Vermittler": "123456",
    "Kunde": "123456",
    "Sparte": "050",
    "Gesellschaft": "10330",
    "Versicherungsscheinnummer": "123-546",
    "Beitrag": {
        "Zahlweise": "5",
        "Netto": 84.0336134454,
        "Brutto": 100,
        "Steuer": 19
    },
    "Risiko": null,
    "Antragsnummer": 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
        }
    }
}

getVertraege

Gibt die Verträge eines Kunden zurück.

getVertragBestandsuebertragungDetails

Gibt die informationen einer Bestandsübertragung eines Vertrages zurück.

getVertragMahnungen

Gibt die Vertrag Mahnungen eines Kunden zurück.

Beispiele

Request (formatiert)
GET ${path}/${ma}/vertraege/${vertrag-id}/mahnungen HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 278
Connection: close
Response (formatiert)
HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Connection: close

[
    {
      "Datum": "2016-01-12"
    },
    {
      "Datum": "2016-02-23"
    },
    [...]
]

getVertragsDokumente

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

getVertragStatusAnzahl

Gibt alle VertragStatus zurück und die Anzahl der Verträge in abhängigkeit der gesellschaften

Eingabeparameter:

Name Typ Beschreibung
Gesellschaft-IDs string | array mind. eine ID muss angegeben werden
( Bsp: gesellschaftIds=00000,11111 oder gesellschaftIds[0]=00000&gesellschaftIds[1]=11111

Beispiel

Request GET
GET ${path}/${ma}/vertragstatus-counts/?gesellschaftIds[1]=10002&gesellschaftIds[2]=00000 HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Connection: close
Response
GET ${path}/${ma}/vertragstatus-counts/?gesellschaftIds[1]=10002&gesellschaftIds[2]=00000 HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Connection: close

[    
    {
        "Status": "B",
        "Text": "B - beantragt",
        "Anzahl": 6,
        "Aktiv": false,
        "Beantragt": true,
        "Storniert": false
    },
    {
        "Status": "A",
        "Text": "A - aktiv",
        "Anzahl": 2,
        "Aktiv": true,
        "Beantragt": false,
        "Storniert": false
    },
    [...]
]

handleServeOrder

serviciert Verträge mit dem Status "E".

Eingabeparameter:

Name Typ Beschreibung
Versand boolean Wenn der Wert nicht true ist, wird ein neuer Eintrag im Antragspilot angelegt.

Beispiel

Request POST
POST ${pfad}/{$ma}/vertraege/${Vertrag-Id}/serviciereAntrag HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 22
Connection: close

{
    "Versand":  false
}
Response
HTTP/1.1 200 OK
Content-Length: 42
Content-Type: application/json

{
    "Meldungen":"Der Antrag wurde angelegt."
}

Datentypen

Vertrag

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

Beitrag

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

Laufzeit

Name Datentyp Beschreibung
Beginn Date
Ablauf Date

BestandsuebertragungDetails

Name Datentyp Beschreibung
Veranlasst Date
Bestaetigt Date
Erinnert 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

VertragMahnung

Name Datentyp Beschreibung
Datum Date

VertragStatusAnzahl

Name Datentyp Beschreibung
Status string Vertragsstatus
Text string
Anzahl integer
Aktiv boolean
Beantragt boolean
Storniert boolean