SmartCompare | Dokumentation Qernel API - Multirente - v0.1.0 (03.02.2025)

Changelog

v0.1.0

Grundlegende Änderungen an der Dokumentation des Result XMLs.

v0.0.9

Initiale Versionsnummer. Es hat noch keine Überprüfung der Dokumentation stattgefunden. Demnach können noch ungültige Datentypen wie "Any" oder __ANON__ auftauchen oder bestimmte Klassen werden nicht unterstützt.

Wenn eine grundlegende Prüfung der Dokumentation stattgefunden hat, kann die 0.0.9 entfernt und durch Version 1.0.0 ersetzt werden.

Requests

Qernel::Request::Multirente::Preis  

name type required xml node
Versicherteperson ArrayRef[Qernel::Entity::Multirente::Preis::Versicherteperson] yes <versicherteperson />
Versicherungsnehmer Qernel::Entity::Multirente::Preis::JVersicherungsnehmer Qernel::Entity::Multirente::Preis::NVersicherungsnehmer no <versicherungsnehmer />
Vertrag Qernel::Entity::Multirente::Preis::Contract yes <contract />

Qernel::Request::Multirente::Antrag  

name type required xml node
Bankverbindung Qernel::Entity::Multirente::Antrag::JBankverbindung Qernel::Entity::Multirente::Antrag::NBankverbindung no <bankverbindung />
Produkt Qernel::Entity::Multirente::Antrag::Product yes <product />
Versicherteperson ArrayRef[Qernel::Entity::Multirente::Antrag::Versicherteperson] yes <versicherteperson />
Versicherungsnehmer Qernel::Entity::Multirente::Antrag::JVersicherungsnehmer Qernel::Entity::Multirente::Antrag::NVersicherungsnehmer yes <versicherungsnehmer />
Vertrag Qernel::Entity::Multirente::Antrag::Contract yes <contract />

Entities

Qernel::Entity::Multirente::Preis::Versicherteperson  

name type required documentation
alter Int no Alter - automatisch generiert
anrede Anrede no Anrede
geburtsdatum Qernel::Entity::Date yes Geburtsdatum der Person
motorradfahrer Bool yes ist Motorradfahrer?
ort Str no Wohnort
personid Int yes eindeutige Ganzzahl-ID
plz Str no Postleitzahl
raucher Bool yes ist Raucher?
risikogruppe Int yes A, B, K

Qernel::Entity::Multirente::Preis::JVersicherungsnehmer  

name type required documentation
anrede AnredeJur yes Anrede
ort Str yes Wohnort
plz Str yes Postleitzahl

Qernel::Entity::Multirente::Preis::NVersicherungsnehmer  

name type required documentation
anrede Anrede no Anrede
geburtsdatum Qernel::Entity::Date no Geburtsdatum der Person
ort Str no Wohnort
plz Str no Postleitzahl
tarifgruppe Int no 0 - normal, 1 - oeffentlicher Dienst

Qernel::Entity::Multirente::Preis::Contract  

name type required documentation
antragsnummervm Str no Antragsnummer des Vermittlers
bankgruppe Bankgruppe no Typ der Bankengruppe
beginn Qernel::Entity::Date yes Vertragsbeginn
laufzeit Int no Laufzeit des Vertrags
leistungsdauer Int yes Dauer der Leistungen in Jahren
passivdynamik Int yes Passivdynamik
referenznummer_pdf Str no Nummer analog PDF Antrag (ticket)
rente_monatlich Int yes mtl. Rentenhoehe
zahlart Zahlart no Rechnung oder Lastschrift
zahlweise Zahlweise8 yes Zahlungsintervall

Qernel::Entity::Multirente::Antrag::JBankverbindung  

name type required documentation
anrede AnredeJur yes Anrede
bank Str no Bankname oder Bezeichnung der Bank
bic Str no BIC des Kontoinhabers
blz Int no Angabe Bankleitzahl
email Str no !nodoc!
firmenname Str yes !nodoc!
hausnummer Str yes !nodoc!
iban IBAN yes IBAN des Kontoinhabers
kontonummer Int no Angabe Kontonummer
mobil PhoneNumber no !nodoc!
ort Str yes !nodoc!
plz Int yes !nodoc!
strasse Str yes !nodoc!
telefax PhoneNumber no !nodoc!
telefon PhoneNumber no !nodoc!

