Berekening aanmaken
1. Profiel opbouwen
V1
VoordeelPakketten worden berekend aan de hand van een voordeelpakketberekening:Profiel. Het voordeelpakketberekening:Profiel fungeert als verzamelobject waarin de onderliggende sub-profielen kunnen worden toegevoegd. Indien we bijvoorbeeld een autoverzekering willen afsluiten, stellen we een voordeelpakketberekening:Profiel samen waarvan we het attribuut PersonenautoProfielen vullen met een aangevuld voordeelpakketberekening:PersonenautoProfiel.
Wanneer een consument meerdere producten af wil nemen kan hetzelfde voordeelpakketberekening:Profiel dan ook gebruikt worden om meerdere producten in samen te stellen. Denk hierbij aan bijvoorbeeld een voordeelpakketberekening:PersonenautoProfiel in combinatie met een voordeelpakketberekening:RechtsbijstandProfiel.
> Profiel > PersonenautoProfiel > AanhangwagenProfiel > AansprakelijkheidProfiel > BestelautoProfiel > BromfietsProfiel > CaravanProfiel > DoorlopendeReisProfiel > FietsProfiel > GezinsongevallenProfiel > InboedelProfiel > KampeerautoProfiel > MotorfietsProfiel > RechtsbijstandProfiel > WoonhuisProfiel
V2
VoordeelPakketten worden berekend aan de hand van een product:Profiel. Het product:Profiel fungeert als verzamelobject waarin de onderliggende sub-profielen kunnen worden toegevoegd. Indien we bijvoorbeeld een autoverzekering willen afsluiten, stellen we een product:Profiel samen waarvan we het attribuut PersonenautoProfielen vullen met een aangevuld product:PersonenautoProfiel.
Wanneer een consument meerdere producten af wil nemen kan hetzelfde product:Profiel dan ook gebruikt worden om meerdere producten in samen te stellen. Denk hierbij aan bijvoorbeeld een product:PersonenautoProfiel in combinatie met een product:RechtsbijstandProfiel.
> Profiel > PersonenautoProfiel > AanhangwagenProfiel > AansprakelijkheidProfiel > BestelautoProfiel > BromfietsProfiel > CaravanProfiel > DoorlopendeReisProfiel > FietsProfiel > GezinsongevallenProfiel > InboedelProfiel > KampeerautoProfiel > MotorfietsProfiel > RechtsbijstandProfiel > RecreatiewoningProfiel > WoonhuisProfiel
Tip: Scroll de tabel opzij om alle profielen in te zien
Tip: Het attribuut
Betalingstermijnaccepteert nu de waardesMaand,Kwartaal,HalfJaarenJaar.
Let op: Wanneer er sprake is van een zakelijk
marktsegmentmogen er enkel personenauto's en bestelauto's worden afgesloten; de API valideert de inhoud van de sub-profielen t.o.v. het opgegevenmarktsegment.
Let op: Het attribuut
PercentageCommercieleKortingmag enkel toegekend worden door Voogd & Voogd; dit attribuut is dan ook niet bedoeld voor externe doeleinden.
Ingangsdatum valideren
Elk sub-profiel moet een ingangsdatum bevatten. Deze datum dient binnen een bepaalde range te vallen, deze range kan opgehaald worden via het datumvalidatie:/periode/ingangsdatum endpoint.
/perioden/ingangsdatum
Meerdere profielen
Sommige attributen in het datamodel kunnen gevuld worden met meerdere profielen, zie bijvoorbeeld PersonenautoProfielen. Wanneer hier gebruik van wordt gemaakt is het verplicht om voor ieder onderliggend product:PersonenautoProfiel een uniek Id mee te geven. Dit Id kan later worden gebruikt om de profielen van elkaar te onderscheiden.
Filtering toepassen voor het getoonde resultaat
Sommige subprofielen geven de mogelijkheid om dekkingen te filteren met minimumwaardes. Zo heeft het product:PersonenautoProfiel bijvoorbeeld het attribuut GewensteDekkingsvorm waarmee een
minimale dekkingsvorm kan worden opgegeven.
Voorbeeld:
Een consument wenst de dekkingsvorm WA voor zijn personenauto. De API wordt gevraagd om een lijst met dekkingen te retourneren waarbij de GewensteDekkingsvorm (lees: minimale dekkingsvorm) de waarde WA bevat.
Vervolgens geeft de API alle tarieven die aan de minimale eisen voldoen terug als resultaat. Hierdoor kan het voorkomen dat een WA beperkt cascodekking of een WA volledig cascodekking in het resultaat terugkomt, als de premie voor deze cascodekkingen lager is dan de premie van een tarief met een WA dekking. Wat in het voordeel is van de klant omdat er een ruimere dekking mogelijk is tegen een lagere premie.
Tip: Als het wenselijk is om alleen tarieven met een WA dekking in het resultaat te tonen, bij het selecteren van de
GewensteDekkingsvorm(lees: minimale dekkingsvorm) WA, dan kan dit worden beïnvloed door naastGewensteDekkingsvormeenMaximaalEigenRisicomet de waarde 0 mee te geven in het profiel. Daardoor voldoet de (goedkopere) beperkt of volledig cascodekking niet meer aan de filteropties, omdat op deze cascodekkingen een (hoger) eigen risico van toepassing is. Met als gevolg dat alleen de tarieven met een WA dekking in het resultaat worden getoond.
2. Berekening aanmaken
V1
Na het opbouwen van het product:Profiel kan de product:/berekeningen API aangesproken worden om een VoordeelPakket berekening aan te maken.
/berekeningen
V2
Na het opbouwen van het product:Profiel kan de product:/berekeningen API aangesproken worden om een VoordeelPakket berekening aan te maken.
/berekeningen
Subadministratie
Wanneer uw organisatie gebruikmaakt van subadminstraties kan de berekening direct aangemaakt worden onder een subadministratie op basis van het administratienummer.
/administraties/{administratienummer}/berekeningen
/administraties/{administratienummer}/berekeningen
3. Aanvullende dekkingen selecteren
Naast de basisverzekeringen kunnen er ook aanvullende dekkingen worden afgenomen door de consument; dit dient opgevoerd te worden in de product:Berekening middels een PUT request, zie ook 4. Berekening wijzigen. Onderstaand een lijst met de aanvullende dekkingen per product.
Op basis van de aanvullende dekkingen kunnen de aangeboden premies variëren. Het kan dan ook interessant zijn voor de consument om eerst de aanvullende dekkingen te selecteren alvorens de tariefopties worden getoond.
4. Berekening wijzigen
V1
Een bestaande berekening kan nog aangepast worden met behulp van een PUT request. Hierbij wordt de aangepaste berekening in zijn geheel geretourneerd, soortgelijk als bij het aanmaken van een berekening via product:/berekeningen.
/berekeningen/{berekeningid}/profiel
V2
Een bestaande berekening kan nog aangepast worden met behulp van een PUT request. Hierbij wordt de aangepaste berekening in zijn geheel geretourneerd, soortgelijk als bij het aanmaken van een berekening via product:/berekeningen.
/berekeningen/{berekeningid}/profiel
Let op: Bij wijzigingen dient het complete model meegegeven te worden.
Aanvullende endpoints
Berekening ophalen
/berekeningen/{berekeningid}
/berekeningen/{berekeningid}
Profiel ophalen
/berekeningen/{berekeningid}/profiel
/berekeningen/{berekeningid}/profiel