FamilyUnit
objectFamily Unit details
Status of the family eg:Single,Parent,single parent
Family group Number
List of Members under Family Unit
Show Child Parameters
Incentive
objectIncentives applied, if any. Incentives need to be applied as applicable to the agent/broker ID that exists in Aviva. Currently there’s no API exposed externally to provide the list of incentives associated with your agent/broker ID so you should have received the applicable deals from Aviva Business Teams.
Incentive ID.
Incentive parameter value such as 1, 2, Yes, No.
Incentive type such as NCD Uplift, monthsFree.
Allowed values:Price BeaterNCD UpliftgiftmonthsFreefreeOptionSwitchDecpsDiscount
Sub key for Incentive if any. Not used for New Business.
Member
objectThis is actual member number if calling system is GMS and some sequence number in case of other consumers.
Relation of the member to the primary member e.g self,partner,child.
Allowed values:selfpartnerchild
Member’s effective date in the policy. Format e.g YYYY-MM-DD
Gender of the member. values M/F
Allowed values:MF
Member’s date of birth. Format e.g YYYY-MM-DD. Can be left blank if age is supplied as either age or dateOfBirth is required.
Member’s postcode
Wellness Discount (if any) for member
Member underwriting type. For Virgin Business - FMU/NMORI. For Swicth Business - CMORI/CME/MHD.
Allowed values:FMUNMORICMECMORIMHD
Gross premium for member
Net premium for member
Insurance Premium Tax for member
Age of member. Can be left blank if dateOfBirth is supplied as either age or dateOfBirth is required.
Member’s premium breakdown
Show Child Parameters
No Claim Discount level for Member. If NCD Uplift incentive is applied then you must send the uplifted NCD to us. See below rules for calculating the NCD. * Virgin Business = 12, * Switch Business = Less than 1 year claims free = 8, 1 year claims free = 9, 2 years claims free = 10, 3 years claims free = 10, 4 years claims free = 11, 5 years claims free or never claimed = 12
Protected No Claim discount indicator.
Allowed values:YN
Any previous wellness discount for member.
Previous No Claim Discount level for Member.
Previous protected No Claim discount indicator.
Allowed values:YN
Previous net premium for member.
Previous capping and colarring for Member.
Current capping and colarring for Member.
Member Tenure.
Inception date for Member. Format e.g YYYY-MM-DD
Indicates if member is needed or not in the policy.
Postcode Code band for MTCs, this gets calculated automatically by API for New Business based on postcode supplied for members.
Indicates if Postcode band needs to be calculated by API or not. Applies only to MTC & Renewals.
Number of claims free years for Member.
MemberCategory
objectCategory of Members.
Member Category ID
Name of Member Category.
List of benefit options to be included in policy.
Show Child Parameters
Family Unit details
Show Child Parameters
MemberTaxDetail
objectMember’s premium breakdown
Member’s net premium
Member’s tax amount
Member’s tax rate