CreateInsuranceProducts
Inputs (Array of InsuranceProduct) inherits from EntityBase
| Name | Type | Description | Mandatory | Available from version | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BrickId | Guid | Not used as an input. | 2.02 | ||||||||||||||||
| InsuranceProductSupplierId | Guid | The BrickId of the supplier of the insurance product, this is a Legal Entity that can be fetched using GetPersons. | 2.02 | ||||||||||||||||
| ResellerId | Guid | The BrickId of the re-seller for the insurance product, this is a Legal Entity that can be fetched using GetPersons. | 2.02 | ||||||||||||||||
| BrokerId | Guid | The BrickId of the broker for the insurance product, this is a Legal Entity that can be fetched using GetPersons. | 2.02 | ||||||||||||||||
| AdministratorId | Guid | The BrickId of the appointed administrator for the insurance product, this is a Legal Entity that can be fetched using GetPersons. | 2.02 | ||||||||||||||||
| AccountManagerId | Guid | The BrickId of the appointed Account manager for the insurance product, this is a Legal Entity that can be fetched using GetPersons. | 2.02 | ||||||||||||||||
| ClaimsAdjusterId | Guid | The BrickId of the appointed Claims adjuster for the insurance product, this is a Legal Entity that can be fetched using GetPersons. | 2.02 | ||||||||||||||||
| InsuranceProductTypeKey | string | Key for the type connected to insurance product. Documentation from the Knowledgebase can be viewed here /wiki/spaces/KB/pages/103055710 | True | 2.02 | |||||||||||||||
| InsuranceCategoryKey | string | Key for the category connected to insurance product, this can be either "Individual" or "Group" | 2.02 | ||||||||||||||||
| Key | string | Used to uniquely identify this product. | True | 2.02 | |||||||||||||||
| Name | string | Display name for product. | True | 2.02 | |||||||||||||||
| DescriptionString | string | Description of the insurance product. | 2.02 | ||||||||||||||||
| ProductCode | string | Product code for the insurance product. | 2.02 | ||||||||||||||||
| StatusKey | string | Status for the insurance product. The available statuses are as follows:
| 2.02 | ||||||||||||||||
| Country | string | Two letter country code (ISO 3166-1) | 2.02 | ||||||||||||||||
| RuleOf12 | decimal | 2.02 | |||||||||||||||||
| RuleOf45 | decimal | 2.02 | |||||||||||||||||
| RuleOf78 | decimal | 2.02 | |||||||||||||||||
| CurrencyCode | string | Three digit currency code (ISO 4217) | 2.02 | ||||||||||||||||
| InsuranceCommission | decimal | The percentage value offered in commission for resellers. 10% is entered like 0.1. | 2.02 | ||||||||||||||||
| Retention | decimal | The retention percentage. 10% is entered like 0.1. | 2.02 | ||||||||||||||||
| ProfitShare | double | Profit share for the insurance product. 10% is entered like 0.1. | 2.02 | ||||||||||||||||
| TermsNo | string | Term number for insurance product. The number that the terms and conditions document has (often ”Year+X). | 2.02 | ||||||||||||||||
| TermsUrl | string | URL to terms for insurance product. | 2.02 | ||||||||||||||||
| ProductVersion | string | Product version of the insurance product. | 2.02 | ||||||||||||||||
| StartDate | DateTime | Start date for the insurance product. | 2.02 | ||||||||||||||||
| EndDate | DateTime | End date for the insurance product. | 2.02 | ||||||||||||||||
| MaxTerm | string | The max term of the underlying loan e.g. a consumer loan with max 144 months. | 2.02 | ||||||||||||||||
| InsurableInterest | string | The interest amount in a given month expressed in currency value. | 2.02 | ||||||||||||||||
| GrossPrice | decimal | The price that the consumer pays. | 2.02 | ||||||||||||||||
| PremiumBasedOn | string | The variable that the price of the insurance is calculated on e.g. % of monthly installment or % of the outstanding balance etc. | 2.02 | ||||||||||||||||
| NetPrice | decimal | GrossPrice – Commission | 2.02 | ||||||||||||||||
| ChargeInterval | integer | The payment interval | 2.02 | ||||||||||||||||
| SaleMethod | string | Also called Point of Sale (POS) and is e.g. DM, TM, inbound, shop etc. | 2.02 | ||||||||||||||||
| ExternalReference | string | A string value that can identify the insurance product for an external system. | 2.02 | ||||||||||||||||
| Parameters | string | This is a string with custom parameters separated by semicolons. For example if a car insurance policy is created and the brand of the car should be stored and the production year the contents of this property could be "brand: Ford;year: 2016". | 2.02 | ||||||||||||||||
| Comment | string | 2.02 | |||||||||||||||||
| DealTypeKey | string | This value should be either "Direct" or "ThirdPart" | 2.02 | ||||||||||||||||
| PeriodOfNotice | int | Period of notice for the insurance product. Periods until termination. | 2.02 | ||||||||||||||||
| RAFApprovedDate | DateTime | 2.02 | |||||||||||||||||
| InsuranceTax | decimal | Percentage value for tax. 10% should be written like 0.10. | 2.02 |
Response rows
| Name | Type | Description | Available from version |
|---|---|---|---|
| EntitiesArray | Array | All insurance products are returned along with each insurance product's BrickId and array of Errors per insurance product | |
Code examples
Blog stream
Create a blog post to share news and announcements with your team and company.
, multiple selections available, Use left or right arrow keys to navigate selected items
Terms of License
Change Policy
© 2009 - 2024 Huddlestock Technologies AB All rights reserved