Qernel::Entity::Multirente::Antrag::NBankverbindung  

name type required documentation
anrede Anrede yes Anrede
bank Str no Bankname oder Bezeichnung der Bank
beruf Str no !nodoc!
bic Str no BIC des Kontoinhabers
blz Int no Angabe Bankleitzahl
email Str no !nodoc!
familienstand Int no !nodoc!
geburtsdatum Qernel::Entity::Date yes Geburtsdatum Kontoinhaber
geschlecht Int no !nodoc!
hausnummer Str yes !nodoc!
iban IBAN yes IBAN des Kontoinhabers
kontonummer Int no Angabe Kontonummer
mobil PhoneNumber no !nodoc!
nachname Str yes !nodoc!
ort Str yes !nodoc!
plz Int yes !nodoc!
strasse Str yes !nodoc!
telefax PhoneNumber no !nodoc!
telefon PhoneNumber no !nodoc!
titel Str no !nodoc!
vorname Str yes !nodoc!

Qernel::Entity::Multirente::Antrag::Product  

name type required documentation
beitrag_gesamt_netto_request Str no !nodoc!
beitrag_gesamt_request Str no !nodoc!
berechnungsdatum Qernel::Entity::Date no !nodoc!
package Int yes !nodoc!

Qernel::Entity::Multirente::Antrag::Versicherteperson  

name type required documentation
alter Int no Alter - automatisch generiert
anrede Int no !nodoc!
beruf Str no !nodoc!
email Str no !nodoc!
familienstand Int no !nodoc!
geburtsdatum Qernel::Entity::Date yes Geburtsdatum der Person
geschlecht Int no !nodoc!
hausnummer Str no !nodoc!
mobil PhoneNumber no !nodoc!
motorradfahrer Bool yes ist Motorradfahrer?
nachname Str yes !nodoc!
ort Str no Wohnort
personid Int yes eindeutige Ganzzahl-ID
plz Str no Postleitzahl
raucher Bool yes ist Raucher?
risikogruppe Int yes A, B, K
strasse Str no !nodoc!
telefax PhoneNumber no !nodoc!
telefon PhoneNumber no !nodoc!
titel Str no !nodoc!
vorname Str yes !nodoc!

Qernel::Entity::Multirente::Antrag::JVersicherungsnehmer  

name type required documentation
anrede AnredeJur yes Anrede
email Str no !nodoc!
firmenname Str yes !nodoc!
hausnummer Str yes !nodoc!
mobil PhoneNumber no !nodoc!
ort Str yes Wohnort
plz Str yes Postleitzahl
strasse Str yes !nodoc!
telefax PhoneNumber no !nodoc!
telefon PhoneNumber no !nodoc!

Qernel::Entity::Multirente::Antrag::NVersicherungsnehmer  

name type required documentation
anrede Anrede no Anrede
beruf Str no !nodoc!
email Str no !nodoc!
familienstand Int no !nodoc!
geburtsdatum Qernel::Entity::Date no Geburtsdatum der Person
geschlecht Int no !nodoc!
hausnummer Str yes !nodoc!
mobil PhoneNumber no !nodoc!
nachname Str yes !nodoc!
ort Str no Wohnort
plz Str no Postleitzahl
strasse Str yes !nodoc!
tarifgruppe Int no 0 - normal, 1 - oeffentlicher Dienst
telefax PhoneNumber no !nodoc!
telefon PhoneNumber no !nodoc!
titel Str no !nodoc!
vorname Str yes !nodoc!

Qernel::Entity::Multirente::Antrag::Contract  

name type required documentation
antragsnummervm Str no Antragsnummer des Vermittlers
art Int no !nodoc!
bankgruppe Bankgruppe no Typ der Bankengruppe
beginn Qernel::Entity::Date yes Vertragsbeginn
laufzeit Int no Laufzeit des Vertrags
leistungsdauer Int yes Dauer der Leistungen in Jahren
passivdynamik Int yes Passivdynamik
referenznummer_pdf Str no Nummer analog PDF Antrag (ticket)
rente_monatlich Int yes mtl. Rentenhoehe
zahlart Zahlart no Rechnung oder Lastschrift
zahlweise Zahlweise8 yes Zahlungsintervall

Qernel::Entity::Result::Person  

name type xml node documentation
Option1 ResultPersonOption <option1 description="" key="" beitrag="">{{value}}</option1> Option 1
Option2 ResultPersonOption <option2 description="" key="" beitrag="">{{value}}</option2> Option 2
Option3 ResultPersonOption <option3 description="" key="" beitrag="">{{value}}</option3> Option 3
beitrag_gesamt Num <beitrag_gesamt /> !nodoc!
id Int <id /> fortlaufende eindeutige Nummer der Person
leistungsdauer Str|Undef <leistungsdauer /> Leistungsdauer
passivdynamik Str|Undef <passivdynamik /> Passivdynamik
produktname Str|Undef <produktname /> !nodoc!
vbeitrag_gesamt Num <vbeitrag_gesamt /> !nodoc!

Results

Qernel::Entity::Multirente::Result::Preis  

name type xml node documentation
Features ArrayRef[ResultFeature] <feature id="" category="" name="" value="" requested="" text="" akv="" zuschlag="" sb="" maximierung="" /> Leistungseinschlüsse
Options ArrayRef[ResultOption] <option description="" status="" key="" beitrag="">{{active}}</option> Zusatzbausteine
Person ArrayRef[Qernel::Entity::Result::Person] <person /> Personendaten der versicherten Personen
Status ResultStatus <status state="" generator="" cancelled="">{{msg}}</status> Status des Requests
ablauf Qernel::Entity::Date <ablauf /> Laufzeitende
antrag_bonitaetspruefung_obligatory Bool <antrag_bonitaetspruefung_obligatory /> Package hat Bonitaetspruefung?
antrag_memo_possible Bool <antrag_memo_possible /> Package hat Memofeld?
antrag_telefon_obligatory Bool <antrag_telefon_obligatory /> Telefonpflicht
antragsmodell_possible Bool <antragsmodell_possible /> Package kann Antragsmodell?
beginn Qernel::Entity::Date <beginn /> Vertragsbeginn
beitrag_12_brutto Num <beitrag_12_brutto /> !nodoc!
beitrag_1_brutto Num <beitrag_1_brutto /> !nodoc!
beitrag_2_brutto Num <beitrag_2_brutto /> !nodoc!
beitrag_4_brutto Num <beitrag_4_brutto /> !nodoc!
beitrag_gesamt_brutto Num <beitrag_gesamt_brutto /> !nodoc!
beitrag_gesamt_netto Num <beitrag_gesamt_netto /> !nodoc!
features Int <features /> Info wie Leistungsmerkmale geliefert werden
features_failed Int <features_failed /> Info wie viele Leistungsmerkmale nicht eingeschlossen sind
features_requested Int <features_requested /> Info wie viele Leistungsmerkmale ausgewaehlt wurden
features_value Int <features_value /> Info wie viele Leistungsmerkmale Werte liefern
gesellschaft Str <gesellschaft /> Name der Versicherungsgesellschaft
gesnr Str <gesnr /> Interne ID der Versicherungsgesellschaft
info_text Str <info_text /> Feld ist nicht mehr aktiv
invitatiomodell_possible Bool <invitatiomodell_possible /> Package kann Invitatiomodell?
leistungsdauer Str <leistungsdauer /> !nodoc!
module Str <module /> statisch: `multirente`
online_antrag Bool <online_antrag /> Dunkelverarbeitung moeglich?
package Int <package /> packageid
passivdynamik Str <passivdynamik /> !nodoc!
rente Int <rente /> !nodoc!
tarif Str <tarif /> Tarifbeschreibung
vbeitrag_12_brutto Num <vbeitrag_12_brutto /> !nodoc!
vbeitrag_1_brutto Num <vbeitrag_1_brutto /> !nodoc!
vbeitrag_2_brutto Num <vbeitrag_2_brutto /> !nodoc!
vbeitrag_4_brutto Num <vbeitrag_4_brutto /> !nodoc!
vergleich_gesamt_brutto Num <vergleich_gesamt_brutto /> !nodoc!
vergleich_gesamt_netto Num <vergleich_gesamt_netto /> !nodoc!
vermittlernummer Str <vermittlernummer /> ID des/der Vermittler/in
ws_version Str <ws_version /> !nodoc!
zahlart Int <zahlart /> !nodoc!
zahlweise Int <zahlweise /> !nodoc!

Qernel::Entity::Multirente::Result::Antrag  

name type xml node documentation
Features ArrayRef[ResultFeature] <feature id="" category="" name="" value="" requested="" text="" akv="" zuschlag="" sb="" maximierung="" /> Leistungseinschlüsse
Files ArrayRef[FileAttachment] <file description="" name="">{{base64_encoded_content}}</file> PDF Anhaenge wie z.B. Antrag.pdf, Base64 kodiert
Options ArrayRef[ResultOption] <option description="" status="" key="" beitrag="">{{active}}</option> Zusatzbausteine
Person ArrayRef[Qernel::Entity::Result::Person] <person /> Personendaten der versicherten Personen
Status ResultStatus <status state="" generator="" cancelled="">{{msg}}</status> Status des Requests
ablauf Qernel::Entity::Date <ablauf /> Laufzeitende
antrag_bonitaetspruefung_obligatory Bool <antrag_bonitaetspruefung_obligatory /> Package hat Bonitaetspruefung?
antrag_memo_possible Bool <antrag_memo_possible /> Package hat Memofeld?
antrag_telefon_obligatory Bool <antrag_telefon_obligatory /> Telefonpflicht
antragsmodell_possible Bool <antragsmodell_possible /> Package kann Antragsmodell?
antragsnummer Any <antragsnummer /> !nodoc!
antragsnummer_art Int <antragsnummer_art /> !nodoc!
beginn Qernel::Entity::Date <beginn /> Vertragsbeginn
beitrag_12_brutto Num <beitrag_12_brutto /> !nodoc!
beitrag_1_brutto Num <beitrag_1_brutto /> !nodoc!
beitrag_2_brutto Num <beitrag_2_brutto /> !nodoc!
beitrag_4_brutto Num <beitrag_4_brutto /> !nodoc!
beitrag_gesamt_brutto Num <beitrag_gesamt_brutto /> !nodoc!
beitrag_gesamt_netto Num <beitrag_gesamt_netto /> !nodoc!
beitrag_gesamt_netto_request Num <beitrag_gesamt_netto_request /> !nodoc!
beitrag_gesamt_request Num <beitrag_gesamt_request /> !nodoc!
features Int <features /> Info wie Leistungsmerkmale geliefert werden
features_failed Int <features_failed /> Info wie viele Leistungsmerkmale nicht eingeschlossen sind
features_requested Int <features_requested /> Info wie viele Leistungsmerkmale ausgewaehlt wurden
features_value Int <features_value /> Info wie viele Leistungsmerkmale Werte liefern
gesellschaft Str <gesellschaft /> Name der Versicherungsgesellschaft
gesnr Str <gesnr /> Interne ID der Versicherungsgesellschaft
info_text Str <info_text /> Feld ist nicht mehr aktiv
invitatiomodell_possible Bool <invitatiomodell_possible /> Package kann Invitatiomodell?
leistungsdauer Str <leistungsdauer /> !nodoc!
module Str <module /> statisch: `multirente`
online_antrag Bool <online_antrag /> Dunkelverarbeitung moeglich?
package Int <package /> packageid
passivdynamik Str <passivdynamik /> !nodoc!
referenznummer Str <referenznummer /> !nodoc!
rente Int <rente /> !nodoc!
tarif Str <tarif /> Tarifbeschreibung
uebertragung_art Int <uebertragung_art /> !nodoc!
uebertragung_email ArrayRef[Email] <uebertragung_email /> !nodoc!
uebertragung_hinweis Str <uebertragung_hinweis /> !nodoc!
vbeitrag_12_brutto Num <vbeitrag_12_brutto /> !nodoc!
vbeitrag_1_brutto Num <vbeitrag_1_brutto /> !nodoc!
vbeitrag_2_brutto Num <vbeitrag_2_brutto /> !nodoc!
vbeitrag_4_brutto Num <vbeitrag_4_brutto /> !nodoc!
vergleich_gesamt_brutto Num <vergleich_gesamt_brutto /> !nodoc!
vergleich_gesamt_netto Num <vergleich_gesamt_netto /> !nodoc!
vermittlernummer Str <vermittlernummer /> ID des/der Vermittler/in
ws_version Str <ws_version /> !nodoc!
zahlart Int <zahlart /> !nodoc!
zahlweise Int <zahlweise /> !nodoc